CIM_ResourcePoolConfigurationService, ROOT\virtualization\v2

Class | Methods (9) | Properties (28) | Qualifiers (4) | Instances | Namespaces (1)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

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

CIM_ResourcePoolConfigurationService methods

CIM_ResourcePoolConfigurationService has 9 methods (6 Local, 3 Derived)

NameOriginReturn
AddResourcesToResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
ChangeParentResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
CreateChildResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
CreateResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
DeleteResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
RemoveResourcesFromResourcePoolCIM_ResourcePoolConfigurationServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

CIM_ResourcePoolConfigurationService properties

CIM_ResourcePoolConfigurationService has 28 properties (28 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of CIM_ResourcePoolConfigurationService methods

Local methods (6) of CIM_ResourcePoolConfigurationService class

AddResourcesToResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
HostResourcesref:CIM_LogicalDevice0-{'Description':'Array of CIM_LogicalDevice instances to add to the Pool.'}
Poolref:CIM_ResourcePool1-{'Description':'The pool to add the resources to.'}
Jobref:CIM_ConcreteJob2-{'Description':'Reference to the job (may be null if job completed).'}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '..', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
AddResourcesToResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace
ChangeParentResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ChildPoolref:CIM_ResourcePool0-{'Description':'Reference to the child pool.'}
ParentPoolref:CIM_ResourcePool1-{'Description':'Reference to the parent pool(s).'}
Settingsstring2-{'Description':'Optional string containing a representation of a CIM_SettingData instance that is used to specify the settings for the Parent Pool.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','ModelCorrespondence':['CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.Settings']}
Jobref:CIM_ConcreteJob3-{'Description':'Reference to the job (may be null if job completed).','ModelCorrespondence':['CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.ParentPool']}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '8', '..', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
ChangeParentResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace
CreateChildResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ElementNamestring0-{'Description':'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.'}
Settingsstring1-{'Description':'String containing a representation of a CIM_SettingData instance that is used to specify the settings for the child Pool.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','ModelCorrespondence':['CIM_ResourcePoolConfigurationService.CreateChildResourcePool.ParentPool']}
ParentPoolref:CIM_ResourcePool2-{'Description':'The Pool(s) from which to create the new Pool.','ModelCorrespondence':['CIM_ResourcePoolConfigurationService.CreateChildResourcePool.Settings']}
Poolref:CIM_ResourcePool3-{'Description':'A reference to the resulting pool.'}
Jobref:CIM_ConcreteJob4-{'Description':'Reference to the job (may be null if job completed).'}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '8', '..', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
CreateChildResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace
CreateResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ElementNamestring0-{'Description':'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.'}
HostResourcesref:CIM_LogicalDevice1-{'Description':'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.'}
ResourceTypestring2-{'Description':'The type of resources the created poolwill manage. If HostResources contains elements, this property must mach their type.'}
Poolref:CIM_ResourcePool3-{'Description':'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.'}
Jobref:CIM_ConcreteJob4-{'Description':'Reference to the job (may be null if job completed).'}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '..', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
CreateResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace
DeleteResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Poolref:CIM_ResourcePool0-{'Description':'Reference to the pool to delete.'}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (may be null if job completed).'}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '..', '4096', '4097..32767', '32768..65535']
Values['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']
DeleteResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace
RemoveResourcesFromResourcePool method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
HostResourcesref:CIM_LogicalDevice0-{'Description':'Array of CIM_LogicalDevice instances to remove from the Pool.'}
Poolref:CIM_ResourcePool1-{'Description':'The pool to remove the resources from.'}
Jobref:CIM_ConcreteJob2-{'Description':'Reference to the job (may be null if job completed).'}
Description'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['0', '1', '2', '3', '4', '5', '6', '7', '..', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
RemoveResourcesFromResourcePool method is in 1 class (CIM_ResourcePoolConfigurationService) of ROOT\virtualization\v2 and in 1 namespace

Derived methods (3) of CIM_ResourcePoolConfigurationService class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
StartService method
Returnuint32 {'out':True}
StartService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StopService method
Returnuint32 {'out':True}
StopService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces

Detailed description of CIM_ResourcePoolConfigurationService properties

Derived properties (28) of CIM_ResourcePoolConfigurationService class

AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
Started property
CIMTYPE'boolean'
Started property is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StartMode property
CIMTYPE'string'
StartMode property is in 23 classes of ROOT\virtualization\v2 and in 15 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

CIM_ResourcePoolConfigurationService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'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'CIM::Core::Resource'
Version'2.22.0'

CIM_ResourcePoolConfigurationService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_ResourcePoolConfigurationService'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT28___SYSTEM3
__RELPATH'CIM_ResourcePoolConfigurationService'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_Service'___SYSTEM8
__CLASS'CIM_ResourcePoolConfigurationService'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_ResourcePoolConfigurationService

Number of classes:43
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ForwardingService2343---
CIM_HostedService220-10-
CIM_MetricService1289-1-
CIM_MetricServiceCapabilities1130-1-
CIM_NetworkService1323---
CIM_Service12283-1-
CIM_ServiceAccessPoint1241---
CIM_ServiceAffectsElement140-40-
CIM_ServiceComponent120---
CIM_ServiceSAPDependency120---
CIM_SwitchService0383---
CIM_SwitchServiceTransparentBridging020---
CIM_TransparentBridgingService1363---
CIM_VirtualSystemManagementService2289-2-
CIM_VirtualSystemMigrationService1287-1-
CIM_VirtualSystemSnapshotService1286-1-
Msvm_GuestFileService0284----
Msvm_GuestService1283----
Msvm_GuestServiceInterfaceComponent0388----
Msvm_GuestServiceInterfaceComponentSettingData02401---
Msvm_HostedService02010---
Msvm_HostedSwitchService020----
Msvm_ImageManagementService028161---
Msvm_MetricService028101---
Msvm_MetricServiceCapabilities01301---
Msvm_MetricServiceSettingData0501---
Msvm_RegisteredGuestService020----
Msvm_ReplicationService028291---
Msvm_ReplicationServiceSettingData01101---
Msvm_ResourcePoolConfigurationService02871---
Msvm_ServiceAffectsElement04040---
Msvm_Synthetic3DService02861---
Msvm_Synthetic3DServiceSettingData0501---
Msvm_TerminalService02871---
Msvm_TerminalServiceSettingData0901---
Msvm_TransparentBridgingService0363----
Msvm_VirtualEthernetSwitchManagementService028121---
Msvm_VirtualSystemManagementService028331---
Msvm_VirtualSystemManagementServiceSettingData01701---
Msvm_VirtualSystemMigrationService031151---
Msvm_VirtualSystemMigrationServiceSettingData01001---
Msvm_VirtualSystemMigrationServiceSettingDataComponent020----
Msvm_VirtualSystemSnapshotService02881---
comments powered by Disqus
WUtils.com