Msvm_ProcessorPool class

Article
05/31/2018

Aggregates the processor resources that may be allocated to a virtual system.

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_ProcessorPool : CIM_ResourcePool
{
  string   Caption = "Processor Resource Pool";
  string   Description = "Resource Pool used to allocate Microsoft Virtual Processor Pool resources to a virtual machine";
  datetime InstallDate;
  string   Name = "Processor Resource Pool";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  string   InstanceID = "Microsoft:GUID\Root";
  boolean  Primordial = FALSE;
  uint64   Capacity = 100000;
  uint64   Reserved = 0;
  uint16   ResourceType = 3;
  string   OtherResourceType;
  string   ResourceSubType = "Microsoft Processor";
  string   AllocationUnits = "Processor Cores";
  string   ElementName = "Processor Resource Pool";
  string   StatusDescriptions[] = { "OK" };
  string   PoolID = "GUID";
};

Members

The Msvm_ProcessorPool class has these types of members:

Methods
Properties

Methods

The Msvm_ProcessorPool class has these methods.

Method	Description
CalculatePossibleReserve	Used to find the actual processor reserve. Windows Server 2008: Before Windows Server 2008 R2, this method does nothing and always returns 0.

Properties

The Msvm_ProcessorPool 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 always set to "Processor Cores".

Capacity

Data type: uint64
Access type: Read-only

The maximum amount (in units of AllocationUnits) of reservations that the resource pool can support. This property is inherited from CIM_ResourcePool and it is always set to 100000.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Processor Resource Pool".

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Resource Pool used to allocate Microsoft Virtual Processor Pool resources to a virtual machine".

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. Note that the Name property of the CIM_ManagedSystemElement class is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. This property is inherited from CIM_ManagedElement and it is always set to "Processor Resource Pool".

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time at which the virtual system was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

A unique identifier for this resource pool. This property is inherited from CIM_ResourcePool and it is always set to "Microsoft:GUID\Root".

Name

Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

The 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 and it is always set to "Processor Resource Pool".

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the element. This property is inherited from CIM_ManagedSystemElement and it is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherResourceType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.ResourceType")

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 always set to NULL.

PoolID

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.PoolId")

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 "GUID".

Primordial

Data type: boolean
Access type: Read-only

If TRUE, this resource pool is the base from which resources are drawn and returned in the activity of resource management. Being primordial means that this resource pool 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 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 and it is always set to 0.

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 and it is always set to "Microsoft Processor".

ResourceType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")

The type of resource this resource pool may allocate. This property is inherited from CIM_ResourcePool and it is always set to 3 (CPU).

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and it is always set to "OK".

Remarks

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

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Partager via