Msvm_VirtualSystemSettingData class
Represents the virtualization-specific settings for a virtual machine.
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 InstanceID;
string Caption = "Virtual Machine Settings";
string Description;
string ElementName;
string VirtualSystemIdentifier;
string VirtualSystemType;
string Notes[];
datetime CreationTime;
string ConfigurationID;
string ConfigurationDataRoot;
string ConfigurationFile;
string SnapshotDataRoot;
string SuspendDataRoot;
string SwapFileDataRoot;
string LogDataRoot;
uint16 AutomaticStartupAction;
datetime AutomaticStartupActionDelay;
uint16 AutomaticStartupActionSequenceNumber;
uint16 AutomaticShutdownAction;
uint16 AutomaticRecoveryAction;
string RecoveryFile;
string BIOSGUID;
string BIOSSerialNumber;
string BaseBoardSerialNumber;
string ChassisSerialNumber;
string Architecture;
string ChassisAssetTag;
boolean BIOSNumLock;
uint16 BootOrder[];
string Parent;
uint16 UserSnapshotType;
boolean IsSaved;
string AdditionalRecoveryInformation;
boolean AllowFullSCSICommandSet;
uint32 DebugChannelId;
uint16 DebugPortEnabled;
uint32 DebugPort;
string Version;
boolean IncrementalBackupEnabled;
boolean VirtualNumaEnabled;
boolean AllowReducedFcRedundancy = False;
string VirtualSystemSubType;
string BootSourceOrder[];
boolean PauseAfterBootFailure;
uint16 NetworkBootPreferredProtocol;
boolean GuestControlledCacheTypes;
boolean AutomaticSnapshotsEnabled;
boolean IsAutomaticSnapshot;
string GuestStateFile;
string GuestStateDataRoot;
boolean LockOnDisconnect;
string ParentPackage;
datetime AutomaticCriticalErrorActionTimeout;
uint16 AutomaticCriticalErrorAction;
uint16 ConsoleMode;
boolean SecureBootEnabled;
string SecureBootTemplateId;
uint64 LowMmioGapSize;
uint64 HighMmioGapSize;
uint16 EnhancedSessionTransportType;
};
Members
The Msvm_VirtualSystemSettingData class has these types of members:
Properties
The Msvm_VirtualSystemSettingData class has these properties.
-
AdditionalRecoveryInformation
-
-
Data type: string
-
Access type: Read/write
Any additional information provided to the recovery action. The meaning of this property is defined by the action in AutomaticRecoveryAction. If AutomaticRecoveryAction is 0 ("None") or 1 ("Restart"), this value is Null. If AutomaticRecoveryAction is 2 ("Revert to Snapshot"), this is the object path to a snapshot that should be applied on failure of the virtual machine worker process.
-
-
AllowFullSCSICommandSet
-
-
Data type: boolean
-
Access type: Read/write
True if SCSI commands from the guest operating system are passed to pass-through disks; otherwise, False. If True, SCSI commands emitted by the guest operating system to pass-through disks are not filtered. We recommend that SCSI filtering remain enabled for production deployments.
-
-
AllowReducedFcRedundancy
-
-
Data type: boolean
-
Access type: Read/write
Specifies whether live migration of a virtual machine that is configured with a virtual Fibre Channel adapter is allowed to a destination computer that may have no or reduced paths to the target Fibre Channel devices. This property should be cleared after a live migration.
Value Meaning - False
The virtual machine cannot be live migrated to a target computer that may have no or reduced paths to the target Fibre Channel devices. - True
The virtual machine can be live migrated to a target computer that may have no or reduced paths to the target Fibre Channel devices. The guest operating system may lose connectivity to storage and may behave in an unpredictable manner. -
-
Architecture
-
-
Data type: string
-
Access type: Read-only
The architecture of this system.
Note
Added in Windows 10, version 1709.
-
-
x64 ()
-
arm64 ()
AutomaticCriticalErrorAction
-
Data type: uint16
-
Access type: Read/write
Identifies the action to be taken on VM, when a critical error happens, like storage disconnect.
Note
Added in Windows 10 and Windows Server 2016.
None (0)
No specific action will be taken for critical error conditions.
Pause Resume (1)
Causes the VM to be paused and automatically resumed when the critical error condition is resolved.
AutomaticCriticalErrorActionTimeout
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: SubType ("interval")
Identifies the maximum duration for which the AutomaticCriticalErrorAction will be performed to resolve the critical error. This is applicable only when the value of the AutomaticCriticalErrorAction property is not 0 (None). Once the timeout expires, the VM will be powered off. The value will be rounded up to the nearest minute. A value of 0 implies that the VM should be powered off immediately when it encounters a critical error condition.
Note
Added in Windows 10 and Windows Server 2016.
AutomaticRecoveryAction
-
Data type: uint16
-
Access type: Read-only
Action to take for the virtual machine when the software executed by the virtual machine fails. Failures in this case means a failure that is detectable by the host platform, such as a noninterruptible wait state condition. This property is inherited from CIM_VirtualSystemSettingData.
This can be one of the following values.
| Value | Meaning |
|---|---|
|
None. |
|
Restart. |
|
Revert to snapshot. |
|
Reserved. |
AutomaticShutdownAction
-
Data type: uint16
-
Access type: Read-only
Action to take for the virtual machine when the host is shut down. This property is inherited from CIM_VirtualSystemSettingData.
This can be one of the following values.
| Value | Meaning |
|---|---|
|
Turn off. |
|
Save state. |
|
Shutdown. |
|
Reserved. |
AutomaticSnapshotsEnabled
-
Data type: boolean
-
Access type: Read/write
Indicates whether this virtual machine should have automatic snapshots enabled.
Note
Added in Windows 10, version 1709.
AutomaticStartupAction
-
Data type: uint16
-
Access type: Read-only
Action to take for the virtual machine when the host is started. This property is inherited from CIM_VirtualSystemSettingData.
This can be one of the following values.
| Value | Meaning |
|---|---|
|
None. |
|
Restart if previously active. |
|
Always start. |
|
Reserved. |
AutomaticStartupActionDelay
-
Data type: datetime
-
Access type: Read-only
The delay time before the virtual machine is automatically started up. This property is inherited from CIM_VirtualSystemSettingData.
AutomaticStartupActionSequenceNumber
-
Data type: uint16
-
Access type: Read-only
A number that indicates the relative sequence of virtual machine activation when the host system is started. A lower number indicates earlier activation. If one or more configurations show the same value, the sequence is implementation dependent. A value of 0 indicates that the sequence is implementation dependent. This property is inherited from CIM_VirtualSystemSettingData.
BaseBoardSerialNumber
-
Data type: string
-
Access type: Read/write
The serial number of the base board for the virtual machine.
BIOSGUID
-
Data type: string
-
Access type: Read/write
The globally unique identifier for the BIOS of the virtual machine.
BIOSNumLock
-
Data type: boolean
-
Access type: Read/write
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.
BIOSSerialNumber
-
Data type: string
-
Access type: Read/write
The serial number of the BIOS for the virtual machine.
BootOrder
The boot order set within the BIOS of the virtual machine. 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 machine 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 machine 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 machine will fail to boot. The default value for a virtual machine is [0, 1, 2, 3].
Floppy (0)
The virtual machine will attempt to boot from the floppy disk within the floppy drive.
CD-ROM (1)
The virtual machine will attempt to boot from the first CD or DVD disk found with a boot sector.
IDE Hard Drive (2)
The virtual machine will attempt to boot from the first hard disk drive found with a boot sector.
PXE Boot (3)
The virtual machine will attempt to PXE boot from the network.
SCSI Hard Drive (4)
Reserved (5..65535)
BootSourceOrder
-
Data type: string array
-
Access type: Read/write
The boot source order for the virtual machine.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
Caption
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
ChassisAssetTag
-
Data type: string
-
Access type: Read/write
The asset tag of the chassis for the virtual machine.
ChassisSerialNumber
-
Data type: string
-
Access type: Read/write
The serial number of the chassis for the virtual machine.
ConfigurationDataRoot
-
Data type: string
-
Access type: Read-only
The path of a directory where information about the virtual machine configuration is stored. This property is inherited from CIM_VirtualSystemSettingData.
ConfigurationFile
-
Data type: string
-
Access type: Read-only
The relative path and file name of a file where information about the virtual machine configuration is stored. This path is relative to the ConfigurationDataRoot property. This property is inherited from CIM_VirtualSystemSettingData.
ConfigurationID
-
Data type: string
-
Access type: Read-only
The unique identifier of the virtual machine configuration. This property is inherited from CIM_VirtualSystemSettingData.
ConsoleMode
-
Data type: uint16
-
Access type: Read/write
Identifies the Console Mode for the VM.
Note
This property was added in Windows 10 and Windows Server 2016.
Default (0)
COM1 (1)
COM2 (2)
None (3)
CreationTime
-
Data type: datetime
-
Access type: Read-only
The date and time at which the settings for the virtual machine were created. If this object represents the current settings for the virtual machine, this value would be the time at which the system was created. If this object represents the snapshot settings for the virtual machine, this value would be the time at which the snapshot was taken. This property is inherited from CIM_VirtualSystemSettingData.
DebugChannelId
-
Data type: uint32
-
Access type: Read/write
The channel identifier used to debug the virtual machine using the unified debugger.
DebugPort
-
Data type: uint32
-
Access type: Read/write
The TCP/IP port used to debug the virtual machine using synthetic debugging.
DebugPortEnabled
-
Data type: uint16
-
Access type: Read/write
Specifies whether the virtual machine is using synthetic debugging. This can be one of the following values.
Off (0)
On (1)
OnAutoAssigned (2)
Auto-assigned
Description
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to one of the following values.
| Value | Meaning |
|---|---|
|
This instance refers to a virtual machine. |
|
This instance refers to a snapshot. |
ElementName
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_VirtualSystemSettingData, and it is always set to the display name for the machine. This name may not exceed 100 characters in length.
EnhancedSessionTransportType
-
Data type: uint16
-
Access type: Read/write
Indicates the transport type to use when connecting to an enhanced session.
Note
This property was added in Windows 10, version 1803.
VMBus Pipe (0)
Hyper-V Socket (1)
GuestControlledCacheTypes
-
Data type: boolean
-
Access type: Read/write
Indicates whether the guest can control cache types.
Note
Added in Windows 10 and Windows Server 2016.
GuestStateDataRoot
-
Data type: string
-
Access type: Read-only
Filepath of a directory where information about the guest runtime state is stored.
Note
Added in Windows 10, version 1709.
GuestStateFile
-
Data type: string
-
Access type: Read-only
Filepath of a file where information about the guest runtime state is stored. A relative path appends to the value of the GuestStateDataRoot property.
Note
Added in Windows 10, version 1709.
HighMmioGapSize
-
Data type: uint64
-
Access type: Read/write
The size of the High (above 4GB) Memory-Mapped IO Gap in MB
Note
This property was added in Windows 10, version 1703.
IncrementalBackupEnabled
-
Data type: boolean
-
Access type: Read/write
Indicates whether the Hyper-V VSS writer supports taking incremental backups of this virtual machine.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData.
IsAutomaticSnapshot
-
Data type: boolean
-
Access type: Read-only
Indicates whether this is a snapshot created automatically for the user.
Note
Added in Windows 10, version 1709.
IsSaved
-
Data type: boolean
-
Access type: Read-only
True if the configuration has a reference to a saved state file; otherwise, False. This does not indicate the presence of such a file, only that the configuration specifies one.
LockOnDisconnect
-
Data type: boolean
-
Access type: Read/write
Lock the console when disconnecting from vmconnect.
Note
Added in Windows 10 and Windows Server 2016.
LogDataRoot
-
Data type: string
-
Access type: Read-only
The path of a directory where log information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData.
LowMmioGapSize
-
Data type: uint64
-
Access type: Read/write
Configures the size, in megabytes, of the first MMIO gap for a virtual machine (VM).
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
Range: 128 3584
NetworkBootPreferredProtocol
-
Data type: uint16
-
Access type: Read/write
Determines if the preferred protocol for PXE boot is IPv4 or IPv6.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
IPv4 (4096)
IPv6 (4097)
Notes
-
Data type: string array
-
Access type: Read-only
User supplied notes that are related to the virtual machine. This property is inherited from CIM_VirtualSystemSettingData.
Parent
-
Data type: string
-
Access type: Read-only
If this instance does not represent a system based on a snapshot of a virtual machine, 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.)
ParentPackage
-
Data type: string
-
Access type: Read/write
If this system is a container, the path to the Msvm_ContainerPackage from which this system is based.
Note
Added in Windows 10; removed in Windows 10, version 1703.
PauseAfterBootFailure
-
Data type: boolean
-
Access type: Read/write
Indicates whether the BIOS pauses after every boot entry failure waiting for the user to press a key. True if the BIOS pauses; otherwise, False.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
RecoveryFile
-
Data type: string
-
Access type: Read-only
The full path of a file where recovery related information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData.
SecureBootEnabled
-
Data type: boolean
-
Access type: Read/write
Indicates whether secure boot is enabled for the virtual machine (VM). True if enabled; otherwise, False.
Note
Secure boot can only be enabled for generation 2 VMs.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
SecureBootTemplateId
-
Data type: string
-
Access type: Read/write
The globally-unique identifier of the template of intial values of UEFI Secure Boot related variables.
This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.
Note
Added in Windows 10 and Windows Server 2016.
SnapshotDataRoot
-
Data type: string
-
Access type: Read-only
The path of a directory where information about the virtual machine snapshots is stored. This property is inherited from CIM_VirtualSystemSettingData.
SuspendDataRoot
-
Data type: string
-
Access type: Read-only
The path of a directory where information about the virtual machine suspend-related information is stored. This property is inherited from CIM_VirtualSystemSettingData.
SwapFileDataRoot
-
Data type: string
-
Access type: Read-only
The path of a directory where swap files for the virtual machine are stored. This property is inherited from CIM_VirtualSystemSettingData.
UserSnapshotType
-
Data type: uint16
-
Access type: Read/write
Indicates the user-defined snapshot type.
Note
Added in Windows 10 and Windows Server 2016.
Disable (2)
Disable the creation of any snapshot.
ProductionFallbackToTest (3)
Data-consistent snapshot for use in the production environment.Performs a snapshot with application state when the ability to create data consistent snapshot is not available.
ProductionNoFallback (4)
Data-consistent snapshot for use in the production environment.Does not create a snapshot with application state if it is not possible to create a data consistent snapshot.
Test (5)
Snapshot that contains memory and device information for test and development purpose.
Version
-
Data type: string
-
Access type: Read-only
The version of the virtual machine in a format of "major.minor", for example "2.0".
VirtualNumaEnabled
-
Data type: boolean
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("Msvm_ProcessorSettingData.MaxProcessorsPerNumaNode", "Msvm_MemorySettingData.MaxMemoryBlocksPerNumaNode")
True if virtual non-uniform memory access (NUMA) nodes are projected into the virtual machine; False if the virtual machine will have a single node. If True, the number of virtual NUMA nodes projected into the virtual machine is determined from the values of the Msvm_ProcessorSettingData.MaxProcessorsPerNumaNode and Msvm_MemorySettingData.MaxMemoryBlocksPerNumaNode properties.
VirtualSystemIdentifier
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Override ("CIM_VirtualSystemSettingData.VirtualSystemIdentifier"), ModelCorrespondence ("CIM_ComputerSystem.Name")
The name of the CIM_ComputerSystem object to which this setting data belongs. This property is an override from CIM_VirtualSystemSettingData.
VirtualSystemSubType
-
Data type: string
-
Access type: Read-only
The valid values for this property are Microsoft:Hyper-V:SubType:1 and Microsoft:Hyper-V:SubType:2. A Generation 1 VM is subtype 1. A Generation 2 VM is subtype 2.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
Microsoft:Hyper-V:SubType:1 ("Microsoft:Hyper-V:SubType:1")
Microsoft:Hyper-V:SubType:2 ("Microsoft:Hyper-V:SubType:2")
VirtualSystemType
-
Data type: string
-
Access type: Read-only
Specifies the type of virtual machine the setting data represents. This property is inherited from the CIM_VirtualSystemSettingData class. This will be one of the following values.
| Value | Meaning |
|---|---|
|
A realized virtual machine. |
|
A planned virtual machine. |
|
A snapshot of a realized virtual machine. |
|
A snapshot of a recovery virtual machine. |
|
A snapshot of a planned virtual machine. |
|
A missing snapshot. |
|
A time-based replication point snapshot. |
|
A VSS replication point snapshot. |
|
A planned replication snapshot. |
Remarks
Access to the Msvm_VirtualSystemSettingData 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 |
|
| DLL |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for