Share via

Msvm_VirtualSystemSettingData class

  • Article

Represents the virtualization-specific settings for a virtual system.

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_VirtualSystemSettingData : CIM_VirtualSystemSettingData
{
  string   Caption = "Virtual Machine";
  string   Description;
  uint16   SettingType;
  string   SystemName = "GUID";
  string   InstanceID = "Microsoft:GUID";
  string   ElementName;
  boolean  AutoActivate;
  string   OtherVirtualSystemType;
  datetime CreationTime;
  uint16   VirtualSystemType = 301;
  string   Notes;
  string   BIOSGUID;
  string   BIOSSerialNumber;
  string   BaseBoardSerialNumber;
  string   ChassisSerialNumber;
  string   ChassisAssetTag;
  boolean  BIOSNumLock;
  uint16   BootOrder[];
  string   Parent;
  uint16   NumaNodeList[];
  boolean  NumaNodesAreRequired;
};

Members

The Msvm_VirtualSystemSettingData class has these types of members:

Properties

The Msvm_VirtualSystemSettingData class has these properties.

AutoActivate

Data type: boolean

Access type: Read-only

Indicates whether the virtual system is automatically started when the virtualization platform is started. This property is inherited from CIM_VirtualSystemSettingData and is set to NULL.

BaseBoardSerialNumber

Data type: string

Access type: Read/write

The serial number of the base board for the virtual computer system.

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

BIOSGUID

Data type: string

Access type: Read/write

The globally unique identifier for the BIOS of the virtual computer system.

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

BIOSNumLock

Data type: boolean

Access type: Read/write

This property is set to TRUE if the num lock key is set to on by the BIOS, FALSE if the num lock key is set to off by the BIOS.

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

BIOSSerialNumber

Data type: string

Access type: Read/write

The serial number of the BIOS for the virtual computer system.

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

BootOrder

Data type: uint16 array

Access type: Read/write

Qualifiers: ArrayType ("Indexed"), MAX (4)

The boot order set within the BIOS of the virtual computer system. This property is an array of values, BootOrder[0] through BootOrder[3], inclusive, where each value indicates a device to boot from. Each of the 4 values in the array must be set and must not be the same as another value in the array. The virtual computer system will first attempt to boot from the device indicated by the first value within the array. If that device does not contain a boot sector, the virtual computer system will attempt to boot from the next device specified by the BootOrder property and so on. If no device specified within the BootOrder contains a boot sector the virtual computer system will fail to boot. The default value for a virtual computer system is [0, 1, 2, 3].

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

Floppy (0)

The virtual computer system will attempt to boot from the floppy disk within the floppy drive.

CD-ROM (1)

The virtual computer system will attempt to boot from the first CD or DVD disk found with a boot sector.

ID Hard Drive (2)

The virtual computer system will attempt to boot from the first hard disk drive found with a boot sector.

PXE Boot (3)

The virtual computer system will attempt to PXE boot from the network.

SCSI Hard Drive (4)

4 65535

Reserved.

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 set to "Virtual Machine".

ChassisAssetTag

Data type: string

Access type: Read/write

The asset tag of the chassis for the virtual computer system.

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

ChassisSerialNumber

Data type: string

Access type: Read/write

The serial number of the chassis for the virtual computer system.

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

CreationTime

Data type: datetime

Access type: Read-only

The date and time at which the settings for the virtual system were created. If this object represents the current settings for the virtual system, this value would be the time at which the system was created. If this object represents the snapshot settings for the virtual system, this value would be the time at which the snapshot was taken. This property is inherited from CIM_VirtualSystemSettingData.

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

Description

Data type: string

Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is set to "Active settings for the virtual machine" if not referring to a snapshot. If referring to a snapshot, it is set to "Snapshot settings for the virtual machine".

"Active settings for the virtual machine"

"Snapshot settings for the virtual machine"

ElementName

Data type: string

Access type: Read/write

A user-friendly name for the object. This property is inherited from CIM_VirtualSystemSettingData and it is set to the display name for the machine. This name may not exceed 100 characters in length. Changing this property will change the ElementName of the associated LogicalDevice derivative.

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

InstanceID

Data type: string

Access type: Read-only

This property is inherited from CIM_VirtualSystemSettingData and it is set to "Microsoft:GUID".

Notes

Data type: string

Access type: Read/write

A free-form string containing notes for the system.

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

NumaNodeList

Data type: uint16 array

Access type: Read/write

Qualifiers: ArrayType ("Indexed")

For non-uniform memory access (NUMA)-capable systems, this is the list of NUMA nodes on which the virtual machine is to be run.

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

NumaNodesAreRequired

Data type: boolean

Access type: Read/write

Qualifiers: Deprecated ("No value")

For non-uniform memory access (NUMA)-capable systems, this value indicates whether the nodes specified in NumaNodeList are required or preferred. If this value is TRUE (the nodes are required), the virtual machine will fail to start if there are not enough resources available on the specified NUMA nodes.

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

OtherVirtualSystemType

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_VirtualSystemSettingData.VirtualSystemType")

This property is inherited from CIM_VirtualSystemSettingData but it is not implemented.

Parent

Data type: string

Access type: Read-only

If this instance does not represent a system based on a snapshot of a virtual system, this property is NULL. Otherwise, the property holds the object path of the Msvm_VirtualSystemSettingData object on which this instance is based. When building a snapshot tree hierarchy for the virtual machine, this property references the object from which the current instance is derived (the current instance is the child node and the object referenced in this property is the parent node.)

SettingType

Data type: uint16

Access type: Read-only

The usage context for this instance of Msvm_VirtualSystemSettingData. This property is inherited from CIM_VirtualSystemSettingData.

Input (1)

Recorded (2)

Current (3)

This instance represents the current settings for the virtual system.

Capability (4)

Snapshot (5)

This instance represents the settings for a snapshot of the virtual system.

SystemName

Data type: string

Access type: Read/write

The label by which the object is known. This property is inherited from CIM_VirtualSystemSettingData and it is set to "GUID". This corresponds to the Name property of the Msvm_ComputerSystem class and the SystemName property of the Msvm_VirtualSystemGlobalSettingData class.

VirtualSystemType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_VirtualSystemSettingData.OtherVirtualSystemType")

The virtual system type. This value is set to 301 (Microsoft Hyper-V). This property is inherited from CIM_VirtualSystemSettingData.

Remarks

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

See also

CIM_VirtualSystemSettingData

CIM_VirtualSystemSettingData

Virtual System Classes