Cisco Wide Area Application Services API Reference (Software Version 4.3.1)
Events and Status Service
Downloads: This chapterpdf (PDF - 161.0KB) The complete bookPDF (PDF - 2.04MB) | Feedback

Events and Status Service

Table Of Contents

Events and Status Service

retrieveAllAlarms

retrieveAlarmByName

retrieveAlarmBySeverity

getDeviceStatus

getDiskStatus

getDiskInformation

getDiskEncryptStatus

getMonitoredAOs

getMonitoredAOsByWaeIDs


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.

The Events and Status service (AlarmStatus Web Service) performs one or more of the following actions:

retrieveAllAlarms

retrieveAlarmByName

retrieveAlarmBySeverity

getDeviceStatus

getDiskStatus

getDiskInformation

getDiskEncryptStatus

getMonitoredAOs

getMonitoredAOsByWaeIDs

Alarm Status Syntax

Service URL: https://<host/ip>:8443/ws/AlarmStatus

WSDL URL: https://<host/ip>:8443/ws/AlarmStatus?wsdl

Device Status Syntax

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 
or
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
or
https://<host/ip>:8443/ws/DeviceStatus

Next, submit a SOAP request written in an XML format to retrieve the information.

The following example shows an XML-formatted SOAP request to perform the retrieveAllAlarms 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.

Example Request

<?xml version="1.0" encoding="utf-8" ?> 
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Header>
- <wsse:Security 
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.
xsd">
- <wsse:UsernameToken>
  <wsse:Username>admin</wsse:Username> 
  <wsse:Password 
Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#P
asswordText">default</wsse:Password> 
  </wsse:UsernameToken>
  </wsse:Security>
  </soapenv:Header>
  <soapenv:Body /> 
  </soapenv:Envelope>

Example Response

<?xml version="1.0" encoding="utf-8" ?> 
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Body>
- <ns:retrieveAllAlarmsResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" 
xmlns:ax233="http://stats.ws.waas.cisco.com/xsd" xmlns:ax232="http://io.java/xsd" 
xmlns:ax231="http://rmi.java/xsd">
- <ns:return type="com.cisco.waas.ws.stats.Alarm">
  <ax233:acknowledgeComments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:nil="true" /> 
  <ax233:alarmId>445001</ax233:alarmId> 
  <ax233:alarmName>core_dump</ax233:alarmName> 
  <ax233:alarmState>0</ax233:alarmState> 
  <ax233:category>3</ax233:category> 
  <ax233:description>Kernel Crash files and / or User Core files 
detected</ax233:description> 
  <ax233:deviceId>CdmConfig_157</ax233:deviceId> 
  <ax233:deviceIpAddress>2.43.153.39</ax233:deviceIpAddress> 
  <ax233:deviceName>ce-119-39</ax233:deviceName> 
  <ax233:deviceStatus>Online</ax233:deviceStatus> 
  <ax233:eventSeq>1</ax233:eventSeq> 
  <ax233:instance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" /> 
  <ax233:moduleId>1000</ax233:moduleId> 
  <ax233:moduleName>sysmon</ax233:moduleName> 
  <ax233:severity>2</ax233:severity> 
  <ax233:timestamp>1207302327034</ax233:timestamp> 
  </ns:return>
.
.
.
</ns:retrieveAllAlarmsResponse>
  </soapenv:Body>
  </soapenv:Envelope>

retrieveAllAlarms

Retrieves all alarms.

Input Parameters

None.

Return

The output parameter Alarm[] returns an Alarm value that provides a list of all alarms.

Exceptions

Type
String
Description

AxisFault

AlarmStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

AlarmStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

AlarmStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveAllAlarms:The SOAP Body doesn't have all the required elements

The SOAP body does not 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

Parameter
Description

name

A string that describes the name of the WAE, WAE group, or system.

objType

A string that describes the object type. Valid values include the following:

wae

waegroup

alarmName

A string that contains the alarm name.


Return

The output parameter Alarm[] returns an Alarm value that provides a list of all alarms filtered by the input criteria.

Exceptions

Type
String
Description

RemoteException

