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

NameData TypeValue
DescriptionstringThis 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
UMLPackagePathstringCIM::Core::Resource
Versionstring2.22.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
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

CreateResourcePool (uint32)

Method Qualifiers (CreateResourcePool)

NameData TypeValue
DescriptionstringStarts 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA 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.
INbooleantrue
ResourceTypestring
DescriptionstringThe type of resources the created poolwill manage. If HostResources contains elements, this property must mach their type.
INbooleantrue
HostResourcesCIM_LogicalDevice[]
DescriptionstringArray 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.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_ResourcePool
DescriptionstringOn 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.
INbooleanfalse
OUTbooleantrue

CreateChildResourcePool (uint32)

Method Qualifiers (CreateChildResourcePool)

NameData TypeValue
DescriptionstringStart 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA 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.
INbooleantrue
Settingsstring[]
DescriptionstringString containing a representation of a CIM_SettingData instance that is used to specify the settings for the child Pool.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
INbooleantrue
ModelCorrespondencestringCIM_ResourcePoolConfigurationService.CreateChildResourcePool.ParentPool
ParentPoolCIM_ResourcePool[]
DescriptionstringThe Pool(s) from which to create the new Pool.
INbooleantrue
ModelCorrespondencestringCIM_ResourcePoolConfigurationService.CreateChildResourcePool.Settings
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_ResourcePool
DescriptionstringA reference to the resulting pool.
INbooleanfalse
OUTbooleantrue

DeleteResourcePool (uint32)

Method Qualifiers (DeleteResourcePool)

NameData TypeValue
DescriptionstringStart 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_ResourcePool
DescriptionstringReference to the pool to delete.
INbooleantrue

AddResourcesToResourcePool (uint32)

Method Qualifiers (AddResourcesToResourcePool)

NameData TypeValue
DescriptionstringStarts 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
HostResourcesCIM_LogicalDevice[]
DescriptionstringArray of CIM_LogicalDevice instances to add to the Pool.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_ResourcePool
DescriptionstringThe pool to add the resources to.
INbooleantrue

RemoveResourcesFromResourcePool (uint32)

Method Qualifiers (RemoveResourcesFromResourcePool)

NameData TypeValue
DescriptionstringStarts 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
HostResourcesCIM_LogicalDevice[]
DescriptionstringArray of CIM_LogicalDevice instances to remove from the Pool.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_ResourcePool
DescriptionstringThe pool to remove the resources from.
INbooleantrue

ChangeParentResourcePool (uint32)

Method Qualifiers (ChangeParentResourcePool)

NameData TypeValue
DescriptionstringStart 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob 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)

NameTypeQualifiers
NameData TypeValue
Settingsstring[]
DescriptionstringOptional string containing a representation of a CIM_SettingData instance that is used to specify the settings for the Parent Pool.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
INbooleantrue
ModelCorrespondencestringCIM_ResourcePoolConfigurationService.ChangeParentResourcePool.Settings
ParentPoolCIM_ResourcePool[]
DescriptionstringReference to the parent pool(s).
INbooleantrue
ChildPool REF CIM_ResourcePool
DescriptionstringReference to the child pool.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
ModelCorrespondencestringCIM_ResourcePoolConfigurationService.ChangeParentResourcePool.ParentPool
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service