Msvm_VirtualSystemManagementServiceSettingData class
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.
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_VirtualSystemManagementServiceSettingData : CIM_SettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
string BiosLockString;
string DefaultExternalDataRoot;
string DefaultVirtualHardDiskPath = "root\Users\Public\Documents\Virtual Hard Disks";
string MaximumMacAddress;
string MinimumMacAddress;
boolean NumaSpanningEnabled;
boolean EnhancedSessionModeEnabled;
string PrimaryOwnerContact = "Administrators";
string PrimaryOwnerName = "Administrators";
uint32 HbaLunTimeout;
string MaximumWWPNAddress;
string MinimumWWPNAddress;
string CurrentWWNNAddress;
uint16 DefaultVirtualHardDiskCachingMode;
};
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
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
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 property of the Msvm_StorageAllocationSettingData class.
The possible values are:
-
-
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 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.
EnhancedSessionModeEnabled
-
Data type: boolean
-
Access type: Read-only
Indicates whether enhanced session mode is permitted on the server. true indicates permitted, otherwise false.
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.
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.
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.
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")
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.
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.
Requirements
Minimum supported client |
None supported |
Minimum supported server |
Windows Server 2016 |
Namespace |
Root\HyperVCluster\v2 |
MOF |
|
DLL |
|