Chapter 1

Introduction

The NMS Board and Driver Errors Manual provides information about board-level errors returned by NMS hardware.
Developers can use this manual to debug NMS boards by examining board and driver errors saved in hardware log files. This manual lists the AG and CG board and driver error messages and describes the format of these messages.

By using the oammon board monitoring utility, you can perform the following tasks: Monitor boards for errors and other messages Capture messages in a flat file Send an alert notification message to all NMS OAM client applications
To launch oammon, enter oammon at the command line, followed by the desired command line options. Precede each option with a hyphen (-) or slash (/). If the option includes data, specify the data directly after the option on the command line. Valid options are described in Section 1.2.1.
If you invoke oammon without command line options, it immediately begins monitoring, and displays any messages to stdout. Note: ctdaemon must be running to use oammon. Refer to the Natural Access Developer's Reference Manual for more information on starting ctdaemon.

Option	Use this option to...
`-f` *file*	Log messages to file *file*, as well as to stdout. Always save the output to a file.
`-s` *messagetext*	Send a test alert notification message containing text *messagetext* to all applications currently monitoring for alert messages (for example, another instance of `oammon`). `oammon` then terminates. *messagetext* can be any string of characters. Applications receive an OAMEVN_ALERT event with a pointer to an OAM_MSG structure containing the message text. For more information about alert notification, refer to the NMS OAM Service Developer's Reference Manual.
`-?`	Display the Help screen. `oammon` then terminates.
`-h`	Display the Help screen. `oammon` then terminates.

AG board error messages are formatted as follows:
The AG board and driver messages contain the following fields: Field Description value field, low 16 bits Error code (shown in decimal). value field, high 16 bits Error type (shown in hex). size field, low word First word of additional data. size field, high word Second word of additional data.

Field	Description
value field, low 16 bits	Error code (shown in decimal).
value field, high 16 bits	Error type (shown in hex).
size field, low word	First word of additional data.
size field, high word	Second word of additional data.

oammon error messages are formatted as follows:
The CG board and driver error messages contain the following fields: Field Description Date Date when error occurred. Time stamp Time when error occurred. OAM alert message Error message identifier. Board number Number assigned to board by NMS OAM. Board name Name assigned to board by NMS OAM. Message description Message type description. Hex ID string Hexadecimal ID string. ASCII ID string Text ID string.

Field	Description
Date	Date when error occurred.
Time stamp	Time when error occurred.
OAM alert message	Error message identifier.
Board number	Number assigned to board by NMS OAM.
Board name	Name assigned to board by NMS OAM.
Message description	Message type description.
Hex ID string	Hexadecimal ID string.
ASCII ID string	Text ID string.

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com