Edit

Share via

Msvm_ProcessorSettingData class

  • Article

Represents the virtual processor settings for 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_ProcessorSettingData : CIM_ResourceAllocationSettingData
{
  string  InstanceID;
  string  Caption = "Processor";
  string  Description = "A logical processor of the hypervisor running on the host computer system.";
  string  ElementName;
  uint16  ResourceType = 3;
  string  OtherResourceType;
  string  ResourceSubType = "Microsoft:Hyper-V:Processor";
  string  PoolID;
  uint16  ConsumerVisibility;
  string  HostResource[];
  string  AllocationUnits = "percent / 1000";
  uint64  VirtualQuantity = "count";
  uint64  Reservation = 0;
  uint64  Limit = 100000;
  uint32  Weight = 100;
  boolean AutomaticAllocation = True;
  boolean AutomaticDeallocation = True;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  AddressOnParent;
  string  VirtualQuantityUnits = "count";
  boolean LimitCPUID;
  uint64  HwThreadsPerCore;
  boolean LimitProcessorFeatures;
  uint64  MaxProcessorsPerNumaNode;
  uint64  MaxNumaNodesPerSocket;
  boolean EnableHostResourceProtection;
  string  CpuGroupId;
  boolean HideHypervisorPresent;
  boolean ExposeVirtualizationExtensions;
};

Members

The Msvm_ProcessorSettingData class has these types of members:

Properties

The Msvm_ProcessorSettingData class has these properties.

Address

Data type: string

Access type: Read-only

The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

AddressOnParent

Data type: string

Access type: Read-only

Describes the address of this resource in the context of the parent. The Parent and AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. This property is inherited from CIM_ResourceAllocationSettingData.

AllocationUnits

Data type: string

Access type: Read-only

The units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticAllocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticDeallocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short description of the object. This property is inherited from CIM_ManagedElement.

Connection

Data type: string array

Access type: Read-only

The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData.

ConsumerVisibility

Data type: uint16

Access type: Read-only

Describes the consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData.

CpuGroupId

Data type: string

Access type: Read-only

The Cpu Group Id this VM is bound to. When value is 0 it means is not bound to a specific CPU group.

Note

This property was added in Windows 10, version 1703.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_SettingData. Changing this property will change the ElementName of the associated logical device derivative.

EnableHostResourceProtection

Data type: boolean

Access type: Read-only

Indicates whether the VM should enable features that increase the protection of host resources from workload running in the VM.

Note

Added in Windows 10.

ExposeVirtualizationExtensions

Data type: boolean

Access type: Read-only

Indicates whether Hyper-V should expose virtualized hardware virtualization extensions to the VM.

Note

This property was added in Windows 10, version 1703.

HideHypervisorPresent

Data type: boolean

Access type: Read-only

Indicates whether Hyper-V should report that a hypervisor is present to the nested guest.

Note

This property was added in Windows 10, version 1703.

HostResource

Data type: string array

Access type: Read-only

Exposes a specific assignment to host or underlying resources. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to Null.

HwThreadsPerCore

Data type: uint64

Access type: Read-only

Indicates the number of SMT threads per core reported to the guest. This reporting is independent of whether the hardware for SMT is present.

Note

This property was added in Windows 10, version 1703.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

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

Limit

Data type: uint64

Access type: Read-only

The maximum amount of CPU resources that may be consumed by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

100000

Range: 0 100000

LimitCPUID

Data type: boolean

Access type: Read-only

Indicates whether the virtual machine should lower the CPU identifier. Some older operating systems may require you to limit processor functionality in this way in order to run.

LimitProcessorFeatures

Data type: boolean

Access type: Read-only

Indicates whether the virtual machine should limit the CPU features exposed to the operating system. Limiting the processor features enables the virtual machine to be migrated to different host computer systems with different processors. Migrating virtual machines between computers with processors from different vendors is not supported.

MappingBehavior

Data type: uint16

Access type: Read-only

Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData.

MaxNumaNodesPerSocket

Data type: uint64

Access type: Read-only

The maximum number of NUMA nodes that can be observed within the virtual machine as belonging to a single processor socket.

MaxProcessorsPerNumaNode

Data type: uint64

Access type: Read-only

The maximum number of virtual processors that can be observed within the virtual machine as belonging to a single virtual NUMA node.

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 has the value 1 (Other). This property is inherited from CIM_ResourceAllocationSettingData.

Parent

Data type: string

Access type: Read-only

The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

PoolID

Data type: string

Access type: Read-only

The identifier of the resource pool from which this resource was allocated. This property is inherited from CIM_ResourceAllocationSettingData.

Reservation

Data type: uint64

Access type: Read-only

The amount of CPU resources that are reserved for use by the virtual machine. These resources are guaranteed to be available for consumption by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

0

Range: 0 100000

ResourceSubType

Data type: string

Access type: Read-only

A string that describes an implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceType

Data type: uint16

Access type: Read-only

The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantity

Data type: uint64

Access type: Read-only

The total number of cores in the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantityUnits

Data type: string

Access type: Read-only

Specifies the unit of measurement for this resource allocation. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Annex C.1 of DSP0004 V2.5 or later. This property is inherited from CIM_ResourceAllocationSettingData.

Weight

Data type: uint32

Access type: Read-only

The weight for each virtual machine processor. After all reserves have been met, the remaining physical processor capacity of the hosting platform will be allocated to virtual machines based on their relative weights. This property is inherited from CIM_ResourceAllocationSettingData.

100

Range: 0 10000

Remarks

Access to the Msvm_ProcessorSettingData 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

See also

CIM_ResourceAllocationSettingData

CIM_ResourceAllocationSettingData

Processor Classes