Msvm_Processor class

Represents the virtual processor in a virtual machine.

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

Syntax

class Msvm_Processor : CIM_Processor
{
  string   InstanceID;
  string   Caption = "Processor";
  string   Description = " A logical processor of the hypervisor running on the host computer system.";
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 2;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_Processor";
  string   DeviceID = "Microsoft:GUID\device specific data";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  string   Role = "Central Processor";
  uint16   Family;
  string   OtherFamilyDescription;
  uint16   UpgradeMethod;
  uint32   MaxClockSpeed;
  uint32   CurrentClockSpeed;
  uint16   DataWidth;
  uint16   AddressWidth;
  uint16   LoadPercentage;
  string   Stepping;
  string   UniqueID;
  uint16   CPUStatus;
  uint32   ExternalBusClockSpeed;
  uint16   LoadPercentageHistory[];
};

Members

The Msvm_Processor class has these types of members:

Methods

The Msvm_Processor class has these methods.

MethodDescription
EnableDevice

This method is not supported.

OnlineDevice

This method is not supported.

QuiesceDevice

This method is not supported.

RequestStateChange

This method is not supported.

Reset

This method is not supported.

RestoreProperties

This method is not supported.

SaveProperties

This method is not supported.

SetPowerState

This method is not supported.

 

Properties

The Msvm_Processor class has these properties.

AdditionalAvailability
Data type: uint16 array
Access type: Read-only

Any additional availability and status of the device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the device. This property is inherited from CIM_LogicalDevice.

AddressWidth
Data type: uint16
Access type: Read-only

The processor address width, in bits. This property is inherited from CIM_Processor, and the value is either 32 or 64, depending on the characteristics of the virtual machine.

Availability
Data type: uint16
Access type: Read-only

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice, but it is not used.

AvailableRequestedStates
Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

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

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.. )
CPUStatus
Data type: uint16
Access type: Read-only

The current status of the processor. This property is inherited from CIM_Processor.

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

The name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

CurrentClockSpeed
Data type: uint32
Access type: Read-only

The maximum speed of the physical processor, taking into account the capacity for the virtual processor. This property is inherited from CIM_Processor.

DataWidth
Data type: uint16
Access type: Read-only

The processor data width, in bits. This property is inherited from CIM_Processor, and the value is either 32 or 64, depending on the characteristics of the virtual machine.

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.. )
DeviceID
Data type: string
Access type: Read-only

An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice, and it is always set to "Microsoft:GUID\device specific data".

ElementName
Data type: string
Access type: Read-only

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

EnabledDefault
Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the Enabled State of an element. This property is inherited from CIM_EnabledLogicalElement.

EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement.

ErrorCleared
Data type: boolean
Access type: Read-only

Indicates whether the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorDescription
Data type: string
Access type: Read-only

A string that provides more information about the error recorded in LastErrorCode and information about any corrective actions that can be taken. This property is inherited from CIM_LogicalDevice, but it is not used.

ExternalBusClockSpeed
Data type: uint32
Access type: Read-only

The external bus clock speed of the underlying physical processor. This property is inherited from CIM_Processor.

Family
Data type: uint16
Access type: Read-only

The processor family of the underlying physical processor. This property is inherited from CIM_Processor.

HealthState
Data type: uint16
Access type: Read-only

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

IdentifyingDescriptions
Data type: string array
Access type: Read-only

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo array. This property is inherited from CIM_LogicalDevice, and it is always set to Null.

InstallDate
Data type: datetime
Access type: Read-only

The date and time when the virtual machine was created. 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.

LastErrorCode
Data type: uint32
Access type: Read-only

The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

LoadPercentage
Data type: uint16
Access type: Read-only

The current percentage of the total processing power being consumed by the virtual machine. This property is inherited from CIM_Processor.

LoadPercentageHistory
Data type: uint16 array
Access type: Read-only

The recorded history of percentage of the total processing power being consumed by the virtual machine. This is an array containing samples.

MaxClockSpeed
Data type: uint32
Access type: Read-only

The maximum clock speed, in megahertz, of the virtual processor. This property is inherited from CIM_Processor.

MaxQuiesceTime
Data type: uint64
Access type: Read-only

This property has been deprecated. This property is inherited from CIM_LogicalDevice, but it is not used.

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.

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

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

OtherEnabledState
Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement.

OtherFamilyDescription
Data type: string
Access type: Read-only

A description of the processor family type. This property is inherited from CIM_Processor, and it is always set to Null.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice.

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerManagementSupported
Data type: boolean
Access type: Read-only

Indicates whether power management is supported on the device. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerOnHours
Data type: uint64
Access type: Read-only

The number of consecutive hours that this device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice, but it is not used.

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.. )
RequestedState
Data type: uint16
Access type: Read-only

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement.

Role
Data type: string
Access type: Read-only

A string that describes the role of the processor. For example, "Central Processor" or "Math Processor". This property is inherited from CIM_Processor.

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.

StatusInfo
Data type: uint16
Access type: Read-only

The current state of the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

Stepping
Data type: string
Access type: Read-only

The revision level of the processor within the processor family of the underlying physical processor. This property is inherited from CIM_Processor.

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

The creation class name of the scoping system. This property is inherited from CIM_LogicalDevice.

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

The name of the scoping system. This value corresponds to the value of the Name property of the Msvm_ComputerSystem class for the scoping virtual machine. This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date or time at which the virtual machine's state was changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. This property is inherited from CIM_EnabledLogicalElement.

TotalPowerOnHours
Data type: uint64
Access type: Read-only

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.

TransitioningToState
Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, but it is not used.

UniqueID
Data type: string
Access type: Read-only

A globally unique identifier for the processor. This identifier can only be unique within a processor family. This property is inherited from CIM_Processor, and it is always set to Null.

UpgradeMethod
Data type: uint16
Access type: Read-only

The CPU socket information, which includes data on how to upgrade the processor (if upgrades are supported). This property is inherited from CIM_Processor.

Remarks

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

Requirements

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

See also

CIM_Processor
Processor Classes

 

 

Community Additions

ADD
Show: