WT_Host class

Article
05/31/2018

Represents an iSCSI target.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class WT_Host
{
  string     HostName;
  boolean    Enabled;
  string     Description;
  string     TargetIQN;
  sint32     Status;
  datetime   LastLogIn;
  uint32     IdleDuration;;
  boolean    EnableCHAP;
  string     CHAPUserName;
  string     CHAPSecret;
  boolean    EnableReverseCHAP;
  string     ReverseCHAPUserName;
  string     ReverseCHAPSecret;
  uint32     TargetMaxRecvDataSegmentLength;
  uint32     TargetFirstBurstLength;
  uint32     TargetMaxBurstLength;
  uint32     NumRecvBuffers;
  boolean    EnforceIdleTimeoutDetection;
  string     ResourceGroup;
  WT_Session Sessions[];
  string     Guid;
  uint32     MaxConnectionsPerSession;
  boolean    InitialR2TPreference;
  boolean    ImmediateDataPreference;
  uint32     MaxOutstandingR2T;
  boolean    DataSequenceInOrderPreference;
  boolean     DataPduInOrderPreference;
  uint32     DefaultTime2WaitPreference;
  uint32     DefaultTime2RetainPreference;
  uint32     ErrorRecoveryLevelPreference;
  uint16     PrimaryHeaderDigestMethod;
  uint16     PrimaryDataDigestMethod;
  uint16     SecondaryHeaderDigestMethod;
  uint16     SecondaryDataDigestMethod;
  boolean    RequestingMarkersOnReceive;
  uint16     PrimaryAuthenticationMethod;
  uint16     SecondaryAuthenticationMethod;
};

Members

The WT_Host class has these types of members:

Methods
Properties

Methods

The WT_Host class has these methods.

Method	Description
AddWTDisk	Assigns the specified virtual disk to the target.
NewHost	Creates a new iSCSI target using the specified target name.
RemoveAllWTDisks	Removes all virtual disks from the iSCSI target.
RemoveWTDisk	Removes the specified virtual disk from the iSCSI target.
SetWTDiskLunMapping	Sets the SCSI Logical Unit Number (LUN) of the specified virtual disk.

Properties

The WT_Host class has these properties.

DataPduInOrderPreference

Data type: boolean
Access type: Read-only

Indicates whether data PDUs within sequences are preferred to be at continuously increasing addresses.

CHAPSecret

Data type: string
Access type: Read/write

A string, 12-16 characters in length, that indicates whether a CHAP secret exists. For security reasons, this property value will be encrypted.

CHAPUserName

Data type: string
Access type: Read/write

The CHAP username, typically the initiator IQN.

DataSequenceInOrderPreference

Data type: boolean
Access type: Read-only

Indicates whether data sequences are preferred to be transferred with continuously non-decreasing sequence offsets.

DefaultTime2RetainPreference

Data type: uint32
Access type: Read-only

Preferred minimum time, in seconds, to wait before attempting an explicit or implicit logout or an active task reassignment after an unexpected connection termination or a connection reset.

DefaultTime2WaitPreference

Data type: uint32
Access type: Read-only

Preferred maximum time, in seconds after an initial wait (Time2Wait), before which an active task reassignment is still possible after an unexpected connection termination or a connection reset.

Description

Data type: string
Access type: Read/write

A user-friendly description for the target.

EnableCHAP

Data type: boolean
Access type: Read/write

Indicates whether CHAP authentication is enabled for this target. CHAP authentication is the process of the target validating the identity of the initiator.

Enabled

Data type: boolean
Access type: Read/write

Indicates whether or not this iSCSI target is available for access by initiators. If enabled, initiators can discover and login to the target.

Note

Existing initiators remain logged into the target when an iSCSI target is disabled.

EnableReverseCHAP

Data type: boolean
Access type: Read/write

Indicates whether reverse CHAP authentication is enabled for this target. Reverse CHAP authentication is the process of the initiator validating the identity of the target.

EnforceIdleTimeoutDetection

Data type: boolean
Access type: Read/write

Indicates whether Microsoft iSCSI Target Server should periodically contact the initiator to see if it is still connected.

ErrorRecoveryLevelPreference

Data type: uint32
Access type: Read-only

Preferred error recovery level.

Guid

Data type: string
Access type: Read-only