AlarmStatusService.retrieveAlarmsByName: ERROR:Invalid name=

The device name is invalid.

RemoteException

AlarmStatusService.retrieveAlarmsByName: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

AlarmStatusService.retrieveAlarmsByName: ERROR:Invalid alarmName=

The alarm name is not found.

AxisFault

AlarmStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

AlarmStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

AlarmStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveAlarmsByName:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


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

Parameter
Description

name

A string that describes the name of the WAE, WAE group, or system.

objType

A string that describes the object type. Valid values include the following:

wae

waegroup

severity

A String value that describes the alarm severity:

minor

major

critical

all


Return

The output parameter Alarm[] returns an Alarm value that provides a list of all alarms filtered by the input criteria.

Exceptions

Type
String
Description

RemoteException

AlarmStatusService.retrieveAlarmsBySeverity: ERROR:Invalid name=

The device name is invalid.

RemoteException

AlarmStatusService.retrieveAlarmsBySeverity: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

AlarmStatusService.retrieveAlarmsBySeverity: ERROR:Invalid severity=

The alarm severity is invalid.

AxisFault

AlarmStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

AlarmStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

AlarmStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveAlarmsBySeverity:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getDeviceStatus

Retrieves the device status.

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

Type
String
Description

RemoteException

DeviceStatusService.getDeviceStatus: ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getDeviceStatus: ERROR:Device does not exist.DeviceName=

The device name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDeviceStatus:The SOAP Body doesn't have all the required elements

The SOAP body does not 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

Type
String
Description

RemoteException

DeviceStatusService.getDiskStatus: ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getDiskStatus: ERROR:Device does not exist.DeviceName=

The device name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDiskeStatus:The SOAP Body doesn't have all the required elements

The SOAP body does not 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

Type
String
Description

RemoteException

DeviceStatusService.getDiskInformation:ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getDiskInformation:ERROR:Device does not exist.DeviceName=

The device name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDiskInformation:The SOAP Body doesn't have all the required elements

The SOAP body does not 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 DiskEncryption value that provides the status of disk encryption.

Exceptions

Type
String
Description

RemoteException

DeviceStatusService.getDiskEncryptStatus: ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getDiskEncryptStatus: ERROR:Device does not exist.DeviceName=

The device name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDiskEncryptStatus:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


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

Parameter
Description

name

A string that describes the name of the WAE, WAE group, or system.

objType

A string that describes the object type. Valid values include the following:

wae

waegroup

system


Return

The output parameter MonitoredAO[] returns a MonitoredAO value that provides the AO operational status for a WAE.

Exceptions

Type
String
Description

RemoteException

DeviceStatusService.getMonitoredAOs: ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getMonitoredAOs: ERROR:Invalid objType=

The object type is invalid.

RemoteException

DeviceStatusService.getMonitoredAOs: ERROR:Device does not exist.DeviceName=

The device name does not exist.

RemoteException

DeviceStatusService.getMonitoredAOs: ERROR:Device Group does not exist.DeviceGroup=

The device group name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getMonitoredAOs:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getMonitoredAOsByWaeIDs

Retrieves the operational status of application accelerators for a list of device IDs.

Input Parameters

Parameter
Description

ids

A data type of long that describes the ID of the WAE.


Return

The output parameter MonitoredAO[] returns a MonitoredAO value that provides the AO operational status for a WAE.

Exceptions

Type
String
Description

RemoteException

DeviceStatusService.getMonitoredAOsByWaeIds: ERROR:Invalid name=

The device name is invalid.

RemoteException

DeviceStatusService.getMonitoredAOsByWaeIds: ERROR:Invalid objType=

The object type is invalid.

RemoteException

DeviceStatusService.getMonitoredAOsByWaeIds: ERROR:Device does not exist.DeviceName=

The device name does not exist.

RemoteException

DeviceStatusService.getMonitoredAOsByWaeIds: ERROR:Device Group does not exist.DeviceGroup=

The device group name does not exist.

AxisFault

DeviceStatus:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

DeviceStatus:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

DeviceStatus:The Requested WebService is not available

The service requested is not supported.

AxisFault

getMonitoredAOsByWaeIds:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.