Msvm_BIOSElement class

Article
01/07/2021

Represents the low-level software that is loaded into RAM to configure and start the system. The BIOS is not a logical device, hence the virtual BIOS should not be thought of as a virtual machine device. As it is not a device, it does not have a corresponding resource pool. The BIOS object is associated with the virtual machine through the Msvm_SystemBIOS association.

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_BIOSElement : CIM_BIOSElement
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   Name = "BIOS";
  uint16   SoftwareElementState = 2;
  string   SoftwareElementID = "Microsoft:GUID\device-specific data";
  uint16   TargetOperatingSystem = 0;
  string   OtherTargetOS;
  string   BuildNumber = 14;
  string   SerialNumber;
  string   CodeSet;
  string   IdentificationCode;
  string   LanguageEdition;
  string   Version = "8.02.00";
  string   Manufacturer = "Microsoft Corporation";
  boolean  PrimaryBIOS = True;
  string   ListOfLanguages[] = "en|US|iso8859-1";
  string   CurrentLanguage = "en|US|iso8859-1";
  unit64   LoadedStartingAddress = 0xE0000;
  unit64   LoadedEndingAddress = 0xFFFFF;
  string   LoadUtilityInformation;
  datetime ReleaseDate;
  string   RegistryURIs[];
  string   BIOSGUID;
  string   BIOSSerialNumber;
  string   BaseBoardSerialNumber;
  string   ChassisSerialNumber;
  string   ChassisAssetTag;
  boolean  BIOSNumLock;
  uint16   BootOrder[];
};

Members

The Msvm_BIOSElement class has these types of members:

Properties

Properties

The Msvm_BIOSElement class has these properties.

BaseBoardSerialNumber

Data type: string
Access type: Read-only

The serial number for the base board on the virtual machine.

BIOSGUID

Data type: string
Access type: Read-only

The unique identifier for the BIOS.

BIOSNumLock

Data type: boolean
Access type: Read-only

The enabled state of the Num Lock in the BIOS.

BIOSSerialNumber

Data type: string
Access type: Read-only

The serial number for the BIOS.

BootOrder

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), MAX (4)

The order in which devices will be searched for a boot sector at startup.

BuildNumber

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

The internal identifier for this compilation of software element. This property is inherited from CIM_SoftwareElement, and it is always set to 14.

Caption

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

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

ChassisAssetTag

Data type: string
Access type: Read-only

Automatically populated by the BIOS when the virtual machine is created.

ChassisSerialNumber

Data type: string
Access type: Read-only

Automatically populated by the BIOS when the virtual machine is created.

CodeSet

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

The code set used by the software element. This property is inherited from CIM_SoftwareElement, and it is always set to Null.

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.

CurrentLanguage

Data type: string
Access type: Read-only

The currently selected language for the BIOS. This property is inherited from CIM_BIOSElement, and it is always set to "en|US|iso8859-1".

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

Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ElementName

Data type: string
Access type: Read-only

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

HealthState

Data type: uint16
Access type: Read-only

Specifies the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents.

When a critical error occurs, check the event log for details. The EnabledState property can also contain more information. For example, when disk space is critically low, HealthState is set to 25, the virtual machine pauses, and EnabledState is set to 32768 (Paused).

This property is inherited from CIM_ManagedSystemElement.

Value	Meaning
OK 5	The virtual machine is fully functional and is operating within normal operational parameters and without error.
Major Failure 20	The virtual machine has suffered a major failure. This value is used when one or more disks that contain the virtual machine's VHDs is low on disk space and the virtual machine has been paused.
Critical failure 25	The element is nonfunctional, and recovery might not be possible. This can indicate that the worker process for the virtual machine (Vmwp.exe) is not responding to control or information requests, or that one or more disks that contain the VHDs for the virtual machine are low on disk space.

IdentificationCode

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

The manufacturer's identifier for this software element. Often this will be a stock keeping unit (SKU) or a part number. This property is inherited from CIM_SoftwareElement, and it is always set to Null.

InstallDate

Data type: datetime
Access type: Read-only

Automatically populated by the BIOS when the virtual machine is 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.

LanguageEdition

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

The language edition of this software element. This property is inherited from CIM_SoftwareElement, and it is always set to Null.

ListOfLanguages

Data type: string array
Access type: Read-only

A list of installable languages for the BIOS. THIS property is inherited from CIM_BIOSElement, and it is always set to "en|US|iso8859-1".

LoadedEndingAddress

Data type: unit64
Access type: Read-only

The ending address of the memory which this BIOS occupies. This property is inherited from CIM_BIOSElement, and it is always set to 0xFFFFF.

