CIM_ResourcePool class

Represents a resource pool, which is a logical entity provided by the host system to allocate and assign resources.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::Resource"), AMENDMENT]
class CIM_ResourcePool : CIM_LogicalElement
{
  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

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.

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.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key, Override ("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.

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.

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.

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 (0x8000..0xFFFF)

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

CIM_LogicalElement