Data Object - HostCpuIdInfo

Property of
GuestOsDescriptor, HostCpuPackage, HostHardwareInfo, VirtualMachineConfigInfo, VirtualMachineCpuIdInfoSpec

Data Object Description

The CpuIdInfo data object type contains the CPU features on a particular host or product combination, as well as specifying what the CPU feature requirements are for a particular virtual machine or guest operating system.

For each register (eax,ebx,ecx,edx), the string is a bit mask of the form:


When used to return the features advertised by the virtualization platform of a particular host (@see or the raw featurebits of a specific processor package (@see, each bit is either '0' or '1', or '-' for unknown. In these feature vectors, the vendor field is never set.

Optional values in these feature vectors default to '----:----:----:----:----:----:----:----'.

When specifying the required feature set for a virtual machine or a guest operating system, the bits can take on the values as described below, and the vendor field may be set. The total feature requirements for a virtual machine are composed by using any requirements listed in the virtual machine's configuration to override the requirements listed in the descriptor for the virtual machine's guest OS.

Bits used for specifying requirements:

The values 'F' and '1' are rarely used but included for completeness. The '0' and '1' values do not promise a faithful virtualization of these features; whether the features work when forced to 0 or 1 is highly dependent on the guest software.

Optional values in the requirements from the virtual machine's configuration default to '----:----:----:----:----:----:----:----'. Optional values in the requirements from the guest OS descriptor default to 'xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx'.

Once the feature requirements for a virtual machine have been composed from the virtual machine's configuration and guest OS descriptor, the bit types above are used to identify whether or not the virtual machine can be powered on or be migrated with VMotion to a particular host. The rules are as follows:


Name Type Description
eax*xsd:string String representing the required EAX bits.
ebx*xsd:string String representing the required EBX bits.
ecx*xsd:string String representing the required ECX bits.
edx*xsd:string String representing the required EDX bits.
levelxsd:int Level (EAX input to CPUID).
vendor*xsd:string Used if this mask is for a particular vendor.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition