Alarms (Section)#
Path: /alarms
The top container for this module.
Subsections#
| Name | Type | Description |
|---|---|---|
| control | Section | Configuration to control the alarm behavior. |
| alarm-inventory | Section | The ‘alarm-inventory/alarm-type’ list contains all possible alarm types for the system. If the system knows for which resources a specific alarm type can appear, it is also identified in the inventory. The list also tells if each alarm type has a corresponding clear state. The inventory shall only contain concrete alarm types. The alarm inventory MUST be updated by the system when new alarms can appear. This can be the case when installing new software modules or inserting new card types. A notification ‘alarm-inventory-changed’ is sent when the inventory is changed. |
| summary | Section | This container gives a summary of the number of alarms. |
| alarm-list | Section | The alarms in the system. |
| shelved-alarms | Section | 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. |
| alarm-profile | List | This list is used to assign further information or configuration for each alarm type. This module supports a mechanism where the client can override the system-default alarm severity levels. The ‘alarm-profile’ is also a useful augmentation point for specific additions to alarm types. |