HBA_SetRNIDMgmtInfo Subroutine

Purpose

Sends a SCSI SET RNID command to a remote port of the end device.

Library

Common Host Bus Adapter Library (libHBAAPI.a)

Syntax

#include <sys/hbaapi.h>

HBA_STATUS HBA_SetRNIDMgmtInfo (handle, info)
HBA_HANDLE handle;
HBA_MGMTINFO info;

Description

The HBA_SetRNIDMgmtInfo subroutine sends a SCSI SET RNID (Request Node Identification Data) command with the SCIOLCHBA operation as its argument. This is done through a call to ioctl. The arg parameter for the SCIOLCHBA operation is the address of a scsi_chba structure. This structure is defined in the /usr/include/sys/scsi_buf.h file. The scsi_chba parameter block allows the caller to select the SET RNID command to be sent to the adapter. The info structure stores the RNID data to be set. The info structure is defined in the /usr/include/sys/hbaapi.h file. The structure includes:
  • wwn
  • unittype
  • PortId
  • NumberOfAttachedNodes
  • IPVersion
  • UDPort
  • IPAddress
  • reserved
  • TopologyDiscoveryFlags

If successful, the SET RNID data in info is sent to the adapter.

Parameters

Item Description
handle Specifies the open file descriptor obtained from a successful call to the open subroutine.
info Specifies the structure containing the information to be set or received from the RNID command

Return Values

Upon successful completion, the HBA_SetRNIDMgmtInfo subroutine returns a value of HBA_STATUS_OK, or a value of 0. If unsuccessful, a value of HBA_STATUS_ERROR, or a 1 is returned.

Error Codes

The Storage Area Network Host Bus Adapter API subroutines return the following error codes:
Item Description
HBA_STATUS_OK A value of 0 on successful completion.
HBA_STATUS_ERROR A value of 1 if an error occurred.
HBA_STATUS_ERROR_INVALID_HANDLE A value of 3 if there was an invalid file handle.