# NMS OAM events

Each event's prefix relates the event to a specific NMS Communications library of functions, as described in the following table:

Event prefix | Source | Defined in
--- | --- | ---
OAMEVN_ | NMS OAM service | oamdef.h
HSWEVN_ | Hot Swap EMC | hswdef.h
CLKEVN_ | Clock Management EMC | clkdef.h
CTAEVN_ | Natural Access | ctadef.h
(Other) | (Other service) | (Other .h file)

To receive events from the NMS OAM service and from installed EMCs (such as Hot Swap and Clock Management), a client application must register for alerts with the NMS OAM service. To learn how to register an application, see Receiving NMS OAM alert notifications.

The following table alphabetically lists the NMS OAM service events:

Event name | Hex | Decimal | Description
--- | --- | --- | ---
CLKEVN_CONFIG_FAILED | 0x40012003 | 1073815555 | An attempt to configure board's clock failed.
CLKEVN_CONFIGURED | 0x40012001 | 1073815553 | Board clock is successfully configured.
CLKEVN_INVALID_CONFIG_DATA | 0x40012002 | 1073815554 | Board clock configuration is invalid or missing.
CLKEVN_OPEN_OAM_FAILED | 0x40012004 | 1073815556 | An attempt to open a board plug-in failed.
CLKEVN_OPEN_SWITCH_FAILED | 0x40012005 | 1073815557 | Could not open board's switch.
HSWEVN_BOARD_INSERTED | 0x40112005 | 1074864133 | A board was physically inserted. No board resources are yet available for the application. The state changes from Extracted to OffLine, and the Hot Swap driver starts to configure the board on the PCI bus. If the board was successfully configured on the PCI bus, the application receives HSWEVN_ONLINE_PENDING and the state changes to OnLinePending. Otherwise, the application receives HSWEVN_PCI_CONFIG_FAILED and the state stays OffLine.
HSWEVN_BOARD_OFFLINE | 0x40112003 | 1074864131 | The board is in the OffLine state and can be extracted. If the board was removed from the OffLinePending state without waiting for HSWEVN_BOARD_OFFLINE (surprise extraction), then HSWEVN_BOARD_REMOVED immediately follows.
HSWEVN_BOARD_READY | 0x40112001 | 1074864129 | An inserted board was successfully configured and booted by the OAM service. The state changes to OnLine. After receiving this event, an application can use the inserted board. All resources are accessible. Note: Board clocking configuration may not yet be complete. If the board is operating in a clocking mode other than Standalone, the application must wait for CLKEVN_CONFIGURED before using the board.
HSWEVN_BOARD_REMOVED | 0x40112004 | 1074864132 | A board was physically removed from the chassis. The Hot Swap state changes from OffLine to Extracted.
HSWEVN_ONLINE_PENDING | 0x40112006 | 1074864134 | The Hot Swap manager created a device instance for the board and notified the NMS OAM service to start it. The state changes to OnLinePending. If the device instance is successfully created and the board is started, the application receives HSWEVN_BOARD_READY and the state changes to OnLine. Otherwise, it receives HSWEVN_PREPARATION_FAILED and the state changes to Failed. If extraction was initiated by hsmon or with the Board.boardname.Command keyword, and the board handles are open in the Failed state, the application receives HSWEVN_BOARD_OFFLINE and the state changes to OffLine. If insertion was initiated in the Failed state by hsmon or with the Board.boardname.Command keyword, the application receives HSWEVN_ONLINE_PENDING and the process repeats as previously described.
HSWEVN_PCI_CONFIG_FAILED | 0x40112007 | 1074864135 | The board transitioned to the OffLine state and the PCI configuration process failed. There are three ways to make another configuration attempt: Open and close the handles on the board. Initiate insertion from hsmon. Initiate insertion using the Board.boardname.Command keyword.
HSWEVN_PREPARATION_FAILED | 0x40112008 | 1074864136 | The application receives this event in the OnLinePending state when the device instance was not successfully created or the board failed to start. The state changes to Failed. There are three ways to try to start the board: Open and close the handles on the board. Initiate insertion from hsmon. Initiate insertion using the Board.boardname.Command keyword. If extraction was initiated by hsmon or with the Board.boardname.Command keyword, and the board handles are open in the Failed state, the application receives HSWEVN_BOARD_OFFLINE and the state changes to OffLine. If insertion was initiated in the Failed state by hsmon or with the Board.boardname.Command keyword, the application receives HSWEVN_ONLINE_PENDING and the preparation process repeats. A board fails to start with this event if the Supervisor keyword AutoStartEnabled or the board keyword AutoStart is set to No.
HSWEVN_REMOVAL_REQUESTED | 0x40112002 | 1074864130 | A board's ejector handles were opened or extraction was initiated from hsmon. This event warns the application that the board will be removed. After receiving this event, an application must close all resources associated with the board. The state changes to OffLinePending. When an application closes all resources, it receives HSWEVN_BOARD_OFFLINE and the state changes to OffLine.
OAMEVN_ALERT | 0x40002001 | 1073750017 | Alert indication. The OAM_MSG field returned with the event contains more information.
OAMEVN_BOARD_DEAD | 0x40002008 | 1073750024 | An object representing a board is dead.
OAMEVN_CREATED | 0x40002003 | 1073750019 | An object was successfully created.
OAMEVN_DELETED | 0x40002004 | 1073750020 | An object was successfully deleted.
OAMEVN_FAN_RPM_WARNING | 0x4000200B | 1073750027 | For CG 6565 and CG 6565e boards only. Fan tachometer reaches the warning threshold set in the board configuration file. The event value field contains the fan tachometer, in RPM.
OAMEVN_MODIFIED | 0x40002007 | 1073750023 | An object was modified (closed after write access).
OAMEVN_RENAMED | 0x40002005 | 1073750021 | An object was successfully renamed. (OAM_MSG contains the old name.)
OAMEVN_REPORT | 0x40002002 | 1073750018 | Special internal code used to log report information.
OAMEVN_STARTBOARD_DONE | 0x40002101 | 1073750273 | Invocation of oamStartBoard successful. The event value field contains a reason code indicating the actual results of the board starting attempt.
OAMEVN_STOPBOARD_DONE | 0x40002102 | 1073750274 | Invocation of oamStopBoard successful. The event value field contains a reason code indicating the actual results of the board stopping attempt.
OAMEVN_STOPBOARD_REQ | 0x40002201 | 1073750529 | A request was made to stop a board with oamStopBoard. The board will be stopped in 150 ms.
OAMEVN_TEMPERATURE_ALERT | 0x4000200A | 1073750026 | For CG 6565, CG 6565C, and CG 6565e boards only. Board temperature reaches the critical threshold set in the board configuration file. The event value field contains the actual temperature, in tenth of a degree Celsius.
OAMEVN_TEMPERATURE_WARNING | 0x40002009 | 1073750025 | For CG 6565, CG 6565C, and CG 6565e boards only. Board temperature reaches the warning threshold set in the board configuration file. The event value field contains the actual temperature, in tenth of a degree Celsius.
OAMEVN_TESTBOARD_DONE | 0x40002103 | 1073750275 | Invocation of oamTestBoard successful. The event value field contains a reason code indicating the actual results of the board testing attempt.
OAMEVN_TRACE | 0x40002006 | 1073750022 | Indicates trace information (potentially high-speed).

For more information about NMS OAM service event handling, refer to NMS OAM event structure.