Share via


CreateiSCSIProtocolEndpoint method of the CIM_iSCSIConfigurationService class

This method creates an iSCSI Port in the form of an instance of iSCSIProtocolEndpoint. As part of the creation process the iSCSIProtocolEndpoint is 'bound to' the underlying TCP or IP ProtocolEndpoints which are specified as inputs by creating instances of the BindsTo association between the new instance and those instances. In addition, an instance of SAPAvailableForElement is created between the specified SCSIProtocolController and the new instance of iSCSIProtocolEndpoint.

Syntax

uint32 CreateiSCSIProtocolEndpoint(
  [in]  CIM_SCSIProtocolController REF iSCSINode,
  [in]  uint16                         Role,
  [in]  string                         Identifier,
  [in]  CIM_ProtocolEndpoint       REF NetworkPortals[],
  [out] CIM_iSCSIProtocolEndpoint  REF iSCSIPort
);

Parameters

iSCSINode [in]

The SCSIProtocolController instance representing the iSCSI Node that will contain the iSCSI Port.

Role [in]

For iSCSI, each iSCSIProtocolEndpoint must act as either a target or an initiator endpoint. This property indicates which role this iSCSIProtocolEndpoint implements.

Initiator (2)

Target (3)

Identifier [in]

If this is an Initiator Port, Identifier MUST contain the ISID, if this is a Target Port, Identifier MUST contain the Target Portal Group Tag (TGPT). Each iSCSIProtocolEndpoint (iSCSI port) associated to a common SCSIProtocolController (iSCSI node) must have a unique Identifier. This field is a string that contains 12 hexadecimal digits. If the property IdentifierSelectionSupported in class iSCSIConfigurationCapabilities is false, this parameter MUST be set to NULL.

NetworkPortals [in]

Array of References to either TCPProtocolEndpoints representing Target NetworkPortals or IPProtocolEndpoint instances representing Initiator NetworkPortals. If TCPProtocolEndpoints are supplied each MUST be in turn associated to an instance of IPProtocolEndpoint via a BindsTo association in order to provide the Target Network Portal functionality. The selected Portal endpoints MUST be from the same SystemSpecificCollection, which represents a Portal Group.

iSCSIPort [out]

A reference to the new iSCSIProtocolEndpoint that is created.

Return value

Success (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

DMTF Reserved (6 4095)

SCSIProtocolController Non-existent (4096)

Role Not Supported By Specified SCSIProtocolController (4097)

Identifier In Use, Not Unique (4098)

Identifier Selection Not Supported (4099)

ProtocolEndpoint Non-Existent (4100)

TCPProtocolEndpoint Not Bound To Underlying IPProtocolEndpoint (4101)

TCPProtocolEndpoint In Use By Other iSCSIProtocolEndpoint In Same Target SCSIProtocolController (4102)

ProtocolEndpoints Not From Same Endpoint Collection (4103)

Method Reserved (4104 32767)

Vendor Specific (32768 65535)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012 R2
Namespace
Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll

See also

CIM_iSCSIConfigurationService