Alarms Service Methods

[EcoStruxureIT]

Alarms Service WSDL

Alarms are conditions within the data center infrastructure that require attention. The textual contents of 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 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 Data Center Expert server. 

Service: ISXCentralAlarmsService

Parameter	Type	Description
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getAlarmByID

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

Service: ISXCentralAlarmsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier of an alarm that was created in the 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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier of a device that is being monitored by the 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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier of a sensor that is being monitored by the 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 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

Parameter	Type	Description
severity	ISXCAlarmSeverity	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 Data Center Expert server.

getAlarmsHistory

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

Service: ISXCentralAlarmsService

Parameter	Type	Description
startDate	xsd:datetime	The start date-time of the range to return data for.
endDate	xsd: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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier for an DCE-server-monitored device.
startDate	xsd:datetime	The start date-time of the range to return data for.
endDate	xsd: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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier for an DCE-server-monitored sensor.
startDate	xsd:datetime	The start date-time of the range to return data for.
endDate	xsd: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 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

Parameter	Type	Description
severity	ISXCAlarmSeverity	The alarm severity to filter the results on.
startDate	xsd:datetime	The start date-time of the range to return data for.
endDate	xsd: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 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

Parameter	Type	Description
secondsInPast	integer	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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier for an DCE-server-monitored device.
secondsInPast	integer	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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier for an DCE-server-monitored sensor.
secondsInPast	integer	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 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

Parameter	Type	Description
ISXCElementID	String	The unique identifier for an DCE-server-monitored sensor.
secondsInPast	integer	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 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

Parameter	Type	Description
alarmID	String	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.
isAlarmAlertSuppressed	boolean	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

Parameter	Type	Description
alarmID	String	The unique identifier for an alarm.

getAcknowledgmentHistoryForAlarm

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

Service: ISXCentralAlarmsService

Parameter	Type	Description
alarmID	String	The unique identifier for an alarm.

deleteAcknowledgmentByID

Allows the user to delete alarm acknowledgment comments.

Service: ISXCentralAlarmsService

Parameter	Type	Description
acknowledgmentID	int	The unique identifier for an alarm acknowledgment.
alarmID	String	The unique identifier for an alarm.