# Class CIM_ResourcePoolConfigurationService
extends CIM_Service

This service provides for active management of Resource Pools. It allows jobs to be started for the creation and deletion of ResourcePools as well as addition and subtraction of host resources from ResourcePools

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

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | This service provides for active management of Resource Pools. It allows jobs to be started for the creation and deletion of ResourcePools as well as addition and subtraction of host resources from ResourcePools
UMLPackagePath | string | CIM::Core::Resource
Version | string | 2.22.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

#### CreateResourcePool (uint32)

#### Method Qualifiers (CreateResourcePool)

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

Description

string

Starts a job to create a root ResourcePool. The ResourcePool will be scoped to the same System as this Service. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job. The resulting pool will be a root pool with no parent pool.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

#### Method Parameters (CreateResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | A end user relevant name for the pool being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created pool.
IN | boolean | true
ResourceType | string
Description | string | The type of resources the created poolwill manage. If HostResources contains elements, this property must mach their type.
IN | boolean | true
HostResources | CIM_LogicalDevice[]
Description | string | Array of zero or more devices that are used to create the Pool or modify the source extents. All elements in the array must be of the same type.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
Pool | REF CIM_ResourcePool
Description | string | On success, a reference to the resulting ResourcePool is returned. When a Job is returned, this may be NULL, in which case, the client must use the Job to find the resulting ResourcePool once the Job completes.
IN | boolean | false
OUT | boolean | true

#### CreateChildResourcePool (uint32)

#### Method Qualifiers (CreateChildResourcePool)

Name | Data Type | Value
--- | --- | ---
Description | string | Start a job to create a sub-pool from a parent pool using the specified allocation settings If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to create the sub-pool. The Job's reference will be returned in the output parameter Job.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, .., 4096, 4097, 4098..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, Insufficient Resources, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

#### Method Parameters (CreateChildResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | A end user relevant name for the pool being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.
IN | boolean | true
Settings | string[]
Description | string | String containing a representation of a CIM_SettingData instance that is used to specify the settings for the child Pool.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
IN | boolean | true
ModelCorrespondence | string | CIM_ResourcePoolConfigurationService.CreateChildResourcePool.ParentPool
ParentPool | CIM_ResourcePool[]
Description | string | The Pool(s) from which to create the new Pool.
IN | boolean | true
ModelCorrespondence | string | CIM_ResourcePoolConfigurationService.CreateChildResourcePool.Settings
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
Pool | REF CIM_ResourcePool
Description | string | A reference to the resulting pool.
IN | boolean | false
OUT | boolean | true

#### DeleteResourcePool (uint32)

#### Method Qualifiers (DeleteResourcePool)

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

Description

string

Start a job to delete a ResourcePool. No allocations may be outstanding or the delete will fail with "In Use." If the resource pool is a root resource pool, any host resources are returned back to the underlying system. If 0 is returned, the function completed successfully, and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the ResourcePool. A reference to the Job is returned in the Job parameter.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (DeleteResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
Pool | REF CIM_ResourcePool
Description | string | Reference to the pool to delete.
IN | boolean | true

#### AddResourcesToResourcePool (uint32)

#### Method Qualifiers (AddResourcesToResourcePool)

Name | Data Type | Value
--- | --- | ---
Description | string | Starts a job to add resources to a ResourcePool. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job. The resulting pool will be a root pool with no parent pool.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

#### Method Parameters (AddResourcesToResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
HostResources | CIM_LogicalDevice[]
Description | string | Array of CIM_LogicalDevice instances to add to the Pool.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
Pool | REF CIM_ResourcePool
Description | string | The pool to add the resources to.
IN | boolean | true

#### RemoveResourcesFromResourcePool (uint32)

#### Method Qualifiers (RemoveResourcesFromResourcePool)

Name | Data Type | Value
--- | --- | ---
Description | string | Starts a job to remove resources from a ResourcePool. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job. The resulting pool will be a root pool with no parent pool.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

#### Method Parameters (RemoveResourcesFromResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
HostResources | CIM_LogicalDevice[]
Description | string | Array of CIM_LogicalDevice instances to remove from the Pool.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
Pool | REF CIM_ResourcePool
Description | string | The pool to remove the resources from.
IN | boolean | true

#### ChangeParentResourcePool (uint32)

#### Method Qualifiers (ChangeParentResourcePool)

Name | Data Type | Value
--- | --- | ---
Description | string | Start a job to change a parent pool using the specified allocation settings If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to change the parent pool. The Job's reference will be returned in the output parameter Job.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, .., 4096, 4097, 4098..32767, 32768..65535
Values | string | Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Incorrect ResourceType for the Pool, Insufficient Resources, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

#### Method Parameters (ChangeParentResourcePool)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Settings | string[]
Description | string | Optional string containing a representation of a CIM_SettingData instance that is used to specify the settings for the Parent Pool.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
IN | boolean | true
ModelCorrespondence | string | CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.Settings
ParentPool | CIM_ResourcePool[]
Description | string | Reference to the parent pool(s).
IN | boolean | true
ChildPool | REF CIM_ResourcePool
Description | string | Reference to the child pool.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
ModelCorrespondence | string | CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.ParentPool
OUT | boolean | true

### Inherited Class Methods

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