The Events and Status service (AlarmStatus Web Service) performs one or more of the following actions:
-
getDeviceStatus
-
getDiskStatus
-
getDiskInformation
-
getDiskEncryptStatus
-
getMonitoredAOs
-
getMonitoredAOsByWaeIDs
-
retrieveAllAlarms
-
retrieveAlarmByName
-
retrieveAlarmBySeverity
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 DiskInformation 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:
|
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.
|
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:
|
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:
|
severity
|
A String value that describes the alarm severity:
|
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.
|