Class CIM_SCSIPathConfigurationService
extends CIM_Service

A class derived from CIM_Service providing methods related to management of multiple paths to SCSI devices.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_SCSIPathConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA class derived from CIM_Service providing methods related to management of multiple paths to SCSI devices.
UMLPackagePathstringCIM::Device::StorageDevices
Versionstring2.29.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

SetTPGAccess (uint32)

Method Qualifiers (SetTPGAccess)

NameData TypeValue
DescriptionstringThis method requests that the target change the access states of the requested SCSITargetPortGroups. This will have the effect of doing a failover or failback operation.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported AccessState, Invalid SCSITargetPortGroup, Unsupported AccessState combination, Unsupported SCSITargetPortGroup combination, Method Reserved, Vendor Specific

Method Parameters (SetTPGAccess)

NameTypeQualifiers
NameData TypeValue
AccessStatesuint16[]
ArrayTypestringIndexed
DescriptionstringAn array of desired access states. Each access state in this array is the desired access state for the SCSITargetPortGroup in the corresponding entry in the TargetPortGroups parameter. The Active value is not part of the SCSI Specification; it is a convenience for clients that are not sure whether to specify Active/Optimized of Active/Non-optimized. The instrumentation selects a value based on historic information, knowledge of the target configuration, or trial and error. Note that SCSITargetPortGroup.AccessState includes the value 'Transitioning' that is excluded here - a caller cannot request transitioning, though it can be reported by a target device.
INbooleantrue
ModelCorrespondencestringCIM_SCSITargetPortGroup.AccessState
ValueMapstring2, 3, 4, 5, 6
ValuesstringActive/Optimized, Active/Non-optimized, StandBy, Unavailable, Active
TargetPortGroupsCIM_SCSITargetPortGroup[]
ArrayTypestringIndexed
DescriptionstringArray of references to instances of SCSITargetPortGroup. All the referenced TargetPortGroup instances must be part of the same target device.
INbooleantrue
ModelCorrespondencestringCIM_SCSITargetPortGroup
LogicalUnit REF CIM_LogicalDevice
DescriptionstringA reference to an instances of a subclass of CIM_LogicalDevice representing the SCSI logical unit where the command will be sent.
INbooleantrue

SetLoadBalanceAlgorithm (uint32)

Method Qualifiers (SetLoadBalanceAlgorithm)

NameData TypeValue
DescriptionstringThis method requests that the target change the load balance algorithm for the referenced LogicalDevice instance.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported LogicalDevice, Invalid LoadBalanceType, Method Reserved, Vendor Specific

Method Parameters (SetLoadBalanceAlgorithm)

NameTypeQualifiers
NameData TypeValue
LoadBalanceAlgorithmuint16
DescriptionstringThe desired load balance algorithm.
INbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6
ValuesstringUnknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, Product Specific
OtherLoadBalanceAlgorithmDescriptionstring
DescriptionstringWhen LoadBalanceAlgorithm is 'Other', this parameter specifies a description of the load balancing algorithm. When LoadBalanceAlgorithm is 'Product Specific', this property provides a string specifying the vendor/product/version of the ManagedElement.
INbooleantrue
LogicalDevice REF CIM_LogicalDevice
DescriptionstringA reference to the LogicalDevice subclass instance with an LogicalIdentity to the load balance RedundancySet. If SCSIMultipathConfigurationCapabilities. CanLoadBalanceLUsIndependently is true, just the referenced logical unit is modified. Otherwise, all logical units sharing the target are modified.
INbooleantrue

AssignLogicalUnitToPortGroup (uint32)

Method Qualifiers (AssignLogicalUnitToPortGroup)

NameData TypeValue
DescriptionstringThis method allows an administrator to assign a logical unit to a target port group. At any time, each LU will typically be associated with two target port groups, one in active state and one in standby state. The result of this method will be that the LU associations change to a pair of target port groups. Only valid if the target device supports asymmetric access state and SCSIMultipathConfigurationCapabilities SupportsLuAssignment is set.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (AssignLogicalUnitToPortGroup)

NameTypeQualifiers
NameData TypeValue
LogicalUnit REF CIM_LogicalDevice
DescriptionstringA reference to an instance of a subclass of LogicalDevice representing a SCSI logical unit.
INbooleantrue
TargetPortGroup REF CIM_SCSITargetPortGroup
DescriptionstringA reference to a target port group. The Target Port Group should be in an active state.
INbooleantrue

SetOverridePath (uint32)

Method Qualifiers (SetOverridePath)

NameData TypeValue
DescriptionstringThis method allows an administrator to temporarily disable load balancing for a specific logical unit. The path specified as a parameter will have its AdministrativeOverride property set to 'Overriding' and all I/O to the logical unit will be directed to this path. All other paths to this logical unit will have AdministrativeOverride set to 'Overridden'.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (SetOverridePath)

NameTypeQualifiers
NameData TypeValue
Path REF CIM_SCSIInitiatorTargetLogicalUnitPath
DescriptionstringA reference to a SCSIInitiatorTargetLogicalUnitPath.
INbooleantrue

CancelOverridePath (uint32)

Method Qualifiers (CancelOverridePath)

NameData TypeValue
DescriptionstringThis method clears an override path as set in SetOverridePath and load balancing is enabled. All paths to the logical unit specified as a parameter will have AdministrativeOverride property set to 'No override in effect'.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (CancelOverridePath)

NameTypeQualifiers
NameData TypeValue
LogicalUnit REF CIM_LogicalDevice
DescriptionstringA reference to a SCSIInitiatorTargetLogicalUnitPath.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service