Cisco Cisco Security Manager 4.5 Guia De Especificação

Página de 217
 
 
 
  
 
Cisco Security Manager 4.4 API Specification (Version 1.1) 
 
OL- 29074-01 
Page  146
 
CSM Utility Service API  
The utility service provides general utilities for access to functions on the network devices. The Utility Service 
API’s always fetch the device configuration data directly from the device. The Configuration Service API (defined 
in section 3) on the other hand always fetches the data from the CSM database. 
Faster responses and better efficiency is obtained using the Configuration Service API rather than the Utility Service 
API. This is because the Utility Service API communicates with the device during a method request and there is an 
additional communication overhead between the CSM application and the network device. This may additionally 
entail an increased load on the network device. 
It is thus recommended to use the Utility Service API under the following circumstances: 
 
If the corresponding configuration data is not supported by the Configuration ServiceAPI 
 
If the corresponding configuration data is administratively not managed in CSM. By default all applicable 
policies are managed in CSM (see the  Policy Management CSM Administration screen) 
 
If out-of-band changes are made on the end device (in such cases CSM might not have the updated 
configuration in its database) 
5.1 Object Model 
The following objects are defined in the utility service 
DeviceReadOnlyCLICmds 
o Identifies a device and a CLI command to be executed against that device 
DeviceCmdResults 
o Identifies a set of device command results 
DeviceCmdResult 
o Identifies a single device and the command results 
 
 
Figure 94: Result XML Schema   
 
5.2 Methods 
The utility service defines the following methods: 
1.  GetServiceInfo 
 
<xs:simpleType
 name
="
Result
">
 
 
 
<xs:restriction
 base
="
xs:token
">
 
 
 
 
<xs:enumeration
 value
="
ok
"/>
 
 
 
 
<xs:enumeration
 value
="
timeout
"/>
 
 
 
 
<xs:enumeration
 value
="
failed
"/>
 
 
 
</xs:restriction>
 
 
</xs:simpleType>