LoadedStartingAddress

Data type: unit64
Access type: Read-only

The starting address of the memory which this BIOS occupies. This property is inherited from CIM_BIOSElement, and it is always set to 0xE0000.

LoadUtilityInformation

Data type: string
Access type: Read-only

A string that describes the BIOS flash/load utility that is required to update the BIOS element. Version and other information may be indicated in this property. This property is inherited from CIM_BIOSElement, and it is always set to Null.

Manufacturer

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

The manufacturer of this BIOS. This property is inherited from CIM_BIOSElement, and it is always set to "Microsoft Corporation".

Name

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

The name used to identify this software element. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_SoftwareElement, and it is always set to "BIOS".

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.

OperationalStatus

Data type: uint16 array
Access type: Read-only

An array that contains the current statuses of the object. This property is inherited from CIM_ManagedSystemElement. The value at index zero (0) is one of the following values.

Value	Meaning
OK 2	The virtual machine is functional and operating normally.
Degraded 3	The virtual machine is only partially functional. This indicates that the storage that contains the configuration is not accessible. A virtual machine in this state may only be turned off or deleted.
Predictive Failure 5	The virtual machine is functional but may fail in the future. This indicates that the storage that contains the virtual machine's virtual hard disk is low on free space. The virtual machine will be paused if more disk space is not made available.
Stopped 10	This value is not supported. If the virtual machine is stopped, the EnabledState property will have a value of 3 (Disabled).
In Service 11	The virtual machine is processing a request.
Dormant 15	This value is not supported. If the virtual machine is suspended or paused, the EnabledState property will have a value of 32769 (Suspended) or 32768 (Paused).

The value at index one (1) is optional and contains secondary status information. A client should use the primary status from index zero (0) to determine whether a new request can be issued to the virtual machine. If OperationalStatus[0] is 2 (OK), then the operation indicated by OperationalStatus[1] can be interrupted.

The value at OperationalStatus[1] is one of the following values.

Value	Meaning
Creating Snapshot 32768	A snapshot is in the process of being created for the virtual machine.
Applying Snapshot 32769	A snapshot is in the process of being applied to the virtual machine.
Deleting Snapshot 32770	A snapshot is in the process of being deleted from the virtual machine.
Waiting to Start 32771	The virtual machine will be started after the automatic startup delay has elapsed.
Merging Disks 32772	Virtual hard disks from previously deleted snapshots are being merged.
Exporting Virtual Machine 32773	The virtual machine is being exported.
Migrating Virtual Machine 32774	The virtual machine is being migrated live from one physical computer to another.

OtherTargetOS

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

The manufacturer and operating system for a software element when the TargetOperatingSystem property has a value of 1 (Other), which requires the OtherTargetOS property to have a non-Null value. For all other values of TargetOperatingSystem, the OtherTargetOS property must be Null. This property is inherited from CIM_SoftwareElement, and it is always set to Null.

PrimaryBIOS

Data type: boolean
Access type: Read-only

If True, this is the primary BIOS of the computer system. This property is inherited from CIM_BIOSElement, and it is always set to True.

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 information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

RegistryURIs

Data type: string array
Access type: Read-only

An array of strings representing the publication location of the BIOS attribute registry or registries the implementation complies to. This property is inherited from CIM_BIOSElement.

ReleaseDate

Data type: datetime
Access type: Read-only

The date that the BIOS was released. This property is inherited from CIM_BIOSElement.

SerialNumber

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

The assigned serial number of the BIOS. This property is inherited from CIM_SoftwareElement.

SoftwareElementID

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

An identifier for the software element. This property is inherited from CIM_SoftwareElement, and it is always set to "Microsoft:GUID\device-specific data".

SoftwareElementState

Data type: uint16
Access type: Read-only

The state of a software element's life cycle. This property is inherited from CIM_SoftwareElement, and it is always set to 2 (Executable).

Status

Data type: string
Access type: Read-only

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

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

An array that contains strings that describe the corresponding OperationalStatus array values. For example, if 11 (In Service) is the value assigned to OperationalStatus[0], then StatusDescriptions[0] may contain an explanation as to why the virtual machine is processing a request. This property is inherited from CIM_ManagedSystemElement.

TargetOperatingSystem

Data type: uint16
Access type: Read-only

The element's operating system environment. This property is inherited from CIM_SoftwareElement, and it is always set to 0 (Unknown).

Version

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

The version of the BIOS. This property is inherited from CIM_BIOSElement, and it is always set to "8.02.00".

Remarks

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

Share via

Msvm_BIOSElement class

Syntax

Members

Properties

Remarks

Requirements

See also

Feedback

Additional resources