# Class CIM_iSCSISession
extends CIM_NetworkPipe

iSCSISession is a network pipe between an initiator and target SCSIProtocolEndpoints. An iSCSISession is composed of one or more TCP connections which MUST be selected from a SystemSpecificCollection representing an iSCSI Portal Group. NetworkPipeComposition aggregates NetworkPipe instances representing iSCSI connections, which are associated to TCPProtocolEndpoints. Only an iSCSI initiator can create an iSCSI Session, an iSCSI Target MUST accept (or reject) a session request. EndOfNetworkPipe associates iSCSISession with SCSIProtocolEndpoint.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_NetworkPipe
|
+--CIM_iSCSISession

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | iSCSISession is a network pipe between an initiator and target SCSIProtocolEndpoints. An iSCSISession is composed of one or more TCP connections which MUST be selected from a SystemSpecificCollection representing an iSCSI Portal Group. NetworkPipeComposition aggregates NetworkPipe instances representing iSCSI connections, which are associated to TCPProtocolEndpoints. Only an iSCSI initiator can create an iSCSI Session, an iSCSI Target MUST accept (or reject) a session request. EndOfNetworkPipe associates iSCSISession with SCSIProtocolEndpoint.
UMLPackagePath | string | CIM::Network::Pipes
Version | string | 2.11.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CurrentConnections | uint32 |
Description | string | The number of transport protocol connections that currently belong to this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnConnectionNumber
MaxValue | sint64 | 65535
MinValue | sint64 | 1
ModelCorrespondence | string | CIM_iSCSISessionSettings.MaxConnectionsPerSession
DataPDUInOrder | boolean |
Description | string | False indicates that iSCSI data PDUs within sequences MAY be in any order. True indicates that data PDUs within sequences MUST be at continuously increasing addresses, with no gaps or overlay between PDUs. Default is true.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnDataPDUInOrder
ModelCorrespondence | string | CIM_iSCSISessionSettings.DataPDUInOrderPreference
DataSequenceInOrder | boolean |
Description | string | False indicates that iSCSI data PDU sequences MAY be transferred in any order. True indicates that data PDU sequences MUST be transferred using continuously increasing offsets, except during error recovery.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnDataSequenceInOrder
ModelCorrespondence | string | CIM_iSCSISessionSettings.DataSequenceInOrderPreference
DefaultTimeToRetain | uint32 |
Description | string | The DefaultTime2Retain negotiated for this Session. 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.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Retain
MaxValue | sint64 | 3600
MinValue | sint64 | 0
ModelCorrespondence | string | CIM_iSCSISessionSettings.DefaultTimeToRetainPreference
PUnit | string | second
Units | string | Seconds
DefaultTimeToWait | uint32 |
Description | string | The DefaultTime2Wait negotiated for this Session. 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.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Wait
MaxValue | sint64 | 3600
MinValue | sint64 | 0
ModelCorrespondence | string | CIM_iSCSISessionSettings.DefaultTimeToWaitPreference
PUnit | string | second
Units | string | Seconds
Directionality | uint16 | 2
Description | string | iSCSI sessions MUST be bidirectional.
MappingStrings | string | Recommendation.ITU|M3100.Pipe.directionality
Override | string | Directionality
ValueMap | string | 2
Values | string | Bi-Directional
EndPointName | string |
Description | string | The iSCSI Port Name (iSCSIProtocolEndPoint.Name), of the device at the other end of this iSCSISession.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnInitiatorName, MIB.IETF|iSCSI-MIB.iscsiSsnTargetName
ErrorRecoveryLevel | uint32 |
Description | string | The level of error recovery negotiated between the initiator and the target. Higher numbers represent more detailed recovery schemes.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnErrorRecoveryLevel
MaxValue | sint64 | 255
MinValue | sint64 | 1
ModelCorrespondence | string | CIM_iSCSISessionSettings.ErrorRecoveryLevelPreference
ImmediateData | boolean |
Description | string | Indicates whether the initiator and target have agreed to support immediate data on this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnImmediateData
ModelCorrespondence | string | CIM_iSCSISessionSettings.ImmediateDataPreference
InitialR2T | boolean |
Description | string | If set to true, indicates that the initiator MUST wait for an R2T before sending to the target. If set to false, the initiator MAY send data immediately, within limits set by iscsiSsnFirstBurstLength and the expected data transfer length of the request.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnInitialR2T
ModelCorrespondence | string | CIM_iSCSISessionSettings.InitialR2TPreference
MaxConnectionsPerSession | uint32 |
Description | string | The maximum number of connections allowed in this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiNodeMaxConnections
MaxValue | sint64 | 65535
MinValue | sint64 | 1
ModelCorrespondence | string | CIM_iSCSISessionSettings.MaxConnectionsPerSession
MaxDataBurstLength | uint32 |
Description | string | The maximum number of bytes which can be sent within a single sequence of Data-In or Data-Out PDUs.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnMaxBurstLength
MaxValue | sint64 | 16777215
MinValue | sint64 | 512
ModelCorrespondence | string | CIM_iSCSISessionSettings.MaxDataBurstLength
PUnit | string | byte
Units | string | Bytes
MaxOutstandingR2T | uint32 |
Description | string | The maximum number of outstanding request-to-transmit (R2T)s per iSCSI task within this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnMaxOutstandingR2T
MaxValue | sint64 | 65535
MinValue | sint64 | 1
ModelCorrespondence | string | CIM_iSCSISessionSettings.MaxOutstandingR2T
PUnit | string | byte
Units | string | Bytes
MaxUnsolicitedFirstDataBurstLength | uint32 |
Description | string | The maximum length supported for unsolicited data sent within this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnFirstBurstLength
MaxValue | sint64 | 16777215
MinValue | sint64 | 512
ModelCorrespondence | string | CIM_iSCSISessionSettings.MaxUnsolicitedFirstDataBurstLength
PUnit | string | byte
Units | string | Bytes
SessionType | uint16 |
Description | string | iSCSI Session type.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnType
ValueMap | string | 2, 3
Values | string | Discovery, Normal
TSIH | uint32 |
Description | string | The Target Session Identifying Handle (TSIH) for this session.
MappingStrings | string | MIB.IETF|iSCSI-MIB.iscsiSsnTSIH

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AggregationBehavior | uint16 | CIM_NetworkPipe
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_NetworkPipe
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_NetworkPipe
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_NetworkPipe
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement