getJobInfo

Retrieves ArkManager's job control-related information (such as activate, deactivate, start or stop a job).

Request

<jobControl>
   <getJobInfo/>
</jobControl>

Reply

<jobControl>
   <getJobInfo>
      <job>
         <name/>
         <state>
            <running/>
            <scheduled/>
            <stopped/>
         </state>
         <lastStartDate/>
         <nextStartDate/>
         <scheduledInterval/>
            <dayOfWeek>
               <days>
                  <monday/>
                  <tuesday/>
                  <wednesday/>
                  <thursday/>
                  <friday/>
                  <saturday/>
                  <sunday/>
               </days>
               <time>
            </dayOfWeek>
            <interval>
               <unit>
                  <seconds/>
                  <minutes/>
                  <hours/>
                  <days/>
               </unit>
               <value/>
            </interval>
         </scheduledInterval>
         <srcServer/>
         <srcVol/>
      </job>
      <result value=" ">
         <description/>
      </result> 
   </getJobInfo>
</jobControl>

Elements

job: (Required) Specifies the job. Repeat for each defined job.
name: (Required) Specifies the name of the job.
state: (Required) Specifies the job state from the last time it ran. Either running, scheduled, or stopped must be specified.
running: (Optional) Specifies that the job state is running.
scheduled: (Optional) Specifies that the job is scheduled to run in the future.
stopped: (Optional) Specifies that the job stopped.
lastStartDate: (Required) Specifies the generalized time, in YYYYMMDDHHMMSS format, of the last time that the job ran. If this date is unknown, zeroes are passed back (00000000000000).
nextStartDate: (Required) Specifies the generalized time, in YYYYMMDDHHMMSS format, of the next start time that the job runs. If this date is unknown, zeroes are passed back (00000000000000).
scheduledInterval: (Required) Specifies either the dayOfWeek element or the interval element.
dayOfWeek: (Optional) Specifies the day of the week and time of day that the job is scheduled to run.
days: (Optional) Specifies the days of the week.
monday: (Optional) Specifies that the job is scheduled to run on Monday.
tuesday: (Optional) Specifies that the job is scheduled to run on Tuesday.
wednesday: (Optional) Specifies that the job is scheduled to run on Wednesday.
thursday: (Optional) Specifies that the job is scheduled to run on Thursday.
friday: (Optional) Specifies that the job is scheduled to run on Friday.
saturday: (Optional) Specifies that the job is scheduled to run on Saturday.
sunday: (Optional) Specifies that the job is scheduled to run on Sunday.
time: (Optional) Specifies the time, in HHMMSS format, of the next scheduled time that the job runs.
interval: (Optional) Specifies the unit interval when the job runs.
unit: (Optional) Specifies the unit in seconds, minutes, hours, and days. If interval is defined, unit contains one of these elements.
seconds: (Optional) Specifies the seconds of the unit interval.
minutes: (Optional) Specifies the minutes of the unit interval.
hours: (Optional) Specifies the hours of the unit interval.
days: (Optional) Specifies the days of the unit interval.
value: (Optional) Specifies a number.
srcServer: (Required) Specifies the source server that the job is backing up.
srcVol: (Required) Specifies the source volume that the job is backing up.
result: Specifies an error value or zero (for no error).
description: Specifies a text description of the returned result.