Edit

Share via

Msvm_VirtualSystemManagementServiceSettingData class

  • Article

Represents the settings for the virtualization service present on a single host system. The properties for this class cannot be modified directly. The client must call the ModifyServiceSettings method of the Msvm_VirtualSystemManagementService class to modify any of these properties.

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_VirtualSystemManagementServiceSettingData : CIM_SettingData
{
  string  InstanceID = "Microsoft:host";
  string  Caption = "Hyper-V Virtual System Management Service";
  string  Description = "Settings for the Virtual System Management Service";
  string  ElementName = "Hyper-V Virtual System Management Service";
  string  BiosLockString;
  string  DefaultExternalDataRoot = "root\ProgramData\Microsoft\Windows\Virtualization";
  string  DefaultVirtualHardDiskPath = "root\Users\Public\Documents\Virtual Hard Disks";
  string  MaximumMacAddress;
  string  MinimumMacAddress;
  boolean NumaSpanningEnabled;
  string  PrimaryOwnerContact = "";
  string  PrimaryOwnerName = "Administrators";
  uint32  HbaLunTimeout;
  string  MaximumWWPNAddress;
  string  MinimumWWPNAddress;
  string  CurrentWWNNAddress;
  uint16  DefaultVirtualHardDiskCachingMode;
  boolean HypervisorRootSchedulerEnabled;
  boolean EnhancedSessionModeEnabled;
};

Members

The Msvm_VirtualSystemManagementServiceSettingData class has these types of members:

Properties

The Msvm_VirtualSystemManagementServiceSettingData class has these properties.

BiosLockString

Data type: string

Access type: Read-only

Qualifiers: Maxlen (32)

Used by OEMs to allow BIOS-locked Windows operating systems to run in the virtual machine. This string must be exactly 32 characters in length.

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

Caption

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Virtual System Management Service".

CurrentWWNNAddress

Data type: string

Access type: Read-only

The world wide node name (WWNN) address for dynamically generated world wide name addresses used for synthetic host bus adapters.

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

DefaultExternalDataRoot

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_VirtualSystemSettingData.ConfigurationDataRoot")

The default external data root. By default, "root\ProgramData\Microsoft\Windows\Virtualization".

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

DefaultVirtualHardDiskCachingMode

Data type: uint16

Access type: Read-only

Indicates whether in-memory file caching should be used for disks by default. This value can be overridden on a per-disk basis in the CachingMode field of the Msvm_StorageAllocationSettingData class.

Note

Added in Windows 10 and Windows Server 2016.

Unknown (0)

No Caching (3)

Cache Sharable Parents (4)

DefaultVirtualHardDiskPath

Data type: string

Access type: Read-only

The default virtual hard disk path. By default, "root\Users\Public\Documents\Virtual Hard Disks".

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

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 "Settings for the Virtual System Management Service".

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Virtual System Management Service". Changing this property will change the ElementName property of the associated CIM_LogicalDevice derivative.

EnhancedSessionModeEnabled

Data type: boolean

Access type: Read-only

Indicates whether enhanced session mode is permitted on the server. True indicates permitted, otherwise False.

Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.

HbaLunTimeout

Data type: uint32

Access type: Read-only

Specifies the amount of time that the synthetic Fibre Channel virtual device will wait for a logical unit number (LUN) to appear before starting a virtual machine.

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

HypervisorRootSchedulerEnabled

Data type: boolean

Access type: Read-only

Whether or not the hypervisor root scheduler is enabled.

Note

Added in Windows 10, version 1709.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData, and it is always set to "Microsoft:host", where host is the NetBIOS name of the hosting computer system.

MaximumMacAddress

Data type: string

Access type: Read-only

The maximum MAC address for dynamically generated MAC addresses.

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

MaximumWWPNAddress

Data type: string

Access type: Read-only

The maximum world wide port name (WWPN) address for dynamically generated world wide name addresses used for synthetic host bus adapters.

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

MinimumMacAddress

Data type: string

Access type: Read-only

The minimum MAC address for dynamically generated MAC addresses.

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

MinimumWWPNAddress

Data type: string

Access type: Read-only

The minimum world wide port name address for dynamically generated world wide name addresses used for synthetic host bus adapters.

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

NumaSpanningEnabled

Data type: boolean

Access type: Read-only

Specifies whether memory can be allocated from remote nonuniform memory access (NUMA) nodes when starting a virtual machine or when assigning memory to a virtual machine by dynamic memory. This can be one of the following values.

Value Meaning
True
 Memory can be allocated from both local and remote NUMA nodes.
False
 Memory can be allocated only from the NUMA node assigned to the virtual machine.

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

PrimaryOwnerContact

Data type: string

Access type: Read-only

Qualifiers: Maxlen (256), Mappingstrings ("MIF.DMTF|General Information|001.4")

Describes how the primary system owner can be reached (for example, phone number or email address). By default, empty. This name may not exceed 256 characters in length.

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

PrimaryOwnerName

Data type: string

Access type: Read-only

Qualifiers: Maxlen (64), Mappingstrings ("MIF.DMTF|General Information|001.3")

The name of the primary system owner. By default, "Administrators". This value may not exceed 64 characters in length.

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

Remarks

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

See also

CIM_SettingData

ModifyServiceSettings

CIM_SettingData

Virtual System Management Classes