- 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
Events and Status Service
This chapter describes the Events and Status service, which returns alarm information, device status, and disk status.
For details about specific alarms, refer to the Alarm Book file that is available on the Cisco WAAS Software Download website.
Events and Status Service Syntax
This section contains the following topics:
- Events and Status Informational URLs
- Events and Status Example Request
- Events and Status Example Response
Events and Status Informational URLs
This section provides informational URLs for the Events and Status service.
- Service URL— https://<host/ip>:8443/ws/AlarmStatus
- WSDL URL— https://<host/ip>:8443/ws/AlarmStatus?wsdl
- Service URL— https://<host/ip>:8443/ws/DeviceStatus
- WSDL URL— https://<host/ip>:8443/ws/DeviceStatus?wsdl
- To obtain a description of all the operations and parameters for the AlarmStatus or the DeviceStatus Web Service, submit a URL to the service with the suffix ?wsdl as follows:
https://<host/ip>:8443/ws/AlarmStatus?wsdl
https://<host/ip>:8443/ws/DeviceStatus?wsdl
- To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:
https://<host/ip>:8443/ws/AlarmStatus
https://<host/ip>:8443/ws/DeviceStatus
Next, submit a SOAP request written in an XML format to retrieve the information.
Events and Status Example Request
The following example shows an XML-formatted SOAP request to perform the retrieveAllAlarms action. There are no input parameters for this particular action. For more information on this action, see retrieveAllAlarms
Events and Status Example Response
The following example shows the XML response that contains the output values for the retrieveAllAlarms action. For more information on this action, see retrieveAllAlarms.
Events and Status Service Actions
The Events and Status service (AlarmStatus Web Service) performs one or more of the following actions:
getDeviceStatus
Input Parameters
The keyword name requires a string that describes the name of the device.
Return
The output parameter DeviceStatus[] returns a DeviceStatus value that provides the status of the device.
Exceptions
|
|
|
|
DeviceStatusService.getDeviceStatus: ERROR:Device does not exist.DeviceName= |
||
getDeviceStatus:The SOAP Body doesn’t have all the required elements |
getDiskStatus
Retrieves the physical disk status.
Input Parameters
The keyword name requires a string that describes the name of the device.
Return
The output parameter DiskStatus[] returns a DiskStatus value that provides the status of the disk.
Exceptions
|
|
|
|
DeviceStatusService.getDiskStatus: ERROR:Device does not exist.DeviceName= |
||
getDiskeStatus:The SOAP Body doesn’t have all the required elements |
getDiskInformation
Retrieves information about the disk.
Input Parameters
The keyword name requires a string that describes the name of the device.
Return
The output parameter DiskInformation[] returns a DiskInformation value that provides information about the disk.
Exceptions
|
|
|
|
DeviceStatusService.getDiskInformation:ERROR:Device does not exist.DeviceName= |
||
getDiskInformation:The SOAP Body doesn’t have all the required elements |
getDiskEncryptStatus
Retrieves the disk encryption status.
Input Parameters
The keyword name requires a string that describes the name of the device.
Return
The output parameter DiskEncryption[] returns a DiskInformation value that provides the status of disk encryption.
Exceptions
getMonitoredAOs
Retrieves the operational status of application accelerators for either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
Return
The output parameter MonitoredAO[] returns a MonitoredAO value that provides the AO operational status for a WAE.
Exceptions
getMonitoredAOsByWaeIDs
Retrieves the operational status of application accelerators for a list of device IDs.
Input Parameters
|
|
|
|---|---|
Return
The output parameter MonitoredAO[] returns a MonitoredAO value that provides the AO operational status for a WAE.
Exceptions
retrieveAllAlarms
Input Parameters
Return
The output parameter Alarm[] returns an Alarm value that provides a list of all alarms.
Exceptions
|
|
|
|
retrieveAllAlarms:The SOAP Body doesn’t have all the required elements |
retrieveAlarmByName
Retrieves a list of all alarms filtered by the name of the WAE or WAE group, the object type, or the alarm name. If the alarm name is specified, all alarms matching the alarm name string are returned. If an empty string is specified, all alarms applicable to the WAE or WAE group will be returned.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
Return
The output parameter Alarm[] returns an Alarm value that provides a list of all alarms filtered by the input criteria.
Exceptions
retrieveAlarmBySeverity
Retrieves a list of all active alarms for the specified WAE or WAE group, further filtered on alarm severity. If the severity is specified as all, alarms of all severities will be returned.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
Return
The output parameter Alarm[] returns an Alarm value that provides a list of all alarms filtered by the input criteria.
Exceptions
Feedback