Shelved-alarms (Section)#

Path: /alarms/shelved-alarms

The shelved alarms. Alarms appear here if they match the criteria in /alarms/control/alarm-shelving. This list does not generate any notifications. The list represents alarms that are considered not relevant by the operator. Alarms in this list have an ‘operator-state’ of ‘shelved’. This cannot be changed.

Parameters#

NameTypeRequiredDefaultDescription
number-of-shelved-alarmsgauge32optionalThis object shows the total number of current alarms, i.e., the total number of entries in the alarm list.
shelved-alarms-last-changeddate-and-timeoptionalA timestamp when the shelved-alarm list was last changed. The value can be used by a manager to initiate an alarm resynchronization procedure.

Subsections#

NameTypeDescription
shelved-alarm ListThe list of shelved alarms. Shelved alarms can only be updated from the underlying resource; no operator actions are supported.

Was this helpful?