getJobStatus

Request

<getJobStatus>  
   <ID/>
</getJobStatus>

Reply

<getJobStatus> 
   <job>
      <ID/>
      <jobType/>
      <srcPath/>
      <state/>
      <pctComplete/>
      <time/>
      <comment/>
      <retryCount/>
      <skippedFileCount/>
      <totalFiles/>
   </job>
   <result value=" ">
      <description/>
   </result>
</getJobStatus>

Elements

ID

Specifies the ID of each job to return the status of.

jobType

Specifies the type of job (see Job Types).

state

Specifies the state of the job (see State Values).

time

Specifies the UTC time of the job.

comment

Specifies that the job is paused (only if the state is ReplayingEFL).

retryCount

Specifies the number of EFL epochs that have been replayed so far. Volume Manager keeps replaying indefinitely. If this number reaches a determined point, the administrator should prevent any further changes.

skippedFileCount

Specifies the number of files that were skipped (only if the state is Completed or FilesSkipped).

totalFiles

Specifies the running count while the job is in the Scanning state (which shows the scan is making progress). This element is used if state is not Completed or Failed. Once the job is out of the Scanning state, this element shows the total number of data sets that need to be moved until the job completes or fails.

result

Specifies an error value or 0 (for no error).

description

Specifies a text description of the result.

Remarks

getJobStatus returns the following:

<nssReply>
   <volMn>
      <getJobStatus>
         <job>
            <id>1234</id>
            <jobType>MOVE</jobType>
            <srcPath>SYS:\</srcPath>
            <state>Running</state>
            <pctComplete>45</pctComplete>
            <time>12452542346</time>
            <comment>Cool</comment>
            <retryCount>1</retryCount>
            <skippedFileCount>0</skippedFileCount>
            <totalFiles>6894</totalFiles>
         </job>
      </getJobStatus>
   </volMn>
</nssReply>