NMS OAM error codes

All NMS OAM service functions return a status code. If the return code is not SUCCESS (0), it is an error code indicating that the function has failed and a reason for the failure.

Error codes can also appear in the value field of a DONE event. Use the CTA_IS_ERROR macro to determine if a value is an error.

Errors are returned by the NMS OAM Supervisor and by any installed EMC. The prefix of the error indicates its source:

Error prefix	Source	Defined in
OAMERR_	NMS OAM service	oamdef.h
HSWERR_	Hot Swap EMC	hswdef.h
CLKERR_	Clock Management EMC	clkdef.h
CTAERR_	Natural Access	ctadef.h
(Other)	(Other service)	(Other .h file)

This topic provides a summary of NMS OAM error codes. The error codes are presented in two tables:

Alphabetical, by error name, including a description of the problem and a possible solution.
Numerical, by hexadecimal value, decimal value, and error name.

Alphabetical error summary

The following table provides an alphabetical list of errors. All errors are 32 bits.

Error name	Hex	Decimal	Description
CLKERR_FAILURE	0x40010002	1073807362	A general failure occurred.
CLKERR_NO_RESOURCES	0x40010000	1073807360	No resources are available.
CLKERR_NOT_FOUND	0x40010001	1073807361	Specified object is not found.
HSWERR_FAILURE	0x40110001	1074855937	A general failure occurred.
HSWERR_INVALID_BUS	0x40110003	1074855939	Specified PCI bus is invalid.
HSWERR_NO_RESOURCES	0x40110002	1074855938	No resources are available.
HSWERR_NOT_FOUND	0x40110004	1074855940	Specified object is not found.
OAMERR_ACCESS_DENIED	0x40000006	1073741830	The operation cannot be completed, because it is not allowed.
OAMERR_ALREADY_EXISTS	0x40000005	1073741829	The operation cannot be completed because an item exists that should not already exist.
OAMERR_BOARD_SELFTEST_FAIL	0x4000010E	1073742094	An attempt to test a board failed.
OAMERR_BOARD_SELFTEST_INVALID	0x4000010F	1073742095	Board testing is not supported by this plug-in.
OAMERR_CANT_CREATE_THREAD	0x40000009	1073741833	Cannot create thread to do asynchronous operation.
OAMERR_CLOSE_OBJECT_FAIL	0x4000010B	1073742091	The Supervisor could not close a managed object in the NMS OAM database.
OAMERR_CREATE_BOARD_FAIL	0x40000105	1073742085	The Supervisor could not create a managed object for a board in the NMS OAM database.
OAMERR_DESTORY_BOARD_FAIL (sic)	0x40000106	1073742086	The Supervisor could not delete a managed object for a board from the NMS OAM database.
OAMERR_FILE_READ_ERROR	0x40000007	1073741831	Error reading from database or file.
OAMERR_FILE_WRITE_ERROR	0x40000008	1073741832	Error writing to database or file.
OAMERR_GET_BOARD_KEYWORD_FAIL	0x40000107	1073742087	The Supervisor could not retrieve a keyword value from the NMS OAM database.
OAMERR_GET_QUALIFIER_FAIL	0x40000109	1073742089	The Supervisor could not retrieve a qualifier for a keyword from the NMS OAM database.
OAMERR_NOT_ENOUGH_MEMORY	0x40000003	1073741827	Memory allocation error, or specified buffer size is too small.
OAMERR_NOT_FOUND	0x40000004	1073741828	Specified board, object, keyword, or qualifier is not found.
OAMERR_NOT_SUPPORTED_WARNING	0x40000103	1073742083	An operation is not supported.
OAMERR_OPEN_DRIVER_FAIL	0x40000111	1073742097	An attempt to open a driver failed.
OAMERR_OPEN_OBJECT_FAIL	0x4000010A	1073742090	The Supervisor could not open a managed object in the NMS OAM database.
OAMERR_PLUGIN_EXIT_FAIL	0x40000102	1073742082	The Supervisor could not shut down a plug-in.
OAMERR_PLUGIN_INIT_FAIL	0x40000101	1073742081	The Supervisor could not initialize a plug-in.
OAMERR_SEND_BUFFER_FAIL	0x40000110	1073742096	An attempt to send a raw buffer to a board with oamSendBuffer failed.
OAMERR_SERVER_NOT_FOUND	0x40000001	1073741825	Natural Access Server is not found.
OAMERR_SERVER_NOT_RUNNING	0x40000002	1073741826	NMS OAM Supervisor is shut down.
OAMERR_SET_BOARD_KEYWORD_FAIL	0x40000108	1073742088	The Supervisor could not set a keyword value in the NMS OAM database.
OAMERR_START_BOARD_FAIL	0x4000010C	1073742092	An attempt to start a board failed.
OAMERR_STOP_BOARD_FAIL	0x4000010D	1073742093	An attempt to stop a board failed.

Numerical error summary

The following table provides a list of errors in numerical order:

Hex	Decimal	Error name
0x40000001	1073741825	OAMERR_SERVER_NOT_FOUND
0x40000002	1073741826	OAMERR_SERVER_NOT_RUNNING
0x40000003	1073741827	OAMERR_NOT_ENOUGH_MEMORY
0x40000004	1073741828	OAMERR_NOT_FOUND
0x40000005	1073741829	OAMERR_ALREADY_EXISTS
0x40000006	1073741830	OAMERR_ACCESS_DENIED
0x40000007	1073741831	OAMERR_FILE_READ_ERROR
0x40000008	1073741832	OAMERR_FILE_WRITE_ERROR
0x40000009	1073741833	OAMERR_CANT_CREATE_THREAD
0x40000101	1073742081	OAMERR_PLUGIN_INIT_FAIL
0x40000102	1073742082	OAMERR_PLUGIN_EXIT_FAIL
0x40000103	1073742083	OAMERR_NOT_SUPPORTED_WARNING
0x40000105	1073742085	OAMERR_CREATE_BOARD_FAIL
0x40000106	1073742086	OAMERR_DESTORY_BOARD_FAIL (sic)
0x40000107	1073742087	OAMERR_GET_BOARD_KEYWORD_FAIL
0x40000108	1073742088	OAMERR_SET_BOARD_KEYWORD_FAIL
0x40000109	1073742089	OAMERR_GET_QUALIFIER_FAIL
0x4000010A	1073742090	OAMERR_OPEN_OBJECT_FAIL
0x4000010B	1073742091	OAMERR_CLOSE_OBJECT_FAIL
0x4000010C	1073742092	OAMERR_START_BOARD_FAIL
0x4000010D	1073742093	OAMERR_STOP_BOARD_FAIL
0x4000010E	1073742094	OAMERR_BOARD_SELFTEST_FAIL
0x4000010F	1073742095	OAMERR_BOARD_SELFTEST_INVALID
0x40000110	1073742096	OAMERR_SEND_BUFFER_FAIL
0x40000111	1073742097	OAMERR_OPEN_DRIVER_FAIL
0x40010000	1073807360	CLKERR_NO_RESOURCES
0x40010001	1073807361	CLKERR_NOT_FOUND
0x40010002	1073807362	CLKERR_FAILURE
0x40110001	1074855937	HSWERR_FAILURE
0x40110002	1074855938	HSWERR_NO_RESOURCES
0x40110003	1074855939	HSWERR_INVALID_BUS
0x40110004	1074855940	HSWERR_NOT_FOUND