Table of Contents Index NMS Glossary Previous Page Next Page Version


Appendix A

Errors, Events and Reasons


Error Codes
Alphabetical Error Summary
Numerical Error Summary
NMS OAM Events
NMS OAM Reason Codes

Error CodesTop of Page

All 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 extended management component (EMC). The prefix of the error indicates its source:
Error Prefix

Source

Defined In

OAMERR_

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 section provides a summary of OAM service error codes. The error codes are presented in two tables:

Alphabetical Error SummaryTop of Page

The following table provides an alphabetical listing 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 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_AUTO_DETECT_BOARD_FAIL

0x40000104

1073742084

NMS OAM could not auto-detect boards in the system.

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

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

ctdaemon is not found.

OAMERR_SERVER_NOT_RUNNING

0x40000002

1073741826

OAM Supervisor is not running.

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 SummaryTop of Page

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

0x40000104

1073742084

OAMERR_AUTO_DETECT_BOARD_FAIL

0x40000105

1073742085

OAMERR_CREATE_BOARD_FAIL

0x40000106

1073742086

OAMERR_DESTORY_BOARD_FAIL

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

NMS OAM EventsTop of Page

Events are generated by:

Each event's prefix relates the event to a specific Natural Microsystems library of functions, as described in the following table:
Event Prefix

Source

Defined In

OAMEVN_

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 OAM service and from installed EMCs (such as Hot Swap and clock management), a client application must register with the OAM service. To learn how to register an application, see Section 3.6.6.

The following table is an alphabetical listing of 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's 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 has been physically inserted. The Hot Swap state changes from Extracted to OffLine. The Hot Swap driver starts to configure the board on the PCI bus.

HSWEVN_BOARD_OFFLINE

0x40112003

1074864131

The board is in the OffLine state and can be extracted.

HSWEVN_BOARD_READY

0x40112001

1074864129

An inserted board was successfully configured and booted by the OAM service. The state changes to OnLine.

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 a board and notified the OAM service to boot it. The state changes to OnLinePending.

HSWEVN_PCI_CONFIG_FAILED

0x40112007

1074864135

The board transitioned to the OffLine state and the PCI configuration process failed.

HSWEVN_PREPARATION_FAILED

0x40112008

1074864136

The device instance creation or booting failed. The state changes to Failed.

HSWEVN_REMOVAL_REQUESTED

0x40112002

1074864130

A board's ejector handles were opened or extraction was initiated from hsmon. The state changes to OffLinePending.

OAMEVN_ALERT

0x40002001

1073750017

Alert indication. OAM_MSG 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_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 oamStartBoard successful. The event value field contains a reason code indicating the actual results of the board starting attempt.

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 OAM service event handling, refer to Chapter 2.

NMS OAM Reason CodesTop of Page

Three OAM service functions, oamStartBoard, oamTestBoard, and oamStopBoard, are asynchronous functions: each returns a return code indicating whether the invocation was successful or not. Subsequent events indicate whether the function completed or not. Reason codes that arrive with these events indicate whether the function was successful or not.

The following table provides an alphabetical listing of OAM service reason codes.
Reason Code Name

Hex

Decimal

Description

OAM_REASON_FAILED

0x40001001

1073745921

Indicates that a board start, stop, or test attempt failed.

OAM_REASON_FINISHED

0x40001000

1073745920

Indicates that a board was started or stopped successfully, or a board test completed successfully.

For more information about OAM service event handling, refer to Chapter 2.



Table of Contents Index NMS Glossary Previous Page Next Page Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.