Msvm_VirtualSystemMigrationSettingData class
Represents the migration settings for migrating a virtual system and the storage attached to 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_VirtualSystemMigrationSettingData : CIM_VirtualSystemMigrationSettingData
{
string InstanceID;
string Caption = "Migration Setting Data";
string Description = "Virtual System Migration Setting Data";
string ElementName;
uint16 MigrationType;
uint16 Priority;
uint16 Bandwidth;
string BandwidthUnit;
string OtherTransportType;
uint16 TransportType;
boolean RemoveSourceUnmanagedVhds;
boolean AvoidRemovingVHDs;
uint16 CPUCappingMagnitude;
boolean CancelIfBlackoutThresholdExceeded;
boolean AllowOverwriteExistingFile;
string UnmanagedVhds[];
string DestinationPlannedVirtualSystemId;
string DestinationIPAddressList[];
boolean RetainVhdCopiesOnSource;
boolean EnableCompression;
};
Members
The Msvm_VirtualSystemMigrationSettingData class has these types of members:
Properties
The Msvm_VirtualSystemMigrationSettingData class has these properties.
-
AllowOverwriteExistingFile
-
-
Data type: boolean
-
Access type: Read/write
Allow the storage migration operation to overwrite existing .vhdx files.
Note
This property was added in Windows 10, version 1703.
-
-
AvoidRemovingVHDs
-
-
Data type: boolean
-
Access type: Read/write
Do not remove any VHDs during the migration, i.e. VHDs on the source in successand VHDs on the destination in failure.
Note
Added in Windows 10, version 1703 and Windows Server 2016.
-
-
Bandwidth
-
-
Data type: uint16
-
Access type: Read-only
Specifies the bandwidth assigned to or requested for a virtual system migration operation. The bandwidth units are specified by the BandwidthUnit property. Within a migration, a value of 0 indicates the default bandwidth. Otherwise, a value of 0 indicates that bandwidths are not supported.
Bandwidth and Priority can be used in conjunction. Migration processes that have the highest equal priority value share the available bandwidth based on their requested bandwidth. If not all bandwidth is consumed by this set of processes, migration processes with the next lower equal priority share the remaining bandwidth. If still more bandwidth remains, migration processes with the next lower equal priority are considered, and so forth.
This property is inherited from CIM_VirtualSystemMigrationSettingData.
-
-
BandwidthUnit
-
-
Data type: string
-
Access type: Read-only
Specifies the units used by the Bandwidth property. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later.
If the value of this property is "percent", the value of the Bandwidth property must be between 0 and 100, with higher values indicating a higher bandwidth. A value of 100 indicates the total available bandwidth for performing virtual system migration operations. Values between 1 and 100 should linearly correlate with the available bandwidth range. For example, a value of 50 should request half of the available bandwidth.
This property is inherited from CIM_VirtualSystemMigrationSettingData.
-
-
CancelIfBlackoutThresholdExceeded
-
-
Data type: boolean
-
Access type: Read/write
Cancels migration if the blackout threshold time is exceeded.
Note
Added in Windows 10, version 1709.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
-
-
CPUCappingMagnitude
-
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: Override ("CPUCappingMagnitude")
Degree of CPU capping during migration.
Note
Added in Windows 10, version 1709.
-
-
Normal (0)
-
Low (1)
-
High (2)
Description
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
DestinationIPAddressList
-
Data type: string array
-
Access type: Read/write
This will be Null for storage migration. For virtual system migration, this can contain a list of IP addresses of the destination host.
DestinationPlannedVirtualSystemId
-
Data type: string
-
Access type: Read/write
If a planned virtual machine exists at the migration destination, this property will be set to the GUID of the destination planned virtual machine where the virtual machine needs to migrate. This is useful for cases where a user has created a planned virtual machine at the destination, along with resource setup, and wants a virtual machine from the source to migrate into this planned virtual machine.
ElementName
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_SettingData.
EnableCompression
-
Data type: boolean
-
Access type: Read/write
Indicates whether to compress the live migration traffic. True indicates to compress; otherwise False.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.
MigrationType
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: Override ("MigrationType")
Specifies the type of migration operation to be performed. This property is inherited from CIM_VirtualSystemMigrationSettingData.
Unknown (0)
VirtualSystem (32768)
Migrates the virtual system to the destination host.
Storage (32769)
Migrates only the storage resources of the virtual system.
Staged (32770)
Using the virtual system configuration, creates a planned virtual system at the destination host.
VirtualSystemAndStorage (32771)
Migrates the virtual system and its storage to the destination host.
StorageDeepCheck (32772)
Performs a virtual system storage resource migration ability check at the destination host.
OtherTransportType
-
Data type: string
-
Access type: Read-only
Specifies the type of transport to be applied if the value of TransportType is 1 (Other). This property is inherited from CIM_VirtualSystemMigrationSettingData.
Priority
-
Data type: uint16
-
Access type: Read-only
Specifies a relative migration importance, which the migration system may use to order or otherwise give preference among multiple pending migration requests. The lower the value, the higher the priority. Within a migration, a value of 0 indicates the default priority. Otherwise, a value of 0 indicates that priorities are not supported.
This property is inherited from CIM_VirtualSystemMigrationSettingData.
RemoveSourceUnmanagedVhds
-
Data type: boolean
-
Access type: Read/write
Remove source unmanaged VHDs.
Note
Added in Windows 10 and Windows Server 2016.
RetainVhdCopiesOnSource
-
Data type: boolean
-
Access type: Read/write
For a storage migration, this specifies whether the read-only VHDs on the source host should be removed after the migration is completed.
TransportType
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: Override ("TransportType")
Specifies the type of transport to be applied for a virtual system migration operation. This property is inherited from CIM_VirtualSystemMigrationSettingData.
Unknown (0)
Other (1)
SSH (2)
TLS (3)
TLS Strict (4)
TCP (5)
IPC (6)
DMTF Reserved (..)
Vendor Reserved (32768..)
For live migration, this property specifies the transport type to be used for transferring virtual system state to the destination host. The supported values are:
TCP (5)
Indicates the TCP transport type.
SMB (32768)
Indicates the transport type for transferring the virtual machine state is SMB.
UnmanagedVhds
-
Data type: string array
-
Access type: Read/write
-
Qualifiers: ArrayType ("Indexed"), HyperVEmbeddedInstance ("Msvm_MoveUnmanagedVhd")
An array of embedded Msvm_MoveUnmanagedVhd instances which contain unmanaged VHDs information.
Note
Added in Windows 10 and Windows Server 2016.
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