Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSISCSITARGET_iSCSISessionSettings class

Contains the default settings for an iSCSI Session. These properties are used as the starting position for login negotiations between initiator and target nodes.

Depending on a given implementation, an instance of MSISCSITARGET_iSCSISessionSettings is associated by MSISCSITARGET_ElementSettingData to one or more instances of MSISCSITARGET_iSCSIProtocolEndpoint, MSISCSITARGET_SCSIProtocolController, or CIM_ComputerSystem.

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

Syntax

class MSISCSITARGET_iSCSISessionSettings : CIM_iSCSISessionSettings
{
  string  SystemName;
  uint32  MaxConnectionsPerSession = 1;
  boolean InitialR2TPreference = true;
  boolean ImmediateDataPreference = TRUE;
  uint32  MaxOutstandingR2T = 1;
  uint32  MaxUnsolicitedFirstDataBurstLength = 65536;
  uint32  MaxDataBurstLength = 262144;
  boolean DataSequenceInOrderPreference = true;
  boolean DataPDUInOrderPreference = true;
  uint32  DefaultTimeToWaitPreference = 2;
  uint32  DefaultTimeToRetainPreference = 20;
  uint32  ErrorRecoveryLevelPreference = 0;
  string  InstanceID;
  string  ElementName;
  string  Caption;
  string  Description;
};

Members

The MSISCSITARGET_iSCSISessionSettings class has these types of members:

Properties

The MSISCSITARGET_iSCSISessionSettings class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates a short textual description of the object.

This property is inherited from the CIM_ManagedElement class.

DataPDUInOrderPreference
Data type: boolean
Access type: Read/write
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDataPDUInOrder")

Specifies the DataPDUInOrder property preference of this node. Set to True, if data PDUs within sequences must be at continuously increasing addresses, with no gaps or overlay between PDUs. Set to false, if iSCSI data PDUs within sequences can be in any order.

This property is inherited from the CIM_iSCSISessionSettings class.

DataSequenceInOrderPreference
Data type: boolean
Access type: Read/write
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDataSequenceInOrder")

Specifies the DataSequenceInOrder property preference for this node. If set to True, the data protocol data unit (PDU) sequences must be transferred by using continuously increasing offsets, except during error recovery. If set to false, the iSCSI data PDU sequences can be transferred in any order.

This property is inherited from the CIM_iSCSISessionSettings class.

DefaultTimeToRetainPreference
Data type: uint32
Access type: Read/write
Qualifiers: MinValue (0) , MaxValue (3600) , Units ("Seconds") , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Retain")

Specifies the DefaultTime2Retain property preference of this node. This property specifies the maximum time in seconds that an active iSCSI task assignment is still possible after an unexpected connection termination or a connection reset. This time is in addition to the initial wait time that is specified by the DefaultTimeToWait property .

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

DefaultTimeToWaitPreference
Data type: uint32
Access type: Write-only
Qualifiers: MinValue (0) , MaxValue (3600) , Units ("Seconds") , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Wait")

Specifies the DefaultTimeToWait property preference of this node. This value specifies the minimum time in seconds to wait before the session attempts an explicit/implicit logout or active iSCSI task reassignment after an unexpected connection termination or a connection reset.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

Description
Data type: string
Access type: Read-only

Indicates a textual description of the object.

This property is inherited from the CIM_ManagedElement class.

ElementName
Data type: string
Access type: Read-only
Qualifiers: Required, Override

Indicates the user-friendly name for this instance of MSISCSITARGET_iSCSISessionSettings. The ElementName does not have to be unique within a namespace.

This property is inherited from the CIM_SettingData class.

ErrorRecoveryLevelPreference
Data type: uint32
Access type: Read/write
Qualifiers: MinValue (0) , MaxValue (255) , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeErrorRecoveryLevel")

Specifies the ErrorRecoveryLevel preference of this node. Only levels 0 through 2 are valid at this time. The MaxValue is designed to accommodate future error recovery levels.

Higher error recovery levels imply support in addition to support for the lower error level functions. In other words, error level 2 implies support for levels 0 through 1, because those functions are subsets of error level 2. The possible values are.

0

1

2

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

ImmediateDataPreference
Data type: boolean
Access type: Read/write
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeImmediateData")

Specifies the ImmediateData property preference for this node. If set to True, the node requests the property to be True, but accepts false. If set to false, the node requires the property to be false.

This property is inherited from the CIM_iSCSISessionSettings class.

InitialR2TPreference
Data type: boolean
Access type: Read/write
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeInitialR2T")

Specifies whether the initiator must wait for a request-to-transmit (R2T) signal before it transmits. If set to True, the iSCSI session InitialR2T property must be True. If set to false, the session tries to negotiate a value of false for the InitialR2T property, but accepts True.

This property is inherited from the CIM_iSCSISessionSettings class.

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

Uniquely and opaquely identifies an instance of this class within the scope of the instantiating namespace.

Important  In order to ensure uniqueness within the namespace, the value of InstanceID should be constructed in the following pattern:

OrgID:LocalID

OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that defines the InstanceID, or must be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefor the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern is not used, the defining entity must assure that the resultant InstanceID is not re-used across any InstanceID properties that are produced by this or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from the CIM_SettingData class.

MaxConnectionsPerSession
Data type: uint32
Access type: Read/write
Qualifiers: MinValue (1) , MaxValue (65535) , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxConnections")

Specifies the maximum number of connections that are allowed in each session to or from this node or in both directions.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

MaxDataBurstLength
Data type: uint32
Access type: Write-only
Qualifiers: MinValue (512) , MaxValue (16777215) , Units ("Bytes") , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxBurstLength")

Specifies the maximum number of bytes which can be sent within a single sequence of Data-In or Data-Out protocol data units (PDUs).

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

MaxOutstandingR2T
Data type: uint32
Access type: Read/write
Qualifiers: MinValue (1) , MaxValue (65535) , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxOutstandingR2T")

Specifies the maximum number of outstanding request-to-transmit (R2T) signals per iSCSI task within this session.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) iSCSI Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_iSCSISessionSettings class.

MaxUnsolicitedFirstDataBurstLength
Data type: uint32
Access type: Read/write
Qualifiers: MinValue (512) , MaxValue (16777215) , Units ("Bytes") , MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeFirstBurstLength")

Specifies the maximum length that is supported for unsolicited data that are sent to or from this node.

This property is inherited from the CIM_iSCSISessionSettings class.

SystemName
Data type: string
Access type: Read-only

Indicates the computer system name.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

Root\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

See also

iSCSI Target Server Reference
CIM_ManagedElement
CIM_SettingData

 

 

Show:
© 2015 Microsoft