NMS OAM events (both solicited and unsolicited) are available with SNMP. An SNMP application can receive them either as SNMP traps or by querying the OAM database MIB.
To receive NMS OAM events as SNMP traps, set oamAlertRegister to 1. To stop receiving events as traps, set oamAlertRegister to 2.
Regardless of whether SNMP is registered to receive NMS OAM events, an application can always determine the last event received by querying oamEventDescription. This value contains a string of the form:
eventname name=objectname
Where:
eventname is the name of the last event received, such as OAMEVN_STARTBOARD_DONE.
objectname is the name of the object sending the event (for example: MyBoard).
For example:
OAMEVN_STARTBOARD_DONE name=MyBoard
The events in the following table are reported similarly in oamEventDescription:
|
Event name |
String in oamEventDescription |
|---|---|
|
OAMEVN_ALERT |
eventname name=objectname message=message message is the alert message sent |
|
OAMEVN_REPORT |
eventname name=objectname message=message message is the alert message sent |
|
OAMEVN_TRACE |
eventname name=objectname message=message message is the alert message sent |
|
OAMEVN_RENAMED |
eventname oldname=oldname newname=newname oldname is the original name of the board. newname is the new name of the board |
You can mask the alerts received by SNMP (either as traps or by querying the MIB) by setting oamEventMask. The following table lists valid mask values:
|
Mask |
Value |
Indication |
|---|---|---|
|
TRAP_MASK_OAMEVN_ALERT |
0x1 |
OAM alert generated. |
|
TRAP_MASK_OAMEVN_REPORT |
0x2 |
Special internal code used to log report info. |
|
TRAP_MASK_OAMEVN_CREATED |
0x4 |
Object created. |
|
TRAP_MASK_OAMEVN_DELETED |
0x8 |
Object deleted. |
|
TRAP_MASK_OAMEVN_RENAMED |
0x10 |
Object renamed (text = new name). |
|
TRAP_MASK_OAMEVN_TRACE |
0x20 |
Trace info (potentially high-speed). |
|
TRAP_MASK_OAMEVN_MODIFIED |
0x40 |
Object modified (closed after write access). |
|
TRAP_MASK_OAMEVN_BOARD_DEAD |
0x80 |
Board failed. |
|
TRAP_MASK_OAMEVN_STARTBOARD_DONE |
0x100 |
Board successfully started. |
|
TRAP_MASK_OAMEVN_STOPBOARD_DONE |
0x200 |
Board successfully stopped. |
|
TRAP_MASK_OAMEVN_TESTBOARD_DONE |
0x400 |
Board test successfully initiated. |
|
TRAP_MASK_HSWEVN_REMOVAL_REQUESTED |
0x800 |
Board extraction began or board extraction initiated in software. |
|
TRAP_MASK_HSWEVN_BOARD_OFFLINE |
0x1000 |
Board off line. |
|
TRAP_MASK_HSWEVN_BOARD_REMOVED |
0x2000 |
Board removed. |
|
TRAP_MASK_HSWEVN_BOARD_INSERTED |
0x4000 |
Board inserted. |
|
TRAP_MASK_HSWEVN_ONLINE_PENDING |
0x8000 |
Board inserted and is about to go online. |
|
TRAP_MASK_HSWEVN_PCI_CONFIG_FAILED |
0x10000 |
PCI configuration attempt failed. |
|
TRAP_MASK_HSWEVN_PREPARATION_FAILED |
0x20000 |
Preparation for board removal failed. |
|
TRAP_MASK_HSWEVN_BOARD_READY |
0x40000 |
Board is ready. |
By default, no masks are set. For more information about NMS OAM events, refer to the NMS OAM Service Developer's Reference Manual.