Cisco Cisco Configuration Engine 3.5 Entwickleranleitung
5-22
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
Operational Methods
Use Operation Methods to:
•
Obtain device inventory requests.
•
Trigger distribution and activation.
•
Evaluate jobs.
•
Query status of jobs.
getImageInventoryReport
Usage:
CnsMessage[] getImageInventoryReport(String[] imageIds)
Description:
Retrieves running image, hardware, and file system information from the specified device(s). You can
use this information to make decisions on what distribution or activation scenarios to perform.
use this information to make decisions on what distribution or activation scenarios to perform.
Parameters:
imageIds—an array of image IDs that identify the target devices to query.
Returns:
CnsMessage—A tree structure of value-objects with information on each device’s running image,
hardware resources, and file systems and contents.
hardware resources, and file systems and contents.
Exception Handling:
CISException—if imageIds is null, or any array element is invalid (i.e. null, empty string, or white space
only), or if there is a server error processing the request.
only), or if there is a server error processing the request.
submitJob
Usage:
SubmitStatus submitJob(JobDTO job)
Description:
Creates an image update Job for a specified list of devices and groups of devices. Devices, when created,
have associated distributions of one or more images and the activation of an image present on the device:
this job is the enactment of these. The JobDTO job parameter specifies:
have associated distributions of one or more images and the activation of an image present on the device:
this job is the enactment of these. The JobDTO job parameter specifies:
•
Time this job is scheduled to begin.
•
Batch size (number of devices to concurrently execute).
•
Optional text description of the job.
•
Whether to enact the distribution(s) and activation, or simply evaluate them.