Alarms Service WSDL

Alarms are conditions within the data center infrastructure that require attention. The textual contents of StruxureWare Data Center Expert alarms are localized to a user specified locale when they are retrieved from the server. If no locale is specified, the server default locale is assumed.

All alarms contain a reference to the device that is experiencing the alarm condition. If an alarm is associated with a specific device sensor, a reference to that sensor may also be included in the alarm. Sensor-related alarms are usually generated when a user-defined threshold for the sensor value is violated. Sensor thresholds can be defined either directly on the device or in the StruxureWare Data Center Expert server. 

An alarm is either active, meaning the condition that triggered the alarm still exists, or resolved, meaning the trigger condition no longer exists.

The following sections describe the methods of the Alarms service.

getAllActiveAlarms

Returns a list of ISXCAlarm objects that represent all alarms that are currently unresolved in the StruxureWare Data Center Expert server. 

Service: ISXCentralAlarmsService

ParameterTypeDescription
locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmByID

Returns an ISXCAlarm object that represents an alarm (active or resolved) in the StruxureWare Data Center Expert server and is identified by the specified ID. 

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier of an alarm that was created in the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getActiveAlarmsForDevice

Returns a list of ISXCAlarm objects that represent active alarms associated with an DCE-server-monitored device which is identified by the specified ID. 

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier of a device that is being monitored by the StruxureWare Data Center Expert server.

excludeSensors (optional)boolean

When set to true, alarms associated with sensors will be filtered from the result set, and only alarms that are directly associated with the device will be returned.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getActiveAlarmsForSensor

Returns a list of ISXCAlarm objects that represent active alarms associated with an DCE-server-monitored sensor which is identified by the specified ID. 

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier of a sensor that is being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getActiveAlarmsForSeverity

Returns a list of ISXCAlarm objects that represent active alarms which have a severity that matches the specified severity level.

Service: ISXCentralAlarmsService

ParameterTypeDescription
severityISXCAlarmSeverity

The severity to filter the resulting alarms on. 

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsHistory

Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame.

Service: ISXCentralAlarmsService

ParameterTypeDescription
startDatexsd:datetime

The start date-time of the range to return data for. 

endDatexsd:datetime

The end date-time of the range to return data for. 

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsHistoryForDevice

Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and associated with the specific device.

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier for an DCE-server-monitored device. 

startDatexsd:datetime

The start date-time of the range to return data for. 

endDatexsd:datetime

The end date-time of the range to return data for. 

excludeSensors (optional)boolean

When set to true, alarms associated with sensors are excluded from the results, and only alarms directly associated with the specified device are returned.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsHistoryForSensnor

Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and associated with the specific sensor.

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier for an DCE-server-monitored sensor. 

startDatexsd:datetime

The start date-time of the range to return data for. 

endDatexsd:datetime

The end date-time of the range to return data for. 

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsHistoryForSeverity

Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and were of the specified severity.

Service: ISXCentralAlarmsService

ParameterTypeDescription
severityISXCAlarmSeverity

The alarm severity to filter the results on. 

startDatexsd:datetime

The start date-time of the range to return data for. 

endDatexsd:datetime

The end date-time of the range to return data for. 

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsDeltaHistory

Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame.

Service: ISXCentralAlarmsService

ParameterTypeDescription
secondsInPastinteger

The number of seconds to go back (relative to “now”) and evaluate alarm data for.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsDeltaHistoryForDevice

Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were associated with the specified device.

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier for an DCE-server-monitored device. 

 secondsInPastinteger

The number of seconds to go back (relative to “now”) and evaluate alarm data for.

excludeSensors (optional)boolean

When set to true, alarms associated with sensors are excluded from the results, and only alarms directly associated with the specified device are returned.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsDeltaHistoryForSensor

Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were associated with the specified sensor.

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier for an DCE-server-monitored sensor. 

 secondsInPastinteger

The number of seconds to go back (relative to “now”) and evaluate alarm data for.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

getAlarmsDeltaHistoryForSeverity

Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were of the specified severity.

Service: ISXCentralAlarmsService

ParameterTypeDescription
ISXCElementIDString

The unique identifier for an DCE-server-monitored sensor. 

 secondsInPastinteger

The number of seconds to go back (relative to “now”) and evaluate alarm data for.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert server.

setAcknowledgmentForAlarm

Allows the user to comment an alarm, set the alarm as hidden, and to suppress notifications of this alarm.

Service: ISXCentralAlarmsService

ParameterTypeDescription
alarmIDString

The unique identifier for an alarm.

comment (optional)String

The comment the user wants to add to the alarm acknowledgment history.

 isAlarmHidden boolean

Indicates if the alarm should be hidden in the DCE clients.

 isAlarmAlertSuppressedboolean

Indicates if the alarm notifications (alerts) should be suppressed.

getAcknowledgmentForAlarm

Allows the user retrieve the acknowledgments status: is alarm hidden, are alarm notifications suppressed.

Service: ISXCentralAlarmsService

ParameterTypeDescription
alarmIDString

The unique identifier for an alarm.

getAcknowledgmentHistoryForAlarm

Allows the user to retrieve the acknowledgment history for an alarm.

Service: ISXCentralAlarmsService

ParameterTypeDescription
alarmIDString

The unique identifier for an alarm.

deleteAcknowledgmentByID

Allows the user to delete alarm acknowledgment comments.

Service: ISXCentralAlarmsService

ParameterTypeDescription
 acknowledgmentIDint

The unique identifier for an alarm acknowledgment.

alarmIDString

The unique identifier for an alarm.

 


 

Skip to end of metadata
Go to start of metadata
  • No labels
RELATED COMMUNITY QUESTIONS
WAS THIS ARTICLE HELPFUL?