Cisco Cisco Configuration Engine 3.5 Entwickleranleitung
5-23
Cisco Configuration Engine Software Development Kit API Reference and Programmer Guide 3.5
OL-17661-02
Chapter 5 Web Services: Admin, Config, Image, Exec, NSM
Depreciated Image Web Service
Parameters:
JobDTO job—Defines parameters of the job to be submitted including: start time, batch size, job type,
description, and type (distribution and activation, or evaluation). If the start time is later (on the server)
than when this method is invoked, the job will be queued and will trigger at that specified time.
Otherwise, the job executes immediately.
description, and type (distribution and activation, or evaluation). If the start time is later (on the server)
than when this method is invoked, the job will be queued and will trigger at that specified time.
Otherwise, the job executes immediately.
Returns:
SubmitStatus—Object describing the status of the job request. A submit can have multiple return
outcomes, so this assembler handles those different cases.
outcomes, so this assembler handles those different cases.
For example, if any device in this job is already active in another job, the submit fails and a list of the
imageId:jobId pairs will be returned as ImageIdJobId[].
imageId:jobId pairs will be returned as ImageIdJobId[].
If all devices are not involved in any prior submitted job, the submit is successful and a unique identifier
of this submitted job (jobId) for this submitted job as well as the resulting list of any images slated for
distribution and activation for each device specified will be returned. The jobId can then be used to
query the status of a job (simple or detailed status), stop, cancel, or restart the job.
of this submitted job (jobId) for this submitted job as well as the resulting list of any images slated for
distribution and activation for each device specified will be returned. The jobId can then be used to
query the status of a job (simple or detailed status), stop, cancel, or restart the job.
Exception Handling:
CISException if job is null, batch size is < 1, no devices are specified or all groups contain no devices,
or any other system error.
or any other system error.
evaluateJob
Usage:
SubmitStatus evaluateJob(JobDTO job)
Description:
Submits a job to the server only for evaluation purposes, not for actual execution of the job.
The server evaluates the distributions associated with each device and reports in each case:
•
Whether the device is reachable.
•
If each distribution is required (i.e. device could already be running the desired image or the file is
already present at the destination location).
already present at the destination location).
•
If there is sufficient space for the image file at the intended destination location.
If the device has an associated activation, the server also evaluates whether the activation of an image is
required (i.e. is the device already running the desired image). This is useful to run an image update
scenario and see what resulting actions the server would take, but without actually executing those
actions.
required (i.e. is the device already running the desired image). This is useful to run an image update
scenario and see what resulting actions the server would take, but without actually executing those
actions.
Parameters:
JobDTO job—Defines parameters of the evaluation to be submitted, such as start time, batch size, job
type, and description.
type, and description.
Returns:
SubmitStatus—Object describing the status of the job request (see submitJob() for more detail).
Includes a list of which images are being evaluated for distribution and activation for each device, but
only if all of the devices are not already members of another prior submitted job.
Includes a list of which images are being evaluated for distribution and activation for each device, but
only if all of the devices are not already members of another prior submitted job.