CIM_ResourcePool class
Represents a resource pool, which is a logical entity provided by the host system to allocate and assign resources.
A given resource pool may be used to allocate resources of a specific type. Hierarchies of resource pools can provide administrative control over resource allocation.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::Resource")]
class CIM_ResourcePool : CIM_LogicalElement
{
string Caption;
string Description;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
string InstanceID;
string PoolID;
boolean Primordial = FALSE;
uint64 Capacity;
uint64 Reserved;
uint16 ResourceType;
string OtherResourceType;
string ResourceSubType;
string AllocationUnits;
string ConsumedResourceUnits = "count";
uint64 CurrentlyConsumedResource;
uint64 MaxConsumableResource;
};
Members
The CIM_ResourcePool class has these types of members:
Properties
The CIM_ResourcePool class has these properties.
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: IsPUnit
The units of allocation used by the Reservation and Limit properties. For example, when ResourceType is set to "Processor", AllocationUnits may be set to "hertz*10^6" or "percent". The value of this property should be a legal value of the Programmatic Units qualifier from Appendix C.1 of DSP0004 V2.4 or later.
-
-
Capacity
-
-
Data type: uint64
-
Access type: Read-only
The maximum amount of reservations that the resource pool can support. The AllocationUnits property specifies the unit type.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CommunicationStatus
-
-
Data type: uint16
-
Access type: Read-only
Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.
This property is inherited from CIM_ManagedSystemElement.
-
-
Unknown (0)
-
Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.
-
Not Available (1)
-
Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.
-
Communication OK (2)
-
Indicates only that communication is established with the element.
-
Lost Communication (3)
-
Indicates that the element has been contacted in the past, but is currently unreachable.
-
No Contact (4)
-
Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.
-
DMTF Reserved
-
Reserved.
-
Vendor Reserved
-
Reserved.
ConsumedResourceUnits
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.MaxConsumableResource", "CIM_ResourcePool.CurrentlyConsumedResource"), IsPUnit
The units for the MaxConsumable and the Consumed properties.
CurrentlyConsumedResource
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.ConsumedResourceUnits")
The amount of resource that the resource pool currently presents to resource consumers. This property is different from the Reserved property because it describes the consumers view of the resource while the Reserved property describes the producers view of the resource.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
DetailedStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")
Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.
This property is inherited from CIM_ManagedSystemElement.
Not Available (0)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
No Additional Information (1)
Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.
Stressed (2)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (3)
Indicates that an element functions nominally, but predicts a failure in the near future.
Non-Recoverable Error (4)
Indicates that this element is in an error condition that requires human intervention.
Supporting Entity in Error (5)
Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
ElementName
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
This property is inherited from CIM_ManagedElement.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
InstanceID
Uniquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
MaxConsumableResource
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.ConsumedResourceUnits")
The maximum of amount of consumable resources that the resource pool can present to resource consumers. This property is different from the Capacity property because it describes the consumers view of the resource while the Capacity property describes the producers view of the resource.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
The label by which the object is known. When subclassed, the Name property can be overridden to be a key property.
This property is inherited from CIM_ManagedSystemElement.
OperatingStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
Indicates that the instrumentation cannot report on the OperatingStatus property at this time.
Not Available (1)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
Servicing (2)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
Starting (3)
Indicates that the element is being initialized.
Stopping (4)
Indicates that the element is being brought to an orderly stop.
Stopped (5)
Indicates that the element is intentionally stopped.
Aborted (6)
Indicates that the element stopped in an unexpected way.
Dormant (7)
Indicates that the element is inactive.
Completed (8)
Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.
Migrating (9)
Indicates that the element is being moved between host elements.
Emigrating (10)
Indicates that the element is being moved away from the host element.
Immigrating (11)
Indicates that the element is being moved to a new host element.
Snapshotting (12)
Indicates that a snapshot copy of the element is being created.
Shutting Down (13)
Indicates that the element is being brought to an abrupt stop.
In Test (14)
Indicates that the element is performing test functions.
Transitioning (15)
Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.
In Service (16)
Indicates that the element is in service and operational.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.
Note
The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
OtherResourceType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.ResourceType")
The resource type when the ResourceType property is set to "0" (other).
PoolID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.PoolId")
An opaque identifier for the pool. This property is used to provide correlation when saving and restoring configuration data to underlying persistent storage.
PrimaryStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")
Indicates a high-level status value.
This property is inherited from CIM_ManagedSystemElement.
The possible values are.
Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved
Vendor Reserved
Primordial
-
Data type: boolean
-
Access type: Read-only
true if the resource pool is primordial. false if the resource pool is a concrete resource pool. A primordial resource pool is a resource pool that is not created or deleted by consumers of the resource. A concrete resource pool can be updated by resource allocation services.
Reserved
-
Data type: uint64
-
Access type: Read-only
The current number of reservations spread across all active allocations from this pool. In a hierarchical configuration, this represents the sum of all current descendant reservations. The AllocationUnits property specifies the unit type.
ResourceSubType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.ResourceType")
The implementation specific sub-type for the resource pool. For example, this may be used to distinguish different models of the same resource type.
ResourceType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.OtherResourceType", "CIM_ResourcePool.ResourceSubType")
The type of resource allocated by the resource pool.
The possible values are:
Other (1)
Computer System (2)
Processor (3)
Memory (4)
IDE Controller (5)
Parallel SCSI HBA (6)
FC HBA (7)
iSCSI HBA (8)
IB HCA (9)
Ethernet Adapter (10)
Other Network Adapter (11)
I/O Slot (12)
I/O Device (13)
Floppy Drive (14)
CD Drive (15)
DVD drive (16)
Disk Drive (17)
Tape Drive (18)
Storage Extent (19)
Other storage device (20)
Serial port (21)
Parallel port (22)
USB Controller (23)
Graphics controller (24)
IEEE 1394 Controller (25)
Partitionable Unit (26)
Base Partitionable Unit (27)
Power (28)
Cooling Capacity (29)
Ethernet Switch Port (30)
Logical Disk (31)
Storage Volume (32)
Ethernet Connection (33)
DMTF reserved
Vendor Reserved
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Indicates the primary status of the object.
Note
This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.
This property is inherited from CIM_ManagedSystemElement.
The possible values are.
("OK")
("Error")
("Degraded")
("Unknown")
("Pred Fail")
("Starting")
("Stopping")
("Service")
("Stressed")
("NonRecover")
("No Contact")
("Lost Comm")
("Stopped")
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|