PERSISTENT_ISCSI_LOGIN_INFOA structure (iscsidsc.h)

  • Article

The PERSISTENT_ISCSI_LOGIN_INFO structure contains information that describes a login session established by the Microsoft iSCSI initiator service after the machine boots up.

Syntax

typedef struct {
  CHAR                   TargetName[MAX_ISCSI_NAME_LEN + 1];
  BOOLEAN                IsInformationalSession;
  CHAR                   InitiatorInstance[MAX_ISCSI_HBANAME_LEN];
  ULONG                  InitiatorPortNumber;
  ISCSI_TARGET_PORTALA   TargetPortal;
  ISCSI_SECURITY_FLAGS   SecurityFlags;
  PISCSI_TARGET_MAPPINGA Mappings;
  ISCSI_LOGIN_OPTIONS    LoginOptions;
} PERSISTENT_ISCSI_LOGIN_INFOA, *PPERSISTENT_ISCSI_LOGIN_INFOA;

Members

TargetName[MAX_ISCSI_NAME_LEN + 1]

A string representing the name of the target the initiator will login to.

IsInformationalSession

If set TRUE, the login session is for informational purposes only and will not result in the enumeration of the specified target on the local computer. For an informational login session, the LUNs on the target are not reported to the Plug and Play Manager and the device drivers for the target are not loaded.

A management application can still access targets not enumerated by the system via the SendScsiInquiry, SendScsiReportLuns, and SendScsiReadCapcity functions.

If set FALSE, the LUNs on the target are reported to the Plug and Play manager for enumeration.

InitiatorInstance[MAX_ISCSI_HBANAME_LEN]

A string representing the name of the initiator used to login to the target.

InitiatorPortNumber

The port number of the Host-Bus Adapter (HBA) through which the session login is established. A value of ISCSI_ANY_INITIATOR_PORT indicates that a port on the initiator is not currently specified.

TargetPortal

A ISCSI_TARGET_PORTAL structure that describes the portal used by the Microsoft iSCSI initiator service to log on to the target.

SecurityFlags

A bitmap that defines the security characteristics of a login connection.

Value Meaning
ISCSI_SECURITY_FLAG_TUNNEL_MODE_PREFERRED
 The Host Bus Adapter (HBA) initiator should establish the TCP/IP connection to the target portal using IPsec tunnel mode.
ISCSI_SECURITY_FLAG_TRANSPORT_MODE_PREFERRED
 The HBA initiator should establish the TCP/IP connection to the target portal using IPsec transport mode.
ISCSI_SECURITY_FLAG_PFS_ENABLED
 The HBA initiator should establish the TCP/IP connection to the target portal with Perfect Forward Secrecy (PFS) mode enabled if IPsec is required.
ISCSI_SECURITY_FLAG_AGGRESSIVE_MODE_ENABLED
 The HBA initiator should establish the TCP/IP connection to the target portal with aggressive mode enabled.
ISCSI_SECURITY_FLAG_MAIN_MODE_ENABLED
 The HBA initiator should establish the TCP/IP connection to the target portal with main mode enabled.
ISCSI_SECURITY_FLAG_IKE_IPSEC_ENABLED
 The HBA initiator should establish the TCP/IP connection to the target portal using IKE/IPsec protocol. If not set then IPsec is not required to login to the target.
ISCSI_SECURITY_FLAG_VALID
 The other mask values are valid; otherwise, security flags are not specified.

Mappings

A pointer to a ISCSI_TARGET_MAPPING structure that contains information about a target, its logical units, HBAs, and buses through which it is reached.

LoginOptions

An ISCSI_LOGIN_OPTIONS structure that contains the persistent login characteristics.

Remarks

The PERSISTENT_ISCSI_LOGIN_INFO structure is used in conjunction with the ReportIScsiPersistentLogins function to retrieve the list of targets for which the Microsoft Discovery Service (iscsiexe.exe) automatically opens a login session after the machine boots up.

Note

The iscsidsc.h header defines PERSISTENT_ISCSI_LOGIN_INFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header iscsidsc.h

See also

ISCSI_LOGIN_OPTIONS

ISCSI_TARGET_PORTAL

ReportIScsiPersistentLogins

SendScsiInquiry

SendScsiReadCapacity

SendScsiReportLuns