# 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

Name | Data Type | Value
--- | --- | ---
Description | string | A class derived from CIM_Service providing methods related to management of multiple paths to SCSI devices.
UMLPackagePath | string | CIM::Device::StorageDevices
Version | string | 2.29.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### SetTPGAccess (uint32)

#### Method Qualifiers (SetTPGAccess)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099, .., 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AccessStates | uint16[]
ArrayType | string | Indexed

Description

string

An 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.

IN | boolean | true
ModelCorrespondence | string | CIM_SCSITargetPortGroup.AccessState
ValueMap | string | 2, 3, 4, 5, 6
Values | string | Active/Optimized, Active/Non-optimized, StandBy, Unavailable, Active
TargetPortGroups | CIM_SCSITargetPortGroup[]
ArrayType | string | Indexed
Description | string | Array of references to instances of SCSITargetPortGroup. All the referenced TargetPortGroup instances must be part of the same target device.
IN | boolean | true
ModelCorrespondence | string | CIM_SCSITargetPortGroup
LogicalUnit | REF CIM_LogicalDevice
Description | string | A reference to an instances of a subclass of CIM_LogicalDevice representing the SCSI logical unit where the command will be sent.
IN | boolean | true

#### SetLoadBalanceAlgorithm (uint32)

#### Method Qualifiers (SetLoadBalanceAlgorithm)

Name | Data Type | Value
--- | --- | ---
Description | string | This method requests that the target change the load balance algorithm for the referenced LogicalDevice instance.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097, .., 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported LogicalDevice, Invalid LoadBalanceType, Method Reserved, Vendor Specific

#### Method Parameters (SetLoadBalanceAlgorithm)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
LoadBalanceAlgorithm | uint16
Description | string | The desired load balance algorithm.
IN | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6
Values | string | Unknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, Product Specific
OtherLoadBalanceAlgorithmDescription | string
Description | string | When 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.
IN | boolean | true
LogicalDevice | REF CIM_LogicalDevice
Description | string | A 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.
IN | boolean | true

#### AssignLogicalUnitToPortGroup (uint32)

#### Method Qualifiers (AssignLogicalUnitToPortGroup)

Name | Data Type | Value
--- | --- | ---

Description

string

This 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.

ValueMap | string | 0, 1, 2, 3, 4, 5, .., 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

#### Method Parameters (AssignLogicalUnitToPortGroup)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
LogicalUnit | REF CIM_LogicalDevice
Description | string | A reference to an instance of a subclass of LogicalDevice representing a SCSI logical unit.
IN | boolean | true
TargetPortGroup | REF CIM_SCSITargetPortGroup
Description | string | A reference to a target port group. The Target Port Group should be in an active state.
IN | boolean | true

#### SetOverridePath (uint32)

#### Method Qualifiers (SetOverridePath)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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'.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

#### Method Parameters (SetOverridePath)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Path | REF CIM_SCSIInitiatorTargetLogicalUnitPath
Description | string | A reference to a SCSIInitiatorTargetLogicalUnitPath.
IN | boolean | true

#### CancelOverridePath (uint32)

#### Method Qualifiers (CancelOverridePath)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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'.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

#### Method Parameters (CancelOverridePath)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
LogicalUnit | REF CIM_LogicalDevice
Description | string | A reference to a SCSIInitiatorTargetLogicalUnitPath.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service