CIM_ResourcePool class
Represents a logical entity (with associated controls) provided by the host system for the purpose of allocation and assignment of resources. A given ResourcePool may be used to allocate resources of a specific type. Hierarchies of ResourcePools may be created to provide administrative control over allocations. In the cases where resources are subdivided, multiple resource pools may exist (for example, nodal boundaries in NUMA-like systems). In systems that support over commitment, pools represent the reservable capacity, not an upper bound or limit on the maximum amount that can be allocated. Admission control during power on may detect and prevent systems from powering due to resource depletion. For example, over commitment on a ResourcePool with ResourceType=Memory would require that sufficient space be available in some backing-store, which could be managed through a storage ResourcePool.
Important The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
class CIM_ResourcePool : CIM_LogicalElement
{
string Status;
string Name;
datetime InstallDate;
string Description;
string Caption;
string InstanceID;
string PoolID;
boolean Primordial = false;
uint64 Capacity;
uint64 Reserved;
uint16 ResourceType;
string OtherResourceType;
string ResourceSubType;
string AllocationUnits;
};
Members
The CIM_ResourcePool class has these types of members:
- Properties
Properties
The CIM_ResourcePool class has these properties.
AllocationUnits
Data type: string
Access type: Read-only
This property specifies the units of allocation used by the ResourcePool. For example, when ResourceType=Processor, AllocationUnits may be set to MHz. When ResourceType=Memory, AllocationUnits may be set to MB
Capacity
Data type: uint64
Access type: Read-only
This property represents the maximum amount (in units of AllocationUnits) of reservations that the ResourcePool can support.
Caption
Data type: string
Access type: Read-only
Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.
Description
Data type: string
Access type: Read-only
Textual description of the object. This property is inherited from CIM_ManagedSystemElement.
InstallDate
Data type: datetime
Access type: Read-only
Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.
InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must ensure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.
Name
Data type: string
Access type: Read-only
Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.
OtherResourceType
Data type: string
Access type: Read-only
A string that describes the resource type when a well defined value is not available and ResourceType is set to zero for Other.
PoolID
Data type: string
Access type: Read-only
An opaque identifier for the pool. This property is used to provide correlation across save and restore of configuration data to underlying persistent storage.
Primordial
Data type: boolean
Access type: Read-only
If true, "Primordial" indicates that this ResourcePool is the base from which resources are drawn and returned in the activity of resource management. Being primordial means that this ResourcePool shall not be created or deleted by consumers of this model. However, other actions, modeled or not, may affect the characteristics or size of primordial ResourcePools. If false, "Primordial" indicates that the ResourcePool, a concrete Resource Pool, is subject to resource allocation services functions. This distinction is important because higher-level ResourcePools may be assembled using the Component or ElementAllocatedFromPool associations. Although the higher-level abstractions can be created and deleted, the most basic, (that is, primordial), hardware-based ResourcePools cannot. They are physically realized as part of the System, or are actually managed by some other System and imported as if they were physically realized.
Reserved
Data type: uint64
Access type: Read-only
This property represents the current reservations (in units of AllocationUnits) spread across all active allocations from this pool. In a hierarchical configuration, this represents the sum of all descendant ResourcePool current reservations.
ResourceSubType
Data type: string
Access type: Read-only
A string that describes an implementation specific sub-type for this pool. For example, this may be used to distinguish different models of the same resource type.
ResourceType
Data type: uint16
Access type: Read-only
The type of resource this ResourcePool may allocate.
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)
Serial port (17)
Parallel port (18)
USB Controller (19)
Graphics controller (20)
Storage Extent (21)
Disk (22)
Tape (23)
Other storage device (24)
Firewire Controller (25)
Partitionable Unit (26)
Base Partitionable Unit (27)
Power Supply (28)
Cooling Device (29)
DMTF Reserved (..)
Vendor Reserved (32767..65535)
Status
Data type: string
Access type: Read-only
Current status of the object. This property is inherited from CIM_ManagedSystemElement.
Values include the following:
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
Requirements
Namespace |
Root\CIMV2 |