Share via

CIM_iSCSISessionSettings class

  • Article

The default negotiation settings for an iSCSI Session. These properties are used as the starting position for login negotiations between initiator and target nodes. The properties describing the resulting outcome of the login negotiation are in the iSCSISession class. Depending on a given implementation an instance of iSCSISessionSettings will be associated by ElementSettingData to one or more instances of iSCSIProtocolEndpoint, SCSIProtocolController, or ComputerSystem.

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

Syntax

[Abstract, Version("2.11.0"), UMLPackagePath("CIM::Network::iSCSI")]
class CIM_iSCSISessionSettings : CIM_SettingData
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  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;
};

Members

The CIM_iSCSISessionSettings class has these types of members:

Properties

The CIM_iSCSISessionSettings class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

DataPDUInOrderPreference

Data type: boolean

Access type: Read/write

Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDataPDUInOrder"), ModelCorrespondence ("CIM_iSCSISession.DataPDUInOrder")

The DataPDUInOrder preference of this node. False (=No) indicates that iSCSI data PDUs within sequences MAY be in any order. True (=Yes) indicates that data PDUs within sequences MUST be at continuously increasing addresses, with no gaps or overlay between PDUs.

DataSequenceInOrderPreference

Data type: boolean

Access type: Read/write

Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDataSequenceInOrder"), ModelCorrespondence ("CIM_iSCSISession.DataSequenceInOrder")

The DataSequenceInOrder preference of this node. False (=No) indicates that iSCSI data PDU sequences MAY be transferred in any order. True (=Yes) indicates that data PDU sequences MUST be transferred using continuously increasing offsets, except during error recovery.

DefaultTimeToRetainPreference

Data type: uint32

Access type: Read/write

Qualifiers: Units ("Seconds"), MinValue (0), MaxValue (3600), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Retain"), ModelCorrespondence ("CIM_iSCSISession.DefaultTimeToRetain")

The DefaultTime2Retain preference of this node. This is the maximum time, in seconds after an initial wait (Time2Wait), before which an active iSCSI task reassignment is still possible after an unexpected connection termination or a connection reset.

DefaultTimeToWaitPreference

Data type: uint32

Access type: Read/write

Qualifiers: Units ("Seconds"), MinValue (0), MaxValue (3600), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Wait"), ModelCorrespondence ("CIM_iSCSISession.DefaultTimeToWait")

The DefaultTime2Wait preference of this node. This is the minimum time, in seconds, to wait before attempting an explicit/implicit logout or active iSCSI task reassignment after an unexpected connection termination or a connection reset.

Description

Data type: string

Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

Qualifiers: Required

The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)

This property is inherited from CIM_SettingData.

ErrorRecoveryLevelPreference

Data type: uint32

Access type: Read/write

Qualifiers: MinValue (0), MaxValue (255), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeErrorRecoveryLevel"), ModelCorrespondence ("CIM_iSCSISession.ErrorRecoveryLevel")

The ErrorRecoveryLevel preference of this node. Currently, only 0-2 are valid. This is designed to accommodate future error recover 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-1, since those functions are subsets of error level 2.

ImmediateDataPreference

Data type: boolean

Access type: Read/write

Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeImmediateData"), ModelCorrespondence ("CIM_iSCSISession.ImmediateData")

This property indicates ImmediateData preference for this node True = YES (but will accept NO), False = NO.

InitialR2TPreference

Data type: boolean

Access type: Read/write

Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeInitialR2T"), ModelCorrespondence ("CIM_iSCSISession.InitialR2T")

This property indicates the InitialR2T preference for this node: true = YES, false = will try to negotiate NO, will accept YES.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

This property is inherited from CIM_SettingData.

MaxConnectionsPerSession

Data type: uint32

Access type: Read/write

Qualifiers: MinValue (1), MaxValue (65535), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxConnections"), ModelCorrespondence ("CIM_iSCSISession.MaxConnectionsPerSession")

The maximum number of connections allowed in each session to and/or from this node.

MaxDataBurstLength

Data type: uint32

Access type: Read/write

Qualifiers: Units ("Bytes"), MinValue (512), MaxValue (16777215), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxBurstLength"), ModelCorrespondence ("CIM_iSCSISession.MaxDataBurstLength")

The maximum number of bytes which can be sent within a single sequence of Data-In or Data-Out PDUs.

MaxOutstandingR2T

Data type: uint32

Access type: Read/write

Qualifiers: MinValue (1), MaxValue (65535), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeMaxOutstandingR2T"), ModelCorrespondence ("CIM_iSCSISession.MaxOutstandingR2T")

Maximum number of outstanding R2Ts allowed per ISCSI task.

MaxUnsolicitedFirstDataBurstLength

Data type: uint32

Access type: Read/write

Qualifiers: Units ("Bytes"), MinValue (512), MaxValue (16777215), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiNodeFirstBurstLength"), ModelCorrespondence ("CIM_iSCSISession.MaxUnsolicitedFirstDataBurstLength")

The maximum length (bytes) supported for unsolicited data to/from this node.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012 R2
Namespace
 Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll

See also

CIM_SettingData