PERSISTENT_ISCSI_LOGIN_INFOA Structure

PERSISTENT_ISCSI_LOGIN_INFOA Structure

The PERSISTENT_ISCSI_LOGIN_INFOA structure describes a login session that the Microsoft iSCSI initiator service re-establishes automatically after a machine reboot.

typedef struct _PERSISTENT_ISCSI_LOGIN_INFOA {
CHAR TargetName[MAX_ISCSI_NAME_LEN];
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
    The name of the target to which the initiator will login.

  • IsInformationalSession
    If true, the login session is for informational purposes only and will not lead to an enumeration of the indicated 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 as a result, the system does not load a device driver for it. A management application can still access targets that the system did not enumerate by means of the SendScsiInquiry, SendScsiReportLuns, and SendScsiReadCapacity functions.

    If false, the LUNs on the target are reported to the "Plug and Play" manager to be enumerated.

  • InitiatorInstance
    The name of the initiator through which the login to the target is performed.

  • InitiatorPortNumber
    The port number on the initiator Host Bus Adapter (HBA) through which the session login is established. A value of ISCSI_ANY_INITIATOR_PORT indicates that no particular port on the initiator is specified.

  • TargetPortal
    A structure of type ISCSI_TARGET_PORTALA that describes the portal that the Microsoft iSCSI initiator service uses to log onto the target.

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

    Value Meaning

    ISCSI_SECURITY_FLAG_TUNNEL_MODE_PREFERRED

    When set to 1, indicates that the initiator HBA should establish the TCP/IP connection to the target portal using IPsec tunnel mode.

    ISCSI_SECURITY_FLAG_TRANSPORT_MODE_PREFERRED

    When set to 1, indicates that the initiator HBA should establish the TCP/IP connection to the target portal using IPsec transport mode.

    ISCSI_SECURITY_FLAG_PFS_ENABLED

    When set to 1, indicates that the initiator HBA 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

    When set to 1, indicates that the initiator HBA should establish the TCP/IP connection to the target portal with aggressive mode enabled.

    ISCSI_SECURITY_FLAG_MAIN_MODE_ENABLED

    When set to 1, indicates that the initiator HBA should establish the TCP/IP connection to the target portal with main mode enabled.

    ISCSI_SECURITY_FLAG_IKE_IPSEC_ENABLED

    When set to 1, indicates that the initiator HBA 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

    When set to 1, indicates that the other mask values are valid; otherwise, security flags are not specified.

  • Mappings
    A pointer to a structure of type ISCSI_TARGET_MAPPINGA that contains information about a target and its logical units and the HBAs and buses through which the target is reached. A value of null indicates that this information is not specified.

  • LoginOptions
    A structure of type ISCSI_LOGIN_OPTIONS that holds the options that an initiator uses in the session established to the target.

Remarks

The PERSISTENT_ISCSI_LOGIN_INFOA 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 computer starts.

Requirements

Client

Requires Windows Vista.

Server

Requires Windows Server 2008.

Header

Declared in Iscsidsc.h.

See Also

ReportIScsiPersistentLogins
SendScsiInquiry
SendScsiReportLuns
SendScsiReadCapacity
ISCSI_LOGIN_OPTIONS
ISCSI_TARGET_MAPPINGA
ISCSI_TARGET_PORTALA

Send comments about this topic to Microsoft

Build date: 10/1/2007