Msvm_ProcessorSettingData class

Article
05/31/2018

Represents the virtual processor settings for a virtual machine (VM).

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  Caption = "Processor";
  string  Description = "Settings for Microsoft Virtual Processor";
  string  InstanceID;
  string  ElementName = "Processor";
  uint16  ResourceType = 3;
  string  OtherResourceType;
  string  ResourceSubType = "Microsoft Processor";
  string  PoolID;
  uint16  ConsumerVisibility;
  string  HostResource[];
  string  AllocationUnits = "Processor Cores";
  uint64  VirtualQuantity;
  uint64  Reservation;
  uint64  Limit;
  uint32  Weight;
  boolean AutomaticAllocation = True;
  boolean AutomaticDeallocation = True;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  boolean IsVirtualized = True;
  string  DeviceID = "Microsoft:GUID";
  string  DeviceIDFormat;
  uint16  ProcessorsPerSocket;
  uint16  SocketCount;
  boolean ThreadsEnabled;
  boolean LimitCPUID;
  boolean LimitProcessorFeatures;
};

Members

The Msvm_ProcessorSettingData class has these types of members:

Properties

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

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

AutomaticAllocation

Data type: boolean
Access type: Read-only

Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to True.

AutomaticDeallocation

Data type: boolean
Access type: Read-only

Indicates whether the resource will be automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to True.

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

Connection

Data type: string array
Access type: Read-only

The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.

ConsumerVisibility

Data type: uint16
Access type: Read-only

Describes the consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.

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 "Settings for Microsoft Virtual Processor".

DeviceID

Data type: string
Access type: Read-only

Address or other identifying information to uniquely name the logical device. This property is always set to "Microsoft:GUID".

DeviceIDFormat

Data type: string
Access type: Read-only

The format of the corresponding device ID, or the supported device IDs when used to represent a capability. This property is not used.

ElementName

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

A user-friendly name for the object. This property is inherited from CIM_SettingData and it is set to "Processor". Changing this property will change the ElementName of the associated logical device derivative.

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

HostResource

Data type: string array
Access type: Read-only
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")

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

InstanceID

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

For instances associated with a virtual system, this will be "Microsoft:GUID\device-specific data". For instances which define potential settings for a VM, this will be "Microsoft:Definition\GUID\Type", where Type can be one of "Maximum", "Minimum", "Default", or "Increment". This property is inherited from CIM_SettingData.

IsVirtualized

Data type: boolean
Access type: Read-only

Indicates whether this device is virtualized or passed through. When set to False, the underlying or host resource is utilized. At least one item shall be present in the DeviceID property. When set to True, the resource is virtualized and may not map directly to an underlying/host resource. Some implementations may support specific assignment for virtualized resources, in which case the host resource(s) are exposed using the DeviceID property. This property is set to True.

Limit

Data type: uint64
Access type: Read-only

The maximum amount of CPU resources that may be consumed by the VM. This property is inherited from CIM_ResourceAllocationSettingData and has a default value of 100000.

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

Range: 0 100000

LimitCPUID

Data type: boolean
Access type: Read-only

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

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

LimitProcessorFeatures

Data type: boolean
Access type: Read-only

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

Windows Server 2008: The LimitProcessorFeatures property is not supported until Windows Server 2008 R2.

MappingBehavior

Data type: uint16
Access type: Read-only

Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.

OtherResourceType

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

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

Parent

Data type: string
Access type: Read-only

The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.

PoolID

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

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

ProcessorsPerSocket

Data type: uint16
Access type: Read-only

The number of processors, or cores, configured for each socket in the VM.

Reservation

Data type: uint64
Access type: Read-only

The amount of CPU resources that are reserved for use by the VM. These resources are guaranteed to be available for consumption by the VM. This property is inherited from CIM_ResourceAllocationSettingData and has a default value of 0.

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

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 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 allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to 3 (Processor).

SocketCount

Data type: uint16
Access type: Read-only

The number of processor sockets in the VM. The total number of processors is the value of this property times the value of the ProcessorsPerSocket property.

ThreadsEnabled

Data type: boolean
Access type: Read-only

Indicates whether hardware threads should be visible to the VM. If the physical processor does not support hardware threads, this value has no effect in the VM.

VirtualQuantity

Data type: uint64
Access type: Read-only

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

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

Weight

Data type: uint32
Access type: Read-only

The weight for each VM processor. After all reserves have been met, the remaining physical processor capacity of the hosting platform will be allocated to VMs based on their relative weights. This property is inherited from CIM_ResourceAllocationSettingData and has a default value of 100.

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

Range: 0 100000

Remarks

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

Share via

Msvm_ProcessorSettingData class

Syntax

Members

Properties

Remarks

Requirements

See also

Additional resources