Поделиться через

Msvm_VirtualSystemSettingData class

  • Статья

Represents the virtualization-specific settings for a virtual machine.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_VirtualSystemSettingData : CIM_VirtualSystemSettingData
{
  string   Caption;
  string   Description;
  string   InstanceID;
  string   ElementName;
  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   ChassisAssetTag;
  boolean  BIOSNumLock;
  uint16   BootOrder[];
  string   BootSourceOrder[];
  string   Parent;
  uint16   UserSnapshotType;
  string   VirtualSystemIdentifier;
  boolean  IsSaved;
  string   AdditionalRecoveryInformation;
  boolean  AllowFullSCSICommandSet;
  uint32   DebugChannelId;
  uint16   DebugPortEnabled;
  uint32   DebugPort;
  string   Version;
  boolean  IncrementalBackupEnabled;
  boolean  VirtualNumaEnabled;
  uint64   LowMmioGapSize;
  uint64   HighMmioGapSize;
  boolean  AllowReducedFcRedundancy = False;
  string   VirtualSystemSubType;
  boolean  SecureBootEnabled;
  string   SecureBootTemplateId;
  boolean  PauseAfterBootFailure;
  uint16   NetworkBootPreferredProtocol;
  uint16   ConsoleMode;
  uint16   AutomaticCriticalErrorAction;
  datetime AutomaticCriticalErrorActionTimeout;
  boolean  LockOnDisconnect;
  boolean  GuestControlledCacheTypes;
};

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. This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

AllowFullSCSICommandSet

Data type: boolean

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.

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.

The possible values are:

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.

AutomaticCriticalErrorAction

Data type: uint16

Access type: Read/write

The action to take on the VM when a critical error happens, such as an error caused by disconnected storage.

The possible values are.

None (0)

No action is taken.

Pause Resume (1)

The VM is paused and automatically resumed when the critical error condition is resolved.

AutomaticCriticalErrorActionTimeout

Data type: datetime

Access type: Read/write

Qualifiers: SubType ("interval")

The maximum duration for which the action of theAutomaticCriticalErrorAction property is performed. This is only applicable when the value of AutomaticCriticalErrorAction is not "0" (None). Once the timeout expires, the VM is powered off. The value is 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.

AutomaticRecoveryAction

Data type: uint16

Access type: Read-only

The action to take for the virtual system when the software executed by the virtual system fails. The failures addressed by this property only include those that are detectable by the host platform, such as a non-interruptible wait state condition.

This property is inherited from CIM_VirtualSystemSettingData.

None (2)

Restart (3)

Revert to snapshot (4)

DMTF Reserved

5 65535

AutomaticShutdownAction

Data type: uint16

Access type: Read-only

The action to take for the virtual system when the host is shut down.

This property is inherited from CIM_VirtualSystemSettingData.

Turn Off (2)

Save state (3)

Shutdown (4)

DMTF Reserved

5 65535

AutomaticStartupAction

Data type: uint16

Access type: Read-only

The action to take on the virtual system when the host is started.

This property is inherited from CIM_VirtualSystemSettingData.

None (2)

Restart if previously active (3)

Always startup (4)

DMTF Reserved

5 65535

AutomaticStartupActionDelay

Data type: datetime

Access type: Read-only

The delay for the startup action. This value is an interval variant of the datetime data type.

This property is inherited from CIM_VirtualSystemSettingData.

AutomaticStartupActionSequenceNumber

Data type: uint16

Access type: Read-only

The sequence number fo virtual system 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.

Note

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 machine.

Note

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

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.

Note

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 machine.

Note

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 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].

Note

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

The possible values are.

Floppy (0)

CD-ROM (1)

IDE Hard Drive (2)

PXE Boot (3)

SCSI Hard Drive (4)

Reserved

5 65535

BootSourceOrder

Data type: string array

Access type: Read/write

The boot source order for the virtual machine.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual 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.

Note

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 machine.

Note

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

ConfigurationDataRoot

Data type: string

Access type: Read-only

The file path of the directory where information about the virtual system configuration is stored. The format of this property is a URI based on RFC 2079.

This property is inherited from CIM_VirtualSystemSettingData.

ConfigurationFile

Data type: string

Access type: Read-only

The relative path of the file where information about the virtual system configuration is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

This property is inherited from CIM_VirtualSystemSettingData.

ConfigurationID

Data type: string

Access type: Read-only

The unique id of the virtual system configuration.

Note

ConfigurationID is different from the InstanceID, and is assigned by the implementation to a virtual system or a virtual system configuration. ConfigurationID is not a key, and the same value may occur for more than one instance.

This property is inherited from CIM_VirtualSystemSettingData.

ConsoleMode

Data type: uint16

Access type: Read/write

The console mode for the VM.

The possible values are.

Default (0)

COM1 (1)

COM2 (2)

None (3)

CreationTime

Data type: datetime

Access type: Read-only

