Cisco Cisco Configuration Engine 3.5 Entwickleranleitung

Seite von 344
5-7
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
Web Services Model
Common Semantics
The two main operational services are the ConfigService and ImageService. They share a common 
semantic for job management:
Other methods are specific to the service and are documented in the provided Javadoc.
Security
Security is provided by means of Authentication and Privacy. HTTP Basic Authentication/SSL is the 
scheme used. For Web Service clients, this will require the use of a Web Services/SOAP toolkit that 
supports SSL. In the case of a Java client, this can be done natively using JDK 1.4 or greater.
Authentication The credentials of the Cisco Configuration Engine User (created by means of the 
AdminService) – username and password – are required for each operation. They are passed from client 
to server by utilizing HTTP Basic Authentication (i.e. the username and password are base-64 encoded 
into the HTTP header, just as in an HTML form).
For an example of how to embed the credentials (encoded in base-64) in the HTTP headers using client 
code generated from the Apach AXIS toolkit, see 
.
Privacy is provided by SSL and can be enabled during setup on the Cisco Configuration Engine. Only 
client-side SSL is provided. This means any client can freely obtain an SSL connection to the Config 
Engine. After the SSL handshake & certificate exchange/acceptance, the communication between the 
client and server is thus encrypted.
For information on client truststore usage and the “core” cryptographic services defined in the Java 2 
SDK, v 1.4, see 
.
Task
Operation Name
Example
Submitting jobs
update<type>
updateDevice()
updateDeviceWithConfig()
updateDeviceWithTempl()
Job lifecycle management
stopJob
restartJob
cancelJob
deleteJob
stopJob()
restartJob()
cancelJob()
deleteJob()
Listing jobs
listJob<type>
listJob()
listJobByDevice()
listJobWithStatus()
Querying job status
get<jobType>Status
get<jobType>DetailStatus
getConfigStatus()
getInventoryStatus()
getImageDetailStatus()
getDeleteFileDetailStatus()