Msvm_ResourcePool class

Article
01/07/2021

Describes a type of virtual resource available for use in virtual machines. The resource pool aggregates physical resources and is used to allocate resources to virtual machines. In Hyper-V, all resource pools are primordial, and there is exactly one pool for each specific type of resource which may be allocated to a virtual machine.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_ResourcePool : CIM_ResourcePool
{
  string   InstanceID;
  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   PoolID = "Microsoft:GUID\Root";
  boolean  Primordial = False;
  uint64   Capacity;
  uint64   Reserved;
  uint16   ResourceType = 4;
  string   OtherResourceType;
  string   ResourceSubType;
  string   AllocationUnits = "Megabyte";
  string   ConsumedResourceUnits = "count";
  uint64   CurrentlyConsumedResource;
  uint64   MaxConsumableResource;
};

Members

The Msvm_ResourcePool class has these types of members:

Properties

Properties

The Msvm_ResourcePool class has these properties.

AllocationUnits

Data type: string
Access type: Read-only

The units of allocation used by the resource pool. This property is inherited from CIM_ResourcePool, and it is set to "Megabyte".

Capacity

Data type: uint64
Access type: Read-only

The maximum amount (in units of AllocationUnits) of active reservations that the resource pool can support. This property is inherited from CIM_ResourcePool.

Caption

Data type: string
Access type: Read-only

A short 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 the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ConsumedResourceUnits

Data type: string
Access type: Read-only

Specifies the units for the MaxConsumableResource and the CurrentlyConsumedResource properties.

CurrentlyConsumedResource

Data type: uint64
Access type: Read-only

Specifies the amount of resource that the resource pool currently presents to consumers. This property is different from the Reserved property in that 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 description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime
Access type: Read-only

The date and time when 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

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

MaxConsumableResource

Data type: uint64
Access type: Read-only

Specifies the maximum amount of consumable resource that the resource pool can present to consumers. This property is different from the Capacity property in that 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

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: Override ("OperationalStatus"), ArrayType ("Indexed")

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.

If no QoS related conditions have been detected, the primary status (OperationalStatus[0]) is set to OK (2). Otherwise, the primary status is set to Degraded (3), and one or more secondary status values is filled in the array, starting at index 1, which report more specific conditions, according to this table.

Value	Description
Insufficient Throughput (32788)	At least one of the virtual disks allocated from the pool is currently reporting an Insufficient Throughput status.

The Hyper-V WMI provider raises an Msvm_StorageAlert event each time the OperationalStatus of the Msvm_ResourcePool class changes.

OK (2)

Degraded (3)

Non-Recoverable Error (7)

No Contact (12)

Lost Communication (13)

Protocol Mismatch (32775)

Insufficient Throughput (32788)

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 0 ("Other"). This property is inherited from CIM_ResourcePool and it is set to Null.

PoolID

Data type: string
Access type: Read-only

This value is referenced by the CIM_ResourceAllocationSettingData instances which were allocated from this pool. This property is inherited from CIM_ResourcePool, and it is always set to "Microsoft:GUID\Root".

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

Primordial

Data type: boolean
Access type: Read-only

True if this resource pool is the base from which resources are drawn and returned in the activity of resource management; otherwise, False. Being primordial means that this resource pool cannot be created or deleted by consumers of this model. However, other actions, modeled or not, may affect the characteristics or size of primordial resource pools. This property is inherited from CIM_ResourcePool.

Reserved

Data type: uint64
Access type: Read-only

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 resource pool current reservations. This property is inherited from CIM_ResourcePool.

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. This property is inherited from CIM_ResourcePool.

ResourceType

Data type: uint16
Access type: Read-only

The type of resource this resource pool may allocate. This property is inherited from CIM_ResourcePool, and it is set to 4 ("Memory").

Status

Data type: string
Access type: Read-only

The current status of the object. This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

Remarks

Access to the Msvm_ResourcePool class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe