SM_SendRPS function

Article
12/15/2021

The SM_SendRPS WMI method sends a read port status block (RPS) request to the indicated port or domain controller.

Syntax

void SM_SendRPS(
   [in, HBAType("HBA_WWN")] uint8              PortWWN[8],
   [in, HBAType("HBA_WWN")] uint8              AgentWWN[8],
   [in, HBAType("HBA_WWN")] uint8              ObjectWWN[8],
   [in] uint32                                 AgentDomain,
   [in] uint32                                 ObjectPortNumber,
   [in] uint32                                 InRespBufferMaxSize,
   [out, HBA_STATUS_QUALIFIERS] HBA_STATUS     HBAStatus,
   [out] uint32                                TotalRespBufferSize,
   [out] uint32                                OutRespBufferSize,
   [out, WmiSizeIs("OutRespBufferSize")] uint8 RespBuffer[]
);

Parameters

PortWWN
A worldwide name (WWN) for the local port through which the RPS command is sent. This information is delivered to the miniport driver in the PortWWN member of a SM_SendRPS_IN structure.

AgentWWN
A worldwide name (WWN) for the port that is to be queried for the status of the port that is indicated by ObjectWWN. This information is delivered to the miniport driver in the AgentWWN member of a SM_SendRPS_IN structure.

ObjectWWN
The worldwide name (WWN) of the port for which port status is to be returned. This information is delivered to the miniport driver in the ObjectWWN member of a SM_SendRPS_IN structure.

AgentDomain
The domain number of the domain controller to be queried for the status of the port that is indicated by ObjectWWN. This information is delivered to the miniport driver in the AgentDomain member of a SM_SendRPS_IN structure.

ObjectPortNumber
The worldwide name (WWN) of the port for which port status is to be returned. This information is delivered to the miniport driver in the ObjectPortNumber member of a SM_SendRPS_IN structure.

InRespBufferMaxSize
The maximum size of the response buffer.

HBAStatus
The status of the operation. For a list of allowed values and their descriptions, see HBA_STATUS. The miniport driver returns this information in the HBAStatus member of a SendRPL_OUT structure.

TotalRespBufferSize
The size, in bytes, of the results of the RPS command. The miniport driver returns this information in the TotalRespBufferSize member of a SM_SendRPS_OUT structure.

OutRespBufferSize
The size, in bytes, of the data that was actually retrieved. The miniport driver returns this information in the OutRespBufferSize member of a SM_SendRPL_OUT structure.

RespBuffer
The results of the RPS command. The miniport driver returns this information in the RespBuffer member of a SM_SendRPS_OUT structure.

Return value

Not applicable to WMI methods.

Remarks

This WMI method belongs to the MS_SM_FabricAndDomainManagementMethods WMI Class.

Requirements

Target platform	Desktop
Header	Hbapiwmi.h