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. | Qualifiers:Version ( "2.11.0" ) UMLPackagePath ( "CIM::Network::Pipes" ) | Parameters (local in grey) | | Punit ( "second" ) MaxValue ( 3600 ) MinValue ( 0 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Wait" } Units ( "Seconds" ) ModelCorrespondence { "CIM_iSCSISessionSettings.DefaultTimeToWaitPreference" } uint32 DefaultTimeToWait ; 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. | MaxValue ( 65535 ) MinValue ( 1 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnConnectionNumber" } ModelCorrespondence { "CIM_iSCSISessionSettings.MaxConnectionsPerSession" } uint32 CurrentConnections ; The number of transport protocol connections that currently belong to this session. | Punit ( "byte" ) MaxValue ( 16777215 ) MinValue ( 512 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnFirstBurstLength" } Units ( "Bytes" ) ModelCorrespondence { "CIM_iSCSISessionSettings.MaxUnsolicitedFirstDataBurstLength" } uint32 MaxUnsolicitedFirstDataBurstLength ; The maximum length supported for unsolicited data sent within this session. | Punit ( "byte" ) MaxValue ( 65535 ) MinValue ( 1 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnMaxOutstandingR2T" } Units ( "Bytes" ) ModelCorrespondence { "CIM_iSCSISessionSettings.MaxOutstandingR2T" } uint32 MaxOutstandingR2T ; The maximum number of outstanding request-to-transmit (R2T)s per iSCSI task within this session. | MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnTSIH" } uint32 TSIH ; The Target Session Identifying Handle (TSIH) for this session. | MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnInitialR2T" } ModelCorrespondence { "CIM_iSCSISessionSettings.InitialR2TPreference" } boolean InitialR2T ; 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 { "MIB.IETF|iSCSI-MIB.iscsiSsnDataSequenceInOrder" } ModelCorrespondence { "CIM_iSCSISessionSettings.DataSequenceInOrderPreference" } boolean DataSequenceInOrder ; 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. | Punit ( "byte" ) MaxValue ( 16777215 ) MinValue ( 512 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnMaxBurstLength" } Units ( "Bytes" ) ModelCorrespondence { "CIM_iSCSISessionSettings.MaxDataBurstLength" } uint32 MaxDataBurstLength ; The maximum number of bytes which can be sent within a single sequence of Data-In or Data-Out PDUs. | Punit ( "second" ) MaxValue ( 3600 ) MinValue ( 0 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiNodeDefaultTime2Retain" } Units ( "Seconds" ) ModelCorrespondence { "CIM_iSCSISessionSettings.DefaultTimeToRetainPreference" } uint32 DefaultTimeToRetain ; 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 { "MIB.IETF|iSCSI-MIB.iscsiSsnDataPDUInOrder" } ModelCorrespondence { "CIM_iSCSISessionSettings.DataPDUInOrderPreference" } boolean DataPDUInOrder ; 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. | ValueMap { "2" , "3" } Values { "Discovery" , "Normal" } MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnType" } uint16 SessionType ; iSCSI Session type. | MaxValue ( 255 ) MinValue ( 1 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnErrorRecoveryLevel" } ModelCorrespondence { "CIM_iSCSISessionSettings.ErrorRecoveryLevelPreference" } uint32 ErrorRecoveryLevel ; The level of error recovery negotiated between the initiator and the target. Higher numbers represent more detailed recovery schemes. | MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnImmediateData" } ModelCorrespondence { "CIM_iSCSISessionSettings.ImmediateDataPreference" } boolean ImmediateData ; Indicates whether the initiator and target have agreed to support immediate data on this session. | ValueMap { "2" } Values { "Bi-Directional" } Override ( "Directionality" ) uint16 Directionality = 2 ; iSCSI sessions MUST be bidirectional. | MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiSsnInitiatorName" , "MIB.IETF|iSCSI-MIB.iscsiSsnTargetName" } string EndPointName ; The iSCSI Port Name (iSCSIProtocolEndPoint.Name), of the device at the other end of this iSCSISession. | MaxValue ( 65535 ) MinValue ( 1 ) MappingStrings { "MIB.IETF|iSCSI-MIB.iscsiNodeMaxConnections" } ModelCorrespondence { "CIM_iSCSISessionSettings.MaxConnectionsPerSession" } uint32 MaxConnectionsPerSession ; The maximum number of connections allowed in this session. | ValueMap { "0" , "2" , "3" , "4" } Values { "Unknown" , "No Lower-Level Composition" , "Combined In Parallel" , "Combined In Sequence" } uint16 AggregationBehavior ; 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. | MappingStrings { "Recommendation.ITU|M3100.Pipe.administrativeState" } Write Override ( "RequestedState" ) uint16 RequestedState = 5 ;
| MappingStrings { "Recommendation.ITU|M3100.TrailR1.trailId" , "Recommendation.ITU|M3100.ConnectionR1.connectionID" , "Recommendation.ITU|M3100.SubNetworkConnection." "subNetworkConnectionID" } Key string InstanceID ; 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: <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 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. | MappingStrings { "Recommendation.ITU|M3100.Pipe.operationalState" } Override ( "EnabledState" ) uint16 EnabledState ;
| datetime TimeOfLastStateChange ; 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" } Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } uint32RequestStateChange( | | The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. Qualifiers:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
IN
| | uint16 RequestedState | | | Reference to the job (can be null if the task is completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned. Qualifiers:IN
| | datetime TimeoutPeriod | ) 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. | ValueMap { "2" , "3" , "5" , "6" , "7" , "9" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "Quiesce" , "DMTF Reserved" , "Vendor Reserved" } Write uint16 EnabledDefault = 2 ; 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). | ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } string OtherEnabledState ; 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. | ValueMap { "0" , "1" , "2" , "3" , ".." , "0x8000.." } Values { "Unknown" , "OK" , "Degraded" , "Error" , "DMTF Reserved" , "Vendor Reserved" } Experimental ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" , "CIM_ManagedSystemElement.HealthState" } uint16 PrimaryStatus ; PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. 'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time. 'OK' indicates the ManagedElement is functioning normally. 'Degraded' indicates the ManagedElement is functioning below normal. 'Error' indicates the ManagedElement is in an Error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , ".." , "0x8000.." } Values { "Unknown" , "Not Available" , "In Service" , "Starting" , "Stopping" , "Stopped" , "Aborted" , "Dormant" , "Completed" , "Migrating" , "Emigrating" , "Immigrating" , "Snapshotting" , "Shutting Down" , "In Test" , "DMTF Reserved" , "Vendor Reserved" } Experimental ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } uint16 OperatingStatus ; OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions. OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. 'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time. 'None' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). 'In Service' describes an element being configured, maintained, cleaned, or otherwise administered. 'Starting' describes an element being initialized. 'Stopping' describes an element being brought to an orderly stop. 'Stopped' and 'Aborted' are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. 'Dormant' indicates that the element is inactive or quiesced. 'Completed' indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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). 'Migrating' element is being moved between host elements. 'Immigrating' element is being moved to new host element. 'Emigrating' element is being moved away from host element. 'Shutting Down' describes an element being brought to an abrupt stop. 'In Test' element is performing test functions. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x8000.." } Values { "Not Available" , "No Additional Information" , "Stressed" , "Predictive Failure" , "Non-Recoverable Error" , "Supporting Entity in Error" , "DMTF Reserved" , "Vendor Reserved" } Experimental ModelCorrespondence { "CIM_EnabledLogicalElement.PrimaryStatus" , "CIM_ManagedSystemElement.HealthState" } uint16 DetailedStatus ; DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. 'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). 'No Additional Information' indicates that the element is functioning normally as indicated by PrimaryStatus = 'OK'. 'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on. 'Predictive Failure' indicates that an element is functioning normally but a failure is predicted in the near future. 'Non-Recoverable Error ' indicates that this element is in an error condition that requires human intervention. 'Supporting Entity in Error' indicates that this element might be 'OK' but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. | ValueMap { "0" , "1" , "2" , "3" , "4" , ".." , "0x8000.." } Values { "Unknown" , "Not Available" , "Communication OK" , "Lost Communication" , "No Contact" , "DMTF Reserved" , "Vendor Reserved" } Experimental uint16 CommunicationStatus ; CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. 'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time. 'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). 'Communication OK ' indicates communication is established with the element, but does not convey any quality of service. 'No Contact' indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. 'Lost Communication' indicates that the Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) Values { "Unknown" , "Other" , "OK" , "Degraded" , "Stressed" , "Predictive Failure" , "Error" , "Non-Recoverable Error" , "Starting" , "Stopping" , "Stopped" , "In Service" , "No Contact" , "Lost Communication" , "Aborted" , "Dormant" , "Supporting Entity in Error" , "Completed" , "Power Mode" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" } uint16 OperationalStatus [ ] ; Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. 'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on. 'Predictive Failure' indicates that an element is functioning nominally but predicting a failure in the near future. 'In Service' describes an element being configured, maintained, cleaned, or otherwise administered. 'No Contact' indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. 'Lost Communication' indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. 'Stopped' and 'Aborted' are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. 'Dormant' indicates that the element is inactive or quiesced. 'Supporting Entity in Error' indicates that this element might be 'OK' but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. 'Completed' indicates that the element has completed its operation. This value should be combined with either OK, Error, 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' indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" } string StatusDescriptions [ ] ; Strings describing the various OperationalStatus array values. For example, if 'Stopping' is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. | ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } string Status ; A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | MaxLen ( 1024 ) string Name ; 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. | ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." } Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" } uint16 HealthState ; Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: 'Non-recoverable Error' (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. 'Critical Failure' (25) - The element is non-functional and recovery might not be possible. '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. 'Minor Failure' (15) - All functionality is available but some might be degraded. '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. 'OK' (5) - The element is fully functional and is operating within normal operational parameters and without error. 'Unknown' (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. | string ElementName ; 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. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. | MaxLen ( 64 ) string Caption ; The Caption property is a short textual description (one- line string) of the object. | string Description ; The Description property provides a textual description of the object. |
| | | | |
|