Class CIM_SCSIInitiatorTargetLogicalUnitPath

An association that models a host driver path to a SCSI logical unit. Each permutation of initiator and target ProtocolEndpoints and logical units is considered a separate path. This class describes end-to-end path behavior such as properties and operations commonly used in multipath management.

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


Class Hierarchy

CIM_SCSIInitiatorTargetLogicalUnitPath

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
Associationbooleantrue
DescriptionstringAn association that models a host driver path to a SCSI logical unit. Each permutation of initiator and target ProtocolEndpoints and logical units is considered a separate path. This class describes end-to-end path behavior such as properties and operations commonly used in multipath management.
UMLPackagePathstringCIM::Device::StorageDevices
Versionstring2.10.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AdministrativeOverrideuint16
DescriptionstringAdministrativeOverride allows an administrator to select a single path, force all I/O to this path, and disables load balancing. The steady-state value is 'No override in effect'. When an administrator sets an override for a particular path, that path's AdministrativeOverride is set to 'Overridding' and all other paths to same logical unit are assigned a value of 'Overridden'. This property is changed using the OverridePath method in SCSIPathConfigurationService.
MappingStringsstringMP_API.SNIA|MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES|overridePath
ModelCorrespondencestringCIM_SCSIPathConfigurationService.SetOverridePath
ValueMapstring2, 3, 4
ValuesstringOverriding, Overridden, No override in effect
AdministrativeWeightuint32
DescriptionstringA value assigned by an administrator specifying a preference to assign to a path. The drivers will actively use all available paths with the highest weight. This allows an administrator to assign a subset of available paths for load balanced access and reserve the others as backup paths. For symmetric access devices, all paths are considered 'available'. For asymmetric access devices, all paths in active target port groups are considered available.
MappingStringsstringMP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|weight
Writebooleantrue
LogicalUnitNumberuint16
DescriptionstringThe SCSI Logical Unit Number. This is the unit number with values below 16,384 used in management applications. It is not the full SCSI SAM 8-byte logical unit number structure. Using the terminology from the T10 SCSI specifications, this is the LU number with a value between 0 and 255 using the Peripheral device addressing method with Bus Identifier zero or a LU number between 0 and 16,383 using the Flat space (AKA volume set) addressing method.
MappingStringsstringMP_API.SNIA|MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES|overridePathMP_API.SNIA|MP_CancelOverridePath, MP_API.SNIA|MP_SetOverridePath
MaxValuesint6416383
OSDeviceNamestring
DescriptionstringThe OS Device Name for this path. Only applicable if the ExposedPathDeviceFiles property is true in the instance of SCSIMultipathConfigurationCapabilities associated with the LogicalDevice/RedundancySet this instance is a member of.
MappingStringsstringMP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|deviceFileName
Stateuint32
DescriptionstringThe state of this path. Values are defined as follows: Unknown - the path is unavailable,but the cause is not known. Active - The path is okay and active. Passive - The path is okay, but is associated with a target port of target port group in standby access state. Only applies to devices with asymmetric access. Disabled - The path is disabled by administrative request (DisablePathLU). Path Error - The path is unusable due to an error on this path and no SCSI status was received. Logical Unit Error - A SCSI status was received for an I/O through this path indicating a logical unit error. Reserved - The path is unavailable due to a SCSI reservation. Removed - The path is unavailable because the OS or drivers marked the pathunusable. Transitioning - the path is transitioning between two valid states. The only valid values a client can specify are Disabled and Active. All other states are determined by the underlying implementation; attempts to set them should be given an error response.
MappingStringsstringMP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|pathState
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9
ValuesstringUnknown, Active, Passive, Disabled, Path Error, Logical Unit Error, Reserved, Removed, Transitioning
Writebooleantrue

Association References

NameClass OriginReference ClassQualifiers
NameData TypeValue
InitiatorCIM_SCSIInitiatorTargetLogicalUnitPathCIM_SCSIProtocolEndpoint
DescriptionstringAn initiator endpoint.
Keybooleantrue
LogicalUnitCIM_SCSIInitiatorTargetLogicalUnitPathCIM_LogicalDevice
DescriptionstringA subclass of LogicalDevice representing a SCSI Logical Unit (such as StorageVolume or TapeDrive).
Keybooleantrue
TargetCIM_SCSIInitiatorTargetLogicalUnitPathCIM_SCSIProtocolEndpoint
DescriptionstringA target endpoint.
Keybooleantrue

Class Methods