CIM_iSCSIConnection class

Article
05/31/2018

This class contains the attributes of and negotiated values for, an iSCSI Connection which is modeled as a subclass of NetworkPipe. The original settings that are a starting point for negotiation are found in the class iSCSIConnectionSettings.

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_iSCSIConnection : CIM_NetworkPipe
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   OtherEnabledState;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   InstanceID;
  uint16   Directionality;
  uint16   AggregationBehavior;
  uint16   EnabledState = 5;
  uint16   RequestedState = 512;
  uint32   ConnectionID;
  uint32   MaxReceiveDataSegmentLength;
  uint32   MaxTransmitDataSegmentLength;
  uint16   HeaderDigestMethod;
  string   OtherHeaderDigestMethod;
  uint16   DataDigestMethod;
  string   OtherDataDigestMethod;
  boolean  ReceivingMarkers;
  boolean  SendingMarkers;
  boolean  ActiveiSCSIVersion;
  uint16   AuthenticationMethodUsed;
  boolean  MutualAuthentication;
};

Members

The CIM_iSCSIConnection class has these types of members:

Methods
Properties

Methods

The CIM_iSCSIConnection class has these methods.

Method	Description
RequestStateChange	Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. This method is inherited from CIM_EnabledLogicalElement.

Method

Description

RequestStateChange

Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
This method is inherited from CIM_EnabledLogicalElement.

Properties

The CIM_iSCSIConnection class has these properties.

ActiveiSCSIVersion

Data type: boolean
Access type: Read-only
Qualifiers: MinValue (0), MaxValue (255), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnVersionActive"), ModelCorrespondence ("CIM_iSCSICapabilities.MinimumSpecificationVersionSupported", "CIM_iSCSICapabilities.MaximumSpecificationVersionSupported")

Active version number of the iSCSI specification negotiated on this connection.

AggregationBehavior

Data type: uint16
Access type: Read-only

Indicates whether the pipe is composed of lower-level pipes, and if so, how these lower-level pipes are aggregated (in parallel or in sequence). The specific instances of NetworkPipe that are combined are described using the NetworkPipeComposition association.

In the context of M.3100, the ability to be composed of lower-level pipes is modeled as a Trail. A Trail is made up of one or more Connections. (Note that both Trails and Connections are subclasses of Pipe). Because of the flexibility of the NetworkPipeComposition association, there is no need to subclass NetworkPipe, as was done in M.3100, but merely to instantiate the NetworkPipeComposition association to describe the bundling of the lower-level pipes (i.e., the connections), or the sequencing of them.

This property is inherited from CIM_NetworkPipe.

Unknown (0)

No Lower-Level Composition (2)

Combined In Parallel (3)

Combined In Sequence (4)

AuthenticationMethodUsed

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|IPS-AUTH-MIB.ipsAuthCredAuthMethod"), ModelCorrespondence ("CIM_iSCSIConnectionSettings.PrimaryAuthenticationMethod", "CIM_iSCSIConnectionSettings.SecondaryAuthenticationMethod", "CIM_iSCSICapabilities.AuthenticationMethodsSupported")

The authentication method being used on this connection, as communicated during the login phase.

No Authentication (2)

SRP (3)

CHAP (4)

Kerberos (5)

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.

ConnectionID

Data type: uint32
Access type: Read-only
Qualifiers: MinValue (1), MaxValue (65535), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnCid")

The iSCSI Connection ID for this connection.

DataDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnDataIntegrity"), ModelCorrespondence ("CIM_iSCSIConnectionSettings.PrimaryHeaderDigestMethod", "CIM_iSCSIConnectionSettings.SecondaryHeaderDigestMethod", "CIM_iSCSIConnection.OtherDataDigestMethod")

This property identifies the iSCSI data digest scheme in use within this connection.

Other (1)

No Digest (2)

CRC32C (3)

Description

Data type: string
Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

Directionality

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|M3100.Pipe.directionality")

Indicates whether the pipe is bi-directional (value = 2), unidirectional (value = 3), or this information is not known (value = 0). For unidirectional pipes, the source and sink are indicated by a property (SourceOrSink) of the association, EndpointOfNetworkPipe.

This property is inherited from CIM_NetworkPipe.

Unknown (0)

Bi-Directional (2)

Unidirectional (3)

ElementName

Data type: string
Access type: Read-only

Contains a user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read/write

An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10 32767

Vendor Reserved

32768 65535

EnabledState

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|M3100.Pipe.operationalState")

An integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states.

This property is inherited from CIM_NetworkPipe.

Unknown (0)

Other (1)

Enabled (2)

Disabled (3)

Shutting Down (4)

Not Applicable (5)

Enabled but Offline (6)

In Test (7)

Deferred (8)

Quiesce (9)

Starting (10)

DMTF Reserved

11 32767

Vendor Reserved

32768 65535

