Ron Stone 1cfaa94833 Add SNMP wrsAlarmActiveAlarmSeverity (dsR6)
Added SNMP wrsAlarmActiveAlarmSeverity trap as alias for
AlarmSeverity.
Address patchset 1 review comments.
Change SNMP trap and event formatting for consitency.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Idec71e217ad229d7ade30b5e738698cfc4676647
2022-05-30 08:57:24 -04:00

73 lines
1.8 KiB
ReStructuredText

.. lmy1552680547012
.. _traps:
=====
Traps
=====
|prod| supports :abbr:`SNMP (Simple Network Management Protocol)` traps. Traps
send unsolicited information to monitoring software when significant events
occur.
The following traps are defined.
.. _traps-ul-p1j-tvn-c5:
- wrsAlarmCritical
- wrsAlarmMajor
- wrsAlarmMinor
- wrsAlarmWarning
- wrsAlarmMessage
- wrsAlarmClear
- wrsAlarmHierarchicalClear
|prod| alarms are mapped into one of the above traps based on severity, and
customer logs are mapped into the 'Message' trap.
.. note::
|prod| uses Wind River Systems (**wrs**) Enterprise Registration and Alarm
MIBs. See :ref:`SNMP Overview <snmp-overview>` for details.
For Critical, Major, Minor, Warning, and Message traps, all variables in the
active alarm table are included as varbinds \(variable bindings\), where each
varbind is a pair of fields consisting of an object identifier and a value
for the object.
For the Clear trap, **varbinds** include only the following variables:
.. _traps-ul-uks-byn-nkb:
- wrsAlarmActiveAlarmID
- wrsAlarmActiveEntityInstanceID
- wrsAlarmActiveDateAndTime
- wrsAlarmActiveReasonText
For the HierarchicalClear trap, **varbinds** include only the following
variables:
.. _traps-ul-isn-fyn-nkb:
- wrsAlarmActiveEntityInstanceID
- wrsAlarmActiveDateAndTime
- wrsAlarmActiveReasonText
For all alarms, the Notification Type is based on the severity of the trap or
alarm. This is done to facilitate the interaction with most SNMP trap viewers
which use the Notification Type to drive the coloring of traps, that is, red
for critical, yellow for minor, and so on.
See https://opendev.org/starlingx/snmp-armada-app/src/branch/master/stx-snmp-helm/centos/docker/stx-snmp/mibs/wrsAlarmMib.mib.txt
for alarm details.