# Class CIM_ControllerConfigurationService
extends CIM_Service

The ControllerConfigurationService provides methods that allow a client to manipulate LUN Masking in a storage system.

### 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_ControllerConfigurationService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The ControllerConfigurationService provides methods that allow a client to manipulate LUN Masking in a storage system.
UMLPackagePath | string | CIM::Device::ProtocolController
Version | string | 2.10.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

#### CreateProtocolControllerWithPorts (uint32)

#### Method Qualifiers (CreateProtocolControllerWithPorts)

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

Description

string

This method creates an appropriate subclass of ProtocolController. In addition to its role of controlling downstream devices, a ProtocolControl is used to provide a central management point for access control with respect to those devices. Certain storage system implementations across multiple vendors require permissions to be established atomically with the creation of a ProtocolController. This method provides this capability via the Privilege and Identity properties. By supplying appropriate information in those properties, this method will assure that appropriate AuthorizedTarget and AuthorizedSubject associations, (as defined in the User and Security Model), are instantiated to restrict access to the logical devices 'behind' it. If multiple target ports are specified in the Ports input parameter, all expose the same view (i.e., have the same unit numbers and permissions). This method does not create the port instances, but does create ProtocolControllerForPort associations between the specified ports and the new ProtocolController. The new ProtocolController is defined to be weak to the same System as the ControllerConfigurationService.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, ID Parameter Missing or Not Unique, Hardware Implementation Requires Null Ports Parameter, Busy, Method Reserved, Vendor Specific

#### Method Parameters (CreateProtocolControllerWithPorts)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | The string to be used in the ElementName of the new ProtocolController.
IN | boolean | true
ModelCorrespondence | string | CIM_ProtocolController.ElementName
Protocol | uint16
Description | string | The protocol type for the new ProtocolController.
IN | boolean | true
ModelCorrespondence | string | CIM_SCSIProtocolController
ValueMap | string | 0, 1, 2
Values | string | Unknown, Other, SCSI
Ports | string[]

Description

string

Array of strings containing representations of references to instances of CIM_LogicalPort (or subclass) instances. This is the list of target ports that are associated to the ProtocolController. ProtocolControllerForPort associations are created by the instrumentation associating the new ProtocolController to these ports. If this parameter is null, then all ports in the storage system (this Service's 'scoping' System and all its ComponentCS Systems) are attached to the new ProtocolController.

IN | boolean | true
Identity | REF CIM_ManagedElement

Description

string

Reference to a CIM_ManagedElement (or subclass) instance. This ManagedElement MUST be either a CIM_Identity, or a CIM_Collection (or subclass, eg. SystemSpecificCollection, Role, or Group) that has CIM_Identities as MemberOfCollection. If ProtocolControllerMaskingCapabilities.ProtocolControllerSupportsCollection is false, the reference MUST be to a CIM_Identity (or subclass). If present, it has a 1:1 correspondence with the Privilege property. If present, this method will atomically create the new ProtocolController instance and instantiate a missing AuthorizedSubject association between the Privilege/Identity pair; and instantiate an AuthorizedTarget association between the AuthorizedPrivilege and the new ProtocolController. Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then at least the Identity/Privilege pair MUST be specified.

IN | boolean | true
ModelCorrespondence | string | CIM_ControllerConfigurationService.CreateProtocolControllerWithPorts.Privilege
Privilege | REF CIM_Privilege

Description

string

Reference to a CIM_Privilege (or subclass) instance to be used as a template. If supplied, it has a 1:1 correspondence with the Identity parameter and this method will atomically create the new ProtocolController instance and related AuthorizedPrivilege, AuthorizedTarget and AuthorizedSubject instances. Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then the Identity/Privilege pair MUST be specified. If false, then the Identity/Privilege pair MUST NOT be specified.

IN | boolean | true
ModelCorrespondence | string | CIM_ControllerConfigurationService.CreateProtocolControllerWithPorts.Identity
ProtocolController | REF CIM_ProtocolController
Description | string | A reference to the new ProtocolController that is created.
IN | boolean | false
OUT | boolean | true

#### DeleteProtocolController (uint32)

#### Method Qualifiers (DeleteProtocolController)

Name | Data Type | Value
--- | --- | ---
Description | string | The method deletes an instance of ProtocolController and all associations in which this ProtocolController is referenced.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, LogicalDevices Associated to Other ProtocolControllers Not Deleted, Busy, Method Reserved, Vendor Specific

#### Method Parameters (DeleteProtocolController)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DeleteChildrenProtocolControllers | boolean
Description | string | If true, the management instrumentation provider will also delete 'child' ProtocolControllers (i.e., those defined as Dependent references in instances of AssociatedProtocolController where this ProtocolController is the Antecedent reference). Also, all direct associations involving the 'child' ProtocolControllers will be removed.
IN | boolean | true
DeleteUnits | boolean

Description

string

If true, the management instrumentation provider will also delete LogicalDevice instances associated via ProtocolControllerForUnit, to this ProtocolController and its children. (Note that 'child' controllers will only be affected if the DeleteChildrenProtocolControllers input parameter is TRUE). LogicalDevice instances are only deleted if there are NO remaining ProtocolControllerForUnit associations, to other ProtocolControllers.

IN | boolean | true
ProtocolController | REF CIM_ProtocolController
Description | string | The ProtocolController to be deleted.
IN | boolean | true

#### AttachDevice (uint32)

#### Method Qualifiers (AttachDevice)

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

Description

string

This method associates a LogicalDevice subclass (specifically a StorageVolume or MediaAccessDevice subclass) to the referenced ProtocolController. The association is persisted as an instance of ProtocolControllerForUnit. The management instrumentation provider must verify that the logical unit numbers (defined using the DeviceNumber input parameter) are unique for the ProtocolController. When the Protocol Controller is actively masking a device (i.e. is part of an AuthorizedTarget association), the provider should update the access configuration in the underlying hardware as appropriate.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, 4101..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Invalid LogicalDevice Instance, Device Number Conflict, DeviceNumber Parameter Must Be Provided, Hardware Implementation Requires Null DeviceNumber, Busy, Method Reserved, Vendor Specific

#### Method Parameters (AttachDevice)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DeviceNumber | string

Description

string

The number assigned to ProtocolControllerForUnit.DeviceNumber (if supported by the hardware). Hardware support is indicated by ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). If the hardware does not support setting the number, but the DeviceNumber has not been established in an existing ProtocolControllerForDevice subclass, then this parameter's value will be used. If the DeviceNumber has been established, then the current number will be reused.