HeaderDigestMethod

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnHeaderIntegrity"), ModelCorrespondence ("CIM_iSCSIConnectionSettings.PrimaryHeaderDigestMethod", "CIM_iSCSIConnectionSettings.SecondaryHeaderDigestMethod", "CIM_iSCSIConnection.OtherHeaderDigestMethod")

This property identifies the iSCSI header digest scheme in use within this connection.

Other (1)

No Digest (2)

CRC32C (3)

HealthState

Data type: uint16
Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its sub-components.

This property is inherited from CIM_ManagedSystemElement.

The following values have been defined:

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors

Minor failure (15)

All functionality is available but some might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.

Critical failure (25)

The element is non-functional and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key, MappingStrings ("Recommendation.ITU|M3100.TrailR1.trailId", "Recommendation.ITU|M3100.ConnectionR1.connectionID", "Recommendation.ITU|M3100.SubNetworkConnection.subNetworkConnectionID")

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:

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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority. (This 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>. (For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.)

<LocalID> MUST include either a vendor specified unique identifier, or if mapping from an ITU M.3100 environment, the trailID, connectionID or subNetworkConnectionID of the instances of PipeR2.

This property is inherited from CIM_NetworkPipe.

MaxReceiveDataSegmentLength

Data type: uint32
Access type: Read-only
Qualifiers: Units ("Bytes"), MinValue (512), MaxValue (16777215), MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnMaxRecvDataSegLength"), ModelCorrespondence ("CIM_iSCSIConnectionSettings.MaxReceiveDataSegmentLength")

The maximum data payload size supported for command or data PDUs able to be received on this connection.

MaxTransmitDataSegmentLength

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

The maximum data payload size supported for command or data PDUs to be sent on this connection.

MutualAuthentication

Data type: boolean
Access type: Read-only

This property when true, indicates that the Target was required to authenticate itself to the Initiator, in addition to the Initiator authenticating itself to the Target. When false, and AuthenticationMethod is other than 'No Authentication', only the Initatior authenticated itself to the Target.

When AuthenticationMethodUsed is 'No Authentication', this property must be false.

Name

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

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

This property is inherited from CIM_ManagedSystemElement.

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Contains indicators of the current status of the element. The first value of OperationalStatus should contain the primary status for the element.

Note

OperationalStatus replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, Microsoft strongly recommends that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

The following values have been defined:

Unknown (0)

Indicates the implementation cannot report on OperationalStatus at this time.

Other (1)

Indicates an undefined state.

OK (2)

Indicates full functionality without errors.

Degraded (3)

Indicates the element is working and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors

Stressed (4)

Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

Indicates that an element is functioning nominally but predicting a failure in the near future.

Error (6)

Indicates that an error has occurred.

Non-Recoverable Error (7)

A non-recoverable error has occurred.

Starting (8)

The job is starting.

Stopping (9)

The job is stopping.

Stopped (10)

The element has been intentionally stopped.

In Service (11)

Indicates the element is being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.

Dormant (15)

Indicates that the job is inactive.

Supporting Entity in Error (16)

Indicates that an element on which this job depends is in error. This element may be OK but is unable to function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed (17)

Indicates that the job has completed its operation. This value should be combined with either OK, ErrorError, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

Power Mode (18)

"Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.

DMTF Reserved

DMTF has reserved this portion of the range for additional OperationalStatus values in the future.

Vendor Reserved

Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.

OtherDataDigestMethod

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_iSCSIConnectionSettings.OtherPrimaryDataDigestMethod", "CIM_iSCSIConnectionSettings.OtherSecondaryDataDigestMethod", "CIM_iSCSIConnection.DataDigestMethod")

A string describing the Data Digest scheme in use when DataDigestMethod is equal to the value 1, "Other".

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

OtherHeaderDigestMethod

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_iSCSIConnectionSettings.OtherPrimaryHeaderDigestMethod", "CIM_iSCSIConnectionSettings.OtherSecondaryHeaderDigestMethod", "CIM_iSCSIConnection.HeaderDigestMethod")

A string describing the Header Digest scheme in use when HeaderDigestMethod is equal to the value 1, "Other".

ReceivingMarkers

Data type: boolean
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnRecvMarker"), ModelCorrespondence ("CIM_iSCSIConnectionSettings.RequestingMarkersOnReceive")

This property indicates whether or not this connection is receiving markers in in its incoming data stream.

RequestedState

Data type: uint16
Access type: Read/write
Qualifiers: MappingStrings ("Recommendation.ITU|M3100.Pipe.administrativeState")

Indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState.

This property is inherited from CIM_NetworkPipe.

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 32767

Vendor Reserved

32768 65535

SendingMarkers

Data type: boolean
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|iSCSI-MIB.iscsiCxnSendMarker")

This property indicates whether or not this connection is inserting markers in in its outgoing data stream.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Contains a string indicating the primary status of the object.

Note

This property is deprecated and replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility it should be secondary to the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.

This property is inherited from CIM_EnabledLogicalElement.

Requirements


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

Partager via

CIM_iSCSIConnection class

Syntax

Members

Methods

Properties

Requirements

See also

Ressources supplémentaires