MSIscsiInitiator_TargetLoginOptions class

This MSIscsiInitiator_TargetLoginOptions structure contains the target login options.

Syntax

class MSIscsiInitiator_TargetLoginOptions
{
  uint32                             Version;
  ISCSI_LOGIN_OPTIONS_INFO_SPECIFIED InformationSpecified;
  ISCSI_LOGIN_FLAGS                  LoginFlags;
  ISCSI_AUTH_TYPES                   AuthType;
  uint32                             HeaderDigest;
  uint32                             DataDigest;
  uint32                             MaximumConnections;
  uint32                             DefaultTime2Wait;
  uint32                             DefaultTime2Retain;
  uint8                              Username[];
  uint8                              Password[];
};

Members

The MSIscsiInitiator_TargetLoginOptions class has these types of members:

• Properties

Properties

The MSIscsiInitiator_TargetLoginOptions class has these properties.

AuthType

Data type: ISCSI_AUTH_TYPES

Access type: Read/write

An ISCSI_AUTH_TYPES enumeration that indicates the authentication method used to establish a connection.

DataDigest

Data type: uint32

Access type: Read/write

A ISCSI_DIGEST_TYPES value that indicates the method that the Initiator uses to verify the integrity of the data digest in a logon PDU.

DefaultTime2Retain

Data type: uint32

Access type: Read/write

The maximum time, in seconds, to reassign a connection after the initial wait that is indicated in DefaultTime2Wait has elapsed. The Initiator and Target negotiate to determine this value.

DefaultTime2Wait

Data type: uint32

Access type: Read/write

The minimum time to wait, in seconds, before the Initiator attempts to reconnect or reassign a connection (or task) that has been dropped after an unexpected connection termination or reset. The Initiator and Target negotiate to determine this value.

HeaderDigest

Data type: uint32

Access type: Read/write

A ISCSI_DIGEST_TYPES value that indicates the method that the Initiator uses to verify the integrity of the header digest in a logon PDU.

InformationSpecified

Data type: ISCSI_LOGIN_OPTIONS_INFO_SPECIFIED

Access type: Read-only

A bitmap that indicates which members of this structure contain valid dataLoginFlags.

Value	Meaning
ISCSI_LOGIN_OPTIONS_HEADER_DIGEST	The HeaderDigest member specifies the type of digest that is used to guarantee the integrity of header data.
ISCSI_LOGIN_OPTIONS_DATA_DIGEST	The DataDigest member specifies the type of digest that is used to guarantee the integrity of header data.
ISCSI_LOGIN_OPTIONS_MAXIMUM_CONNECTIONS	The MaximumConnections member specifies the maximum number of connections that are allowed in the iSCSI session.
ISCSI_LOGIN_OPTIONS_DEFAULT_TIME_2_WAIT	The DefaultTime2Wait member specifies the minimum time to wait, in seconds, before the initiator attempts to reconnect or reassign a connection that was dropped.
ISCSI_LOGIN_OPTIONS_AUTH_TYPE	The AuthType member specifies the type of authentication that establishes the logon session.
ISCSI_LOGIN_OPTIONS_USERNAME	The user name to be used during logon.
ISCSI_LOGIN_OPTIONS_PASSWORD	The password to be used during logon.

 

LoginFlags

Data type: ISCSI_LOGIN_FLAGS

Access type: Read/write

Defines the login process. Possible values are defined by the ISCSI_LOGIN_OPTIONS structure.

Value	Meaning
ISCSI_LOGIN_FLAG_REQUIRE_IPSEC	The logon session must use the IPsec protocol.
ISCSI_LOGIN_FLAG_MULTIPATH_ENABLED	Multipathing software is installed, so the iSCSI initiator service allows multiple sessions to the same target.
ISCSI_LOGIN_FLAG_RESERVED1	Microsoft internal use only.
ISCSI_LOGIN_FLAG_ALLOW_PORTAL_HOPPING	If a target portal is not available for login, the initiator can “hop” through the list of target portals that it discovered and that can be used for login operations. That is, the initiator will continue to try the list of portals that are available until it finds one that can be used for login, so it can then log in to the available target portal.
ISCSI_LOGIN_FLAG_RADIUS_RESPONSE	Use RADIUS to generate CHAP response.
ISCSI_LOGIN_FLAG_RADIUS_VERIFICATION	Use RADIUS to verify CHAP response.

 

MaximumConnections

Data type: uint32

Access type: Read/write

A value between 1 and 65535 that specifies the maximum number of connections to target devices that can be associated with a single logon session. A value of 0 indicates that there is no limit to the number of connections.

Password

Data type: uint8 array

Access type: Read/write

The password used for login.

Username

Data type: uint8 array

Access type: Read/write

The user name used for login.

Version

Data type: uint32

Access type: Read-only

The ISCSI_LoginOptions version information.

Requirements

Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Namespace	Root\WMI
MOF	Iscsidsc.mof