- Cisco Wide Area Application Services API
- TOC
- Preface
- Introduction to the Cisco WAAS Central Manager Monitoring API
- Device Configuration Service
- Traffic Acceleration Service
- Events and Status Service
- AppNav Statistics Service
- CIFS Statistics Service
- SMB Statistics Service
- ICA Statistics Service
- HTTP and HTTPS Statistics Services
- MAPI Statistics Service
- NFS Statistics Service
- SSL Statistics Service
- Video Streaming Statistics Service
- Web Service Objects
- Index
Cisco Wide Area Application Services API Reference (Software Version 5.2.1)
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- April 30, 2013
Chapter: Device Configuration Service
Device Configuration Service
This chapter describes the Device Configuration service, which returns device statistics for WAEs and Central Managers.
The Device Configuration service (DeviceConf Web Service) performs one or more of the following actions:
- getAPIVersion
- getCM
- getCMByName
- getDevice
- getDeviceByName
- getDeviceGroups
- getDevices
- getDevicesInGroup
- getDevicesInGroupByName
- getDevicesPerLocation
- getLocations
- getWAE
- getWAEByName
- getWAEs
- getWAEsInGroup
- getWAEsInGroupByName
- getWAEsPerLocation
- getAPIVersion
Service URL: https:// <host/ip> :8443/ws/ DeviceConf
WSDL URL: https://<host/ip>:8443/ws/DeviceConf?wsdl
To obtain a description of all the operations and parameters for the DeviceConf service, submit a URL to the service with the suffix ?wsdl as follows:
To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:
Next, send a SOAP request written in an XML format to retrieve the information. The request calls for a particular action (such as getWanInfo) and contains the WS-Security header (username and password) and the input parameter content when required.
The following example shows an XML-formatted SOAP request to perform the getAPIVersion action. There are no input parameters for this particular action. The next example shows the XML response that contains the output values for this action, such as the hostname, IP address, location, MAC address, and so forth.
Example Request
Example Response
getAPIVersion
Retrieves the version of the Central Manager.
Input Parameter
Return
The output parameter String returns a String value for the software version of the Central Manager.
Exceptions
|
|
|
|
getCM
Retrieves information about the specified Central Manager.
Input Parameter
The keyword id requires a long value that contains the device name.
Return
The output parameter Device returns a Device value that provides device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
getCMByName
Retrieves information about the specified Central Manager.
Input Parameter
The keyword name requires a string value that contains the device name.
Return
The output parameter Device returns a Device value that provides device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
DeviceConfService.getCMByName: ERROR:Device does not exist.id= |
||
getDevice
Retrieves information about the specified Device.
Input Parameter
The keyword id requires a long value that contains the device name.
Return
The output parameter Device returns a Device value that includes device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
DeviceConfService.getDevice: |
||
getDevice:The SOAP Body does not have all the required elements |
getDeviceByName
Retrieves information about the specified device.
Input Parameter
The keyword name requires a string value that contains the device name.
Return
The output parameter Device returns a Device value that provides device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
DeviceConfService.getDeviceByName: ERROR:Device does not exist.id= |
||
getDeviceByName:The SOAP Body does not have all the required elements |
getDeviceGroups
Retrieves all of the device groups currently defined in the Central Manager.
Input Parameter
Return
The output parameter DeviceGroup[] returns a DeviceGroup value that provides a list of device groups that includes the group name, group type, and description.
Exceptions
|
|
|
|
getDeviceGroups:The SOAP Body doesn’t have all the required elements |
getDevices
Retrieves a list of specified devices.
Input Parameter
The keyword ids requires a long value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices and includes information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
getDevices:The SOAP Body doesn’t have all the required elements |
getDevicesInGroup
Retrieves all of the devices that belong to the specified device group.
Input Parameter
The keyword deviceGroupId requires a long value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices belonging to the specified device group.
Exceptions
|
|
|
|
DeviceConfService.getDevicesInGroup: ERROR:Device Group Id does not exist.DeviceGroupId= |
||
getDevicesInGroup:The SOAP Body doesn’t have all the required elements |
getDevicesInGroupByName
Retrieves all of the devices that belong to the specified device group by name.
Input Parameter
The keyword name requires a string value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices belonging to the specified device group.
Exceptions
|
|
|
|
DeviceConfService.getDevicesInGroupByName: ERROR: Group Name does not exist.DeviceGroupName= |
||
getDevicesInGroupByName:The SOAP Body does not have all the required elements |
getDevicesPerLocation
Retrieves all of the device names with a location ID.
Input Parameter
The keyword id requires a long value that contains the location ID.
Return
The output parameter String[] returns a String value that provides a list of device names.
Exceptions
getLocations
Retrieves all of the locations configured on the system.
Input Parameter
Return
The output parameter Location[] returns a Location value that provides a list of locations belonging to the specified device group.
Exceptions
getWANInfo
Retrieves the current Central Manager and WAE information that is available on the requested Central Manager.
Input Parameter
Return
The output paramater Device[] returns a Device value that provides a list of device tuples, including the device name, status, and device type.
Exceptions
|
|
|
|
getWanInfo:The SOAP Body doesn’t have all the required elements |
getWAE
Retrieves information about the specified WAE.
Input Parameter
The keyword id requires a long value that contains the device name.
Return
The output parameter Device returns a Device value that includes device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
getWAEByName
Retrieves information about the specified WAE.
Input Parameter
The keyword name requires a string value that contains the device name.
Return
The output parameter Device returns a Device value that provides device information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
DeviceConfService.getWAEByName: ERROR:Device does not exist.id= |
||
getWAEByName:The SOAP Body doesn’t have all the required elements |
getWAEs
Retrieves a list of specified devices.
Input Parameter
The keyword ids requires a long value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices and includes information such as the device name, IP address, status, device type, software version, model, and full DNS name.
Exceptions
|
|
|
|
getWAEs:The SOAP Body doesn’t have all the required elements |
getWAEsInGroup
Retrieves all of the devices that belong to the specified device group.
Input Parameter
The keyword deviceGroupId requires a long value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices belonging to the specified device group.
Exceptions
|
|
|
|
DeviceConfService.getWAEsInGroup: ERROR:Device Group Id does not exist.DeviceGroupId= |
||
getWAEsInGroup:The SOAP Body doesn’t have all the required elements |
getWAEsInGroupByName
Retrieves all of the devices that belong to the specified device group by name.
Input Parameter
The keyword name requires a string value that contains the device name.
Return
The output parameter Device[] returns a Device value that provides a list of devices belonging to the specified device group.
Exceptions
|
|
|
|
DeviceConfService.getWAEsInGroupByName: ERROR: Group Name does not exist.DeviceGroupName= |
||
getWAEsInGroupByName:The SOAP Body doesn’t have all the required elements |
getWAEsPerLocation
Retrieves all of the device names with a location ID.
Input Parameter
The keyword id requires a long value that contains the location ID.
Return
The output parameter String[] returns a String value that provides a list of device names.
Exceptions
Feedback