IN | boolean | true
ModelCorrespondence | string | CIM_ProtocolControllerForUnit.DeviceNumber
OUT | boolean | true
Device | REF CIM_LogicalDevice
Description | string | The LogicalDevice instance to attach.
IN | boolean | true
ProtocolController | REF CIM_ProtocolController
Description | string | The ProtocolController instance.
IN | boolean | true

#### DetachDevice (uint32)

#### Method Qualifiers (DetachDevice)

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

Description

string

This method removes the ProtocolControllerForDevice association subclass between the ProtocolController and a LogicalDevice, such as a StorageVolume or a MediaAccessDevice. When the ProtocolController is actively masking a device (i.e. is part of an AuthorizedTarget association, the management instrumentation provider should update the hardware access configuration when DetachDevice is called.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, LogicalDevice Instance not Associated with Controller, Busy, Method Reserved, Vendor Specific

#### Method Parameters (DetachDevice)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Device | REF CIM_LogicalDevice
Description | string | The LogicalDevice instance to detach.
IN | boolean | true
ProtocolController | REF CIM_ProtocolController
Description | string | The ProtocolController instance.
IN | boolean | true

#### ExposePaths (uint32)

#### Method Qualifiers (ExposePaths)

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

Description

string

Expose a list of SCSI logical units (such as RAID volumes or tape drives) to a list of initiators through a list of target ports, through one or more SCSIProtocolControllers (SPCs). The parameters for this method are: Job - null if no job created, otherwise this is a reference to the job. LUNames - the list of names of the logical units to use. InitiatorPortIDs - the names of the initiator ports to use. TargetPortIDs - the names of the target ports to use. DeviceNumbers - the device numbers (LUNs) to use. DeviceAccesses - permissions for the logical units. ProtocolControllers - SPCs involved in this operation. There are two modes of operation, create and modify. If a NULL value is passed in for the SPC, then the instrumentation will create at least one SPC that satisfies the request. Depending upon the instrumentation capabilities, more than one SPC MAY be created. (e.g. if CIM_ProtocolControllerMaskingCapabilities.OneHardwareIDPerView is true and more than one initiatorID was passed in, then one SPC per initiatorID will be created). If an SPC is passed in, then the instrumentation attempts to add the new paths to the existing SPC. Depending upon the instrumentation capabilities, this MAY result in the creation of additional SPCs. The instrumentation MAY return an error if honoring this request would violate SCSI semantics. For creating an SPC, the parameters that MUST be specified are dependent upon the SPCAllows* properties in CIM_ProtocolControllerMaskingCapabilities. If SPCAllowsNoLUs is false, the caller MUST specify a list of LUNames. If it is true, the caller MAY specify a list of LUNames or MAY pass in null. If SPCAllowsNoTargets is false and PortsPerView is not 'All Ports share the same view' the caller MUST specify a list of TargetPortIDs. If it is true, the caller MAY specify a list of TargetPortIDs or MAY pass in null. If SPCAllowsNoInitiators is false, the caller MUST specify a list of InitiatorPortIDs. If it is true, the caller MAY specify a list of InitiatorPortIDs or MAY pass in null. If LUNames is not null, the caller MUST specify DeviceAccesses for each logical unit. If the instrumentation's CIM_ProtocolControllerMaskingCapabilities ClientSelectableDeviceNumbers property is TRUE then the client MAY provide a list of device numbers (LUNs) to use for the paths to be created. If is false, the client MUST pass in NULL for this parameter. The LUNames, DeviceNumbers, and DeviceAccesses parameters are mutually indexed arrays - any element in DeviceNumbers or DeviceAccesses will set a property relative to the LogicalDevice instance named in the corresponding element of LUNames. LUNames and DeviceAccesses MUST have the same number of elements. DeviceNumbers MUST be null (asking the instrumentation to assign numbers) or have the same number of elements as LUNames. If these conditions are not met, the instrumentation MUST return a 'Invalid Parameter' status or a CIM_Error. For modifying an SPC, there are three specific use cases identified. The instrumentation MUST support these use cases. Other permutations are allowed, but are vendor-specific. The use cases are: Add LUs to a view, Add initiator IDs to a view, and Add target port IDs to a view. Add LUs to a view requires that the LUNames parameter not be null and that the InitiatorIDs and TargetPortIDs parameters be null. DeviceNumbers MAY be null if ClientSelectableDeviceNumbers is false. DeviceAccesses MUST be specified. Add initiator IDs to a view requires that the LUNames parameter be null, that the InitiatorIDs not be null, and that the TargetPortIDs parameters be null. DeviceNumbers and DeviceAccesses MUST be null. Add target port IDs to a view requires that the LUNames and InitiatorPortIDs parameters be null and is only possible is PortsPerView is 'Multiple Ports Per View'. DeviceNumbers and DeviceAccesses MUST also be null The relevant rules of SCSI semantics are: - an SPC MAY NOT be exposed through a particular host/target port pair that is in use by another SPC. (In other words, an SPC and its associated logical units and ports together correspond to the logical unit inventory provided by SCSI REPORT LUNS and INQUIRY commands) - each LogicalDevice associated to an SPC MUST have a unique ProtocolControllerForUnit DeviceNumber (logical unit number) The instrumentation MUST report an error if the client request would violate one of these rules. If the instrumentation provides PrivilegeManagementService, the results of setting DeviceAccesses MUST be synchronized with PrivilegeManagementService as described in the ProtocolControllerForUnit DeviceAccess description.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, 4101, 4102, 4103, 4104..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Invalid logical unit ID, Invalid initiator port ID, Invalid target port ID, Invalid permission, Target/initiator combination already exposed, Requested logical unit number in use, Maximum Map Count Exceeded, Method Reserved, Vendor Specific

#### Method Parameters (ExposePaths)

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

Description

string

A list of permissions to assign to the corresponding logical unit in the LUNames parameter. This specifies the permission to assign within the context of the elements specified in the other parameters. Setting this to 'No Access' assigns the DeviceNumber for the associated initiators, but does not grant read or write access. If the LUNames parameter is not null then this parameter MUST be specified.

IN | boolean | true
ModelCorrespondence | string | CIM_ProtocolControllerForUnit.DeviceAccessCIM_ControllerConfigurationService.ExposePaths.DeviceNumbers, CIM_ControllerConfigurationService.ExposePaths.LUNames
ValueMap | string | 0, 2, 3, 4, 5..15999, 16000..
Values | string | Unknown, Read Write, Read-Only, No Access, DMTF Reserved, Vendor Reserved
DeviceNumbers | string[]
ArrayType | string | Indexed
Description | string | A list of logical unit numbers to assign to the corresponding logical unit in the LUNames parameter. (within the context of the elements specified in the other parameters). If the LUNames parameter is null, then this parameter MUST be null. Otherwise, if this parameter is null, all LU numbers are assigned by the hardware or instrumentation.
IN | boolean | true
ModelCorrespondence | string | CIM_ProtocolControllerForUnit.DeviceNumberCIM_ControllerConfigurationService.ExposePaths.LUNames, CIM_ControllerConfigurationService.ExposePaths.DeviceAccesses
InitiatorPortIDs | string[]
Description | string | IDs of initiator ports. If existing StorageHardwareID instances exist, they MUST be used. If no StorageHardwareID instance matches, then one is implicitly created. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_StorageHardwareID.StorageID
LUNames | string[]
ArrayType | string | Indexed
Description | string | An array of IDs of logical unit instances. The LU instances MUST already exist. The members of this array MUST match the Name property of LogicalDevice instances that represent SCSI logical units. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_LogicalDevice.Name, CIM_ControllerConfigurationService.ExposePaths.DeviceNumbers, CIM_ControllerConfigurationService.ExposePaths.DeviceAccesses
Required | boolean | true
TargetPortIDs | string[]
Description | string | IDs of target ports. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_SCSIProtocolEndpoint.Name
ProtocolControllers | CIM_SCSIProtocolController[]

Description

string

An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If null on input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation MUST attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation MUST report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request.

IN | boolean | true
OUT | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job if 'Method Parameters Checked - Job Started' is returned (MAY be null if job completed).
IN | boolean | false
OUT | boolean | true

#### HidePaths (uint32)

#### Method Qualifiers (HidePaths)

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

Description

string

Hide a list of SCSI logical units (such as a RAID volume or tape drive) from a list of initiators and/or target ports on a SCSIProtocolController (SPC). The parameters for this method are: Job - null if no job created, otherwise this is a reference to the job. LUNames - the list of names of the logical units to use. InitiatorPortIDs - the names of the initiator ports to use. TargetPortIDs - the names of the target ports to use. ProtocolControllers - SPCs involved in this operation. When hiding logical units, there are three specific use cases identified. The instrumentation MUST support these use cases. Other permutations are allowed, but are vendor-specific. The use cases are: Remove LUs from a view, Remove initiator IDs from a view, and Remove target port IDs from a view. Remove LUs from a view requires that the LUNames parameter not be null and that the InitiatorIDs and TargetPortIDs parameters be null. Remove initiator IDs from a view requires that the LUNames parameter be null, that the InitiatorIDs not be null, and that the TargetPortIDs parameters be null. Remove target port IDs from a view requires that the LUNames and InitiatorPortIDs parameters be null. The disposition of the SPC when the last logical unit, initiator ID, or target port ID is removed depends upon the CIM_ProtocolControllerMaskingCapabilites SPCAllowsNo* properties. If SPCAllowsNoLUs is false, then the SPC is automatically deleted when the last logical unit is removed. If SPCAllowsNoTargets is false, then the SPC is automatically deleted when the last target port ID is removed. If SPCAllowsNoInitiators is false, then the SPC is automatically deleted when the last initiator port ID is removed. In all other cases, the SPC MUST be explicitly deleted via the DeleteInstance intrinsic function.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, 4101..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Invalid logical unit ID, Invalid initiator port ID, Invalid target port ID, Target/initiator combination not exposed, Method Reserved, Vendor Specific

#### Method Parameters (HidePaths)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
InitiatorPortIDs | string[]
Description | string | IDs of initiator ports. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_StorageHardwareID.StorageID
LUNames | string[]
Description | string | A list of IDs of logical units. Each LU instance MUST already exist. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_LogicalDevice.Name
Required | boolean | true
TargetPortIDs | string[]
Description | string | IDs of target ports. See the method description for conditions where this MAY be null.
IN | boolean | true
ModelCorrespondence | string | CIM_SCSIProtocolEndpoint.Name
ProtocolControllers | CIM_SCSIProtocolController[]

Description

string

An array of references to SCSIProtocolControllers (SPCs). On input, this MUST contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames, InitiatorPortIDs, or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request.

IN | boolean | true
OUT | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job if 'Method Parameters Checked - Job Started' is returned (MAY be null if job completed).
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

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