Unique identifier of the iSCSI target.

HostName

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

A name that uniquely identifies the iSCSI target within the iSCSI target server. This is not the IQN (iSCSI Qualified Name), but a Microsoft iSCSI Target Server-specific identifier. . It is recommended that the initiator’s NetBIOS name be used as the host name for easier identification.

IdleDuration;

Data type: uint32
Access type: Read-only

The idle duration, in seconds, since the most recent session disconnected from the current host.

ImmediateDataPreference

Data type: boolean
Access type: Read-only

Indicates whether immediate data is preferred.

InitialR2TPreference

Data type: boolean
Access type: Read-only

Indicates whether an initial R2T request is preferred.

LastLogIn

Data type: datetime
Access type: Read-only

The date and time when the last initiator successfully logged on to the Microsoft iSCSI Target Server.

MaxConnectionsPerSession

Data type: uint32
Access type: Read-only

The maximum number of connections allowed within an iSCSI session.

MaxOutstandingR2T

Data type: uint32
Access type: Read-only

The maximum number of outstanding R2T requests that are supported.

NumRecvBuffers

Data type: uint32
Access type: Read/write

Number of receive buffers that the Microsoft iSCSI Target Server will use when processing incoming data. It is recommended that you do not change this value. Improperly setting this value can lead to excessive memory usage and performance degradation.

PrimaryAuthenticationMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (None, SRP, CHAP, Kerberos), ValueMap (2, 3, 4, 5)

Primary authentication method.

PrimaryDataDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (Other, None, CRC32C), ValueMap (1, 2, 3)

Primary data digest method.

PrimaryHeaderDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (Other, None, CRC32C), ValueMap (1, 2, 3)

Primary header digest method.

RequestingMarkersOnReceive

Data type: boolean
Access type: Read-only

Indicates whether to request markers on receive.

ResourceGroup

Data type: string
Access type: Read-only

Name of the cluster group that the iSCSI target resource belongs to. If the Microsoft iSCSI Target Server Service is not running on a Microsoft Failover Cluster, this property is an empty string.

ReverseCHAPSecret

Data type: string
Access type: Read/write

A string, 12-16 characters in length, that indicates whether a reverse CHAP secret exists. For security reasons, this property value will be encrypted.

ReverseCHAPUserName

Data type: string
Access type: Read/write

The reverse CHAP user name, typically the target IQN.

SecondaryAuthenticationMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (None, SRP, CHAP, Kerberos), ValueMap (2, 3, 4, 5)

Secondary authentication method.

SecondaryDataDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (Other, None, CRC32C), ValueMap (1, 2, 3)

Secondary data digest method.

SecondaryHeaderDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: Values (Other, None, CRC32C), ValueMap (1, 2, 3)

Secondary header digest method.

Sessions

Data type: WT_Session array
Access type: Read-only

List of sessions that are established between initiators and the iSCSI target provided by the Microsoft iSCSI Target Server service.

Status

Data type: sint32
Access type: Read-only
Qualifiers: Values (Not Connected, Connected), ValueMap (0, 1)

Indicates whether the target is currently connected to any initiators.

TargetFirstBurstLength

Data type: uint32
Access type: Read/write

iSCSI parameter that indicates the amount of data, in bytes, that the Microsoft iSCSI Target Server can receive before soliciting the initiator. Do not change this value unless you have a thorough understanding of the iSCSI standard. Improperly setting this value can lead to excessive memory usage and performance degradation.

TargetIQN

Data type: string
Access type: Read/write

The target iSCSI Qualified Name (IQN) of this target.

TargetMaxBurstLength

Data type: uint32
Access type: Read/write

An iSCSI parameter that indicates the amount of data, in bytes, that Microsoft iSCSI Target Server can receive at once. Do not change this value unless you have a thorough understanding of the iSCSI standard. Improperly setting this value can lead to excessive memory usage and performance degradation.

TargetMaxRecvDataSegmentLength

Data type: uint32
Access type: Read/write

An iSCSI parameter that indicates the amount of data, in bytes, that the target can process in each Protocol Data Unit (PDU). Do not change this value unless you have a thorough understanding of the iSCSI standard. Improperly setting this value can lead to excessive memory usage and performance degradation.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Wmi
MOF	WmiWtProvider.mof
DLL	WtWmiProv.dll

Share via