HBA_SendCTPassThruV2 routine

Article
10/05/2017

The HBA_SendCTPassThruV2 routine sends a common transport (CT) pass-through command through the indicated port.

Syntax

HBA_STATUS HBA_API HBA_SendCTPassThruV2(
  _In_    HBA_HANDLE HbaHandle,
  _In_    HBA_WWN    HbaPortWWN,
  _In_    void       *pReqBuffer,
  _In_    HBA_UINT32 ReqBufferSize,
  _Out_   void       *pRspBuffer,
  _Inout_ HBA_UINT32 *RspBufferSize
);

Parameters

HbaHandle [in]
Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA that will route the CT command. The HBA routes the CT command to the server that runs the service requested by the CT command.
HbaPortWWN [in]
Contains the worldwide name (WWN) of the port from which to issue the command. For a definition of worldwide names, see the T11 committee's specification for Fibre Channel HBA API.
pReqBuffer [in]
Pointer to a buffer that contains the full frame of the common transport command in big-endian format.
ReqBufferSize [in]
Indicates the size of the buffer pointed to by pReqBuffer:
pRspBuffer [out]
Pointer to a buffer that contains the payload data from the reply to the common transport command in big-endian (wire) format.
RspBufferSize [in, out]
On input, indicates the size, in bytes, of the buffer pointed to by pRspBuffer. On return, this member indicates the size, in bytes, of the response data.

Return value

The HBA_SendCTPassThruV2 routine returns a value of type HBA_STATUS that indicates the status of the HBA. If the HBA successfully delivers the command to the destination service, and the service executes the command and successfully returns the results, the HBA_SendCTPassThru routine returns a value of HBA_STATUS_OK. If the command does not succeed, this routine returns an appropriate error code of type HBA_STATUS.

Remarks

The HBA_SendCTPassThruV2 library routine is identical to the HBA_SendCTPassThru routine, except that HBA_SendCTPassThruV2 allows the caller to specify the port through which the CT command will be issued.

The HBA_SendCTPassThruV2 library routine serves a purpose very similar to the SendCTPassThru WMI method.

A CT command can request services that distribute encryption keys, IP addresses, time stamps, names, aliases, fabric configuration, and security policies. For a complete list of the service types that can be specified in a CT command, see the Fibre Channel Generic Services - 4 (FC-GS-4) specification published by the ANSI committee.

Requirements

Target platform	Desktop
Header	Hbaapi.h (include Hbaapi.h)
Library	Hbaapi.lib
DLL	Hbaapi.dll

Share via