The date and time when the virtual system configuration was created.

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.

The possible values are.

Off (0)

On (1)

OnAutoAssigned (2)

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

Qualifiers: Required

The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.

This property is inherited from CIM_SettingData.

GuestControlledCacheTypes

Data type: boolean

Access type: Read/write

true if the guest can control cache types; false if the guest cannot.

HighMmioGapSize

Data type: uint64

Access type: Read/write

The size, in MB, of the high (above 4GB) memory-mapped IO gap.

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 within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

  • OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
  • OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
  • LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
  • If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
  • For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".

This property is inherited from CIM_SettingData.

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

true to lock the console when disconnecting from vmconnect; otherwise, false.

LogDataRoot

Data type: string

Access type: Read-only

The relative file path of the directory where log information for the virtual system is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

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).

The possible values are.

Range: 128 3584

NetworkBootPreferredProtocol

Data type: uint16

Access type: Read/write

The IP protocol used for PXE booting.

The possible values are.

IPv4 (4096)

IPv6 (4097)

Notes

Data type: string array

Access type: Read-only

An array that contains user supplied notes that are related to the virtual system.

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.)

PauseAfterBootFailure

Data type: boolean

Access type: Read/write

Pause after boot failure setting for the VM

true to pause the VM after a boot failure, and then wait for user input; otherwise, false.

RecoveryFile

Data type: string

Access type: Read-only

The path of the file where recovery related information of the virtual system is stored. The format of this property is a URI based on RFC 2079.

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.

SecureBootTemplateId

Data type: string

Access type: Read/write

The globally-unique identifier of the template of initial values of UEFI Secure Boot related variables.

Note

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

SnapshotDataRoot

Data type: string

Access type: Read-only

The relative path of the directory where information about virtual system snapshots is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

This property is inherited from CIM_VirtualSystemSettingData.

SuspendDataRoot

Data type: string

Access type: Read-only

The relative path of the directory where suspend related information about the virtual system is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

This property is inherited from CIM_VirtualSystemSettingData.

SwapFileDataRoot

Data type: string

Access type: Read-only

The relative file path of the directory where swap files of the virtual system are stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

This property is inherited from CIM_VirtualSystemSettingData.

UserSnapshotType

Data type: uint16

Access type: Read/write

A user-defined snapshot type.

The possible values are.

Disable (2)

Disable the creation of any snapshot.

ProductionFallbackToTest (3)

A data-consistent snapshot for use in the production environment. If a data consistent snapshot can not be created, a snapshot is created using the application state.

ProductionNoFallback (4)

A data-consistent snapshot for use in the production environment. If a data consistent snapshot can not be created, a snapshot is not created using the application state.

Test (5)

A snapshot that contains memory and device information for test and development purposes.

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 MaxProcessorsPerNumaNode and MaxMemoryBlocksPerNumaNode properties of the Msvm_ProcessorSettingData class.

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.

VirtualSystemSubType

Data type: string

Access type: Read-only

The sub type of the virtual machine.

The possible values are.

Microsoft:Hyper-V:SubType:1 ("Microsoft:Hyper-V:SubType:1")

A generation 1 VM.

Microsoft:Hyper-V:SubType:2 ("Microsoft:Hyper-V:SubType:2")

A generation 2 VM.

VirtualSystemType

Data type: string

Access type: Read-only

The type of the virtual system.

Note

If the virtual system type is unknown, this value must be set to "DMTF:unknown".

This property is formatted using the following Augmented Backus Naur Form (ABNF) format:

vs-type = dmtf-value / other-org-value / legacy-value; dmtf-value = "DMTF:" defining-org ":" org-vs-type; other-org-value = defining-org ":" org-vs-type;

The value of the above ABNF format are:

  • dmtf-value a property value defined by DMTF and is defined in the description of this property.
  • other-org-value is a property value defined by a business entity other than DMTF and is not defined in the description of this property.
  • legacy-value a property value defined by a business entity other than DMTF and is not defined in the description of this property. These values are permitted but recommended to be deprecated over time.
  • defining-org an identifier for the business entity that defines the virtual system type. It should include a copyrighted, trademarked, or a unique name that is owned by the business entity. It should not be "DMTF" and shall not contain a colon.
  • org-vs-type an identifier for the virtual system type within the defining business entity. It should be unique within defining-org. org-vs-type may use any character allowed for CIM strings, except the following: U0000-U001F (Unicode C0 controls), U0020 (space), U007F (Unicode C0 controls), or U0080-U009F (Unicode C1 controls).
  • If there is a need to structure the value into segments, the segments should be separated with a single colon.
  • The values of this property should be processed case sensitively. They are intended to be processed programmatically, instead of being a display name, and should be short.

This property is inherited from CIM_VirtualSystemSettingData.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2016
Namespace
 Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

CIM_VirtualSystemSettingData

Failover Clustering Hyper-V WMI Provider