MSFT_iSCSISession class

Article
05/31/2018

Represents an iSCSI session.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

class MSFT_iSCSISession
{
  string  SessionIdentifier;
  string  InitiatorSideIdentifier;
  string  TargetSideIdentifier;
  uint32  NumberOfConnections;
  string  TargetNodeAddress;
  string  InitiatorPortalAddress;
  boolean IsDataDigest;
  boolean IsHeaderDigest;
  string  AuthenticationType;
  string  InitiatorNodeAddress;
  string  InitiatorInstanceName;
  boolean IsConnected;
  boolean IsPersistent;
  boolean IsDiscovered;
};

Members

The MSFT_iSCSISession class has these types of members:

Methods
Properties

Methods

The MSFT_iSCSISession class has these methods.

Method	Description
Register	Registers the iSCSI session to be persistent.
SetCHAPSecret	Sets a CHAP secret key for use with iSCSI initiator connections.
Unregister	Unregisters the iSCSI session so that it is no longer persistent.

Properties

The MSFT_iSCSISession class has these properties.

AuthenticationType

Data type: string
Access type: Read-only

The type of authentication to use when logging into the target.

InitiatorInstanceName

Data type: string
Access type: Read-only

The name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal. If no instance name is specified, the iSCSI initiator service chooses the initiator instance.

InitiatorNodeAddress

Data type: string
Access type: Read-only

The IQN of the initiator.

InitiatorPortalAddress

Data type: string
Access type: Read-only

The IP address or DNS name associated with the initiator portal.

InitiatorSideIdentifier

Data type: string
Access type: Read-only

The initiatior side identifier.

IsConnected

Data type: boolean
Access type: Read-only

If true, there is an active connection to the target.

IsDataDigest

Data type: boolean
Access type: Read-only

If true, the initiator should enable the session to use an iSCSI data digest scheme when logging into the target portal. Otherwise, the data digest setting is determined by the initiator kernel mode driver.

IsDiscovered

Data type: boolean
Access type: Read-only

If true, iSCSI discovery has been performed against the target.

IsHeaderDigest

Data type: boolean
Access type: Read-only

If true, the initiator should enable the session to use a header digest scheme when logging into the target portal. Otherwise, the header digest setting is determined by the initiator kernel mode driver.

IsPersistent

Data type: boolean
Access type: Read-only

If true, the session is persistent and will be reestablished when the computer is restarted.

NumberOfConnections

Data type: uint32
Access type: Read-only

The number of iSCSI connections in this session.

SessionIdentifier

Data type: string
Access type: Read-only
Qualifiers: Key

The session identifier.

TargetNodeAddress

Data type: string
Access type: Read-only

The iSCSI qualified name (IQN) of the target.

TargetSideIdentifier

Data type: string
Access type: Read-only

The target side identifier.

Requirements


Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Microsoft\Windows\Storage
MOF	Iscsiwmiv2.mof