3.2.9. alarm¶
Top-level container for alarm. It mounts ietf-alarms configuration.
vsr running config# system alarm
enabled¶
Enable or disable the alarms.
vsr running config# system alarm
vsr running alarm# enabled true|false
- Default value
true
max-alarm-status-changes¶
The ‘status-change’ entries are kept in a circular list per alarm. When this number is exceeded, the oldest status change entry is automatically removed. If the value is ‘infinite’, the status-change entries are accumulated infinitely.
vsr running config# system alarm
vsr running alarm# max-alarm-status-changes MAX-ALARM-STATUS-CHANGES
|
Description |
|---|---|
<uint16> |
No description. |
infinite |
The status-change entries are accumulated infinitely. |
- Default value
32
notify-status-changes¶
This leaf controls the notifications sent for alarm status updates. There are three options: 1. Notifications are sent for all updates, severity-level changes, and alarm-text changes. 2. Notifications are only sent for alarm raise and clear. 3. Notifications are sent for status changes equal to or above the specified severity level. Clear notifications shall always be sent. Notifications shall also be sent for state changes that make an alarm less severe than the specified level. For example, in option 3, assume that the severity level is set to major and that the alarm has the following state changes: [(Time, severity, clear)]: [(T1, major, -), (T2, minor, -), (T3, warning, -), (T4, minor, -), (T5, major, -), (T6, critical, -), (T7, major. -), (T8, major, clear)] In that case, notifications will be sent at times T1, T2, T5, T6, T7, and T8.
vsr running config# system alarm
vsr running alarm# notify-status-changes NOTIFY-STATUS-CHANGES
|
Description |
|---|---|
all-state-changes |
Send notifications for all status changes. |
raise-and-clear |
Send notifications only for raise, clear, and re-raise. Notifications for severity-level changes or alarm-text changes are not sent. |
severity-level |
Only send notifications for alarm-state changes crossing the level specified in ‘notify-severity-level’. Always send clear notifications. |
- Default value
all-state-changes
notify-severity-level¶
Only send notifications for alarm-state changes crossing the specified level. Always send clear notifications.
vsr running config# system alarm
vsr running alarm# notify-severity-level NOTIFY-SEVERITY-LEVEL
NOTIFY-SEVERITY-LEVEL |
The severity level of the alarm. Note well that the value ‘clear’ is not included. Whether or not an alarm is cleared is a separate boolean flag. |
alarm-inventory (state only)¶
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.
alarm-type (state only)¶
An entry in this list defines a possible alarm.
resource (state only)¶
Optionally, specifies for which resources the alarm type is valid.
vsr> show state system alarm alarm-inventory alarm-type <alarm-type-id> <alarm-type-qualifier> resource
will-clear (state only)¶
This leaf tells the operator if the alarm will be cleared when the correct corrective action has been taken. Implementations SHOULD strive for detecting the cleared state for all alarm types. If this leaf is ‘true’, the operator can monitor the alarm until it becomes cleared after the corrective action has been taken. If this leaf is ‘false’, the operator needs to validate that the alarm is no longer active using other mechanisms. Alarms can lack a corresponding clear due to missing instrumentation or no logical corresponding clear state.
vsr> show state system alarm alarm-inventory alarm-type <alarm-type-id> <alarm-type-qualifier> will-clear
severity-level (state only)¶
This leaf-list indicates the possible severity levels of this alarm type. Note well that ‘clear’ is not part of the severity type. In general, the severity level should be defined by the instrumentation based on the dynamic state, rather than being defined statically by the alarm type, in order to provide a relevant severity level based on dynamic state and context. However, most alarm types have a defined set of possible severity levels, and this should be provided here.
vsr> show state system alarm alarm-inventory alarm-type <alarm-type-id> <alarm-type-qualifier> severity-level
description (state only)¶
A description of the possible alarm. It SHOULD include information on possible underlying root causes and corrective actions.
vsr> show state system alarm alarm-inventory alarm-type <alarm-type-id> <alarm-type-qualifier> description
alarm-list (state only)¶
The alarms in the system.
number-of-alarms (state only)¶
This object shows the total number of alarms in the system, i.e., the total number of entries in the alarm list.
vsr> show state system alarm alarm-list number-of-alarms
last-changed (state only)¶
A timestamp when the alarm list was last changed. The value can be used by a manager to initiate an alarm resynchronization procedure.
vsr> show state system alarm alarm-list last-changed
alarm (state only)¶
The list of alarms. Each entry in the list holds one alarm for a given alarm type and resource. An alarm can be updated from the underlying resource or by the user. The following leafs are maintained by the resource: ‘is-cleared’, ‘last-change’, ‘perceived-severity’, and ‘alarm-text’. An operator can change ‘operator-state’ and ‘operator-text’. Entries appear in the alarm list the first time an alarm becomes active for a given alarm type and resource. Entries do not get deleted when the alarm is cleared. Clear status is represented as a boolean flag. Alarm entries are removed, i.e., purged, from the list by an explicit purge action. For example, purge all alarms that are cleared and in closed operator state that are older than 24 hours. Purged alarms are removed from the alarm list. If the alarm resource state changes after a purge, the alarm will reappear in the alarm list. Systems may also remove alarms based on locally configured policies; this is out of scope for this module.
alt-resource (state only)¶
Used if the alarming resource is available over other interfaces. This field can contain SNMP OIDs, CIM paths, or 3GPP distinguished names, for example.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> alt-resource
time-created (state only)¶
The timestamp when this alarm entry was created. This represents the first time the alarm appeared; it can also represent that the alarm reappeared after a purge. Further state changes of the same alarm do not change this leaf; these changes will update the ‘last-changed’ leaf.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> time-created
is-cleared (state only)¶
Indicates the current clearance state of the alarm. An alarm might toggle from active alarm to cleared alarm and back to active again.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> is-cleared
last-raised (state only)¶
An alarm may change severity level and toggle between active and cleared during its lifetime. This leaf indicates the last time it was raised (‘is-cleared’ = ‘false’).
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> last-raised
last-changed (state only)¶
A timestamp when the ‘status-change’ or ‘operator-state-change’ list was last changed.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> last-changed
perceived-severity (state only)¶
The last severity of the alarm. If an alarm was raised with severity ‘warning’ but later changed to ‘major’, this leaf will show ‘major’.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> perceived-severity
alarm-text (state only)¶
The last reported alarm text. This text should contain information for an operator to be able to understand the problem and how to resolve it.
vsr> show state system alarm alarm-list alarm <resource> <alarm-type-id> <alarm-type-qualifier> alarm-text