oamAddDetectedBoard

Adds a physically detected board to the active configuration. Not currently supported.

Prototype

DWORD oamAddDetectedBoard ( CTAHD ctahd, const char *szName )

Argument

Description

ctahd

[in] Context handle.

szName

[in] Pointer to the name of a board to add.


Return values

Return value

Description

SUCCESS

 

CTAERR_SVR_COMM

Natural Access Server is not running.

OAMERR_ACCESS_DENIED

Function is not supported by this plug-in.

OAMERR_ALREADY_EXISTS

Board szName is already in the database, or one of the detected boards being added has the same PCI bus:slot as a board already in the database.

OAMERR_FILE_WRITE_ERROR

Error writing to database.

OAMERR_NOT_ENOUGH_MEMORY

Memory allocation error.

OAMERR_NOT_FOUND

There are no boards to add. oamDetectBoards has not been called or has found no boards.

OAMERR_SERVER_NOT_RUNNING

Supervisor is shut down.


Details

Use oamAddDetectedBoard to create a managed object for one or more boards automatically detected by oamDetectBoards. Set szName to the name of the detected board to add. To add all detected boards at once, specify NULL as the board name.

When oamAddDetectedBoard is invoked, a new managed object is created on the resource host for the board. A record for the managed object is created in the NMS OAM database on the host containing default keyword settings.

oamAddDetectedBoard cannot add a detected board to the configuration if the board's name, PCI bus:slot location, or both matches that of another board already listed in the NMS OAM database. If oamAddDetectedBoard detects a conflict while attempting to add a single board, it returns OAMERR_ALREADY_EXISTS. If the conflict is detected while oamAddDetectedBoard is adding all boards (szName is NULL), it returns OAMEVN_ALERT_INFO for each failed attempt. However, the function returns SUCCESS if at least one board has successfully been added to the database.

If you direct oamAddDetectedBoard to add all boards (szName is NULL) and oamDetectBoards was not previously invoked or has found no boards, oamAddDetectedBoard returns OAMERR_NOT_FOUND.