Msvm_VirtualSystemMigrationServiceSettingData class

Represents the settings for the virtual system migration service on a host. The properties for this class cannot be modified directly. The client must call the Msvm_VirtualSystemMigrationService.ModifyServiceSettings method 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_VirtualSystemMigrationServiceSettingData : CIM_SettingData
{
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  boolean EnableVirtualSystemMigration;
  uint32  MaximumActiveVirtualSystemMigration;
  uint32  MaximumActiveStorageMigration;
  uint32  AuthenticationType;
  boolean EnableCompression = True;
  boolean EnableSmbTransport = False;
};

Members

The Msvm_VirtualSystemMigrationServiceSettingData class has these types of members:

• Properties

Properties

The Msvm_VirtualSystemMigrationServiceSettingData class has these properties.

AuthenticationType

Data type: uint32

Access type: Read-only

Specifies the authentication mechanism used for virtual system migration network connections. This is a read-only property, but it can be changed by using the ModifyServiceSettings method of the Msvm_VirtualSystemMigrationService class.

CredSSP (0)

Kerberos (1)

Caption

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from the CIM_ManagedElement class.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

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 compression of live migration traffic is enabled or disabled. True indicates enabled.

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

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

EnableSmbTransport

Data type: boolean

Access type: Read/write

Indicates whether use of SMB as a transport type for transferring VM state between the Hyper-V hosts during virtual system migration is enabled or disabled. True indicates enabled. A higher performance is achieved if RDMA NICs are configured for SMB transport during VM live migration. If EnableSmbTransport value is true, the value of EnableCompression is ignored.

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

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

EnableVirtualSystemMigration

Data type: boolean

Access type: Read-only

Specifies whether virtual system migration is enabled or disabled. Storage migration is always enabled. This is a read-only property, but it can be changed by using the ModifyServiceSettings method of the Msvm_VirtualSystemMigrationService class.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

MaximumActiveStorageMigration

Data type: uint32

Access type: Read-only

Specifies the maximum number of active storage migrations allowed. This is a read-only property, but it can be changed by using the ModifyServiceSettings method of the Msvm_VirtualSystemMigrationService class.

MaximumActiveVirtualSystemMigration

Data type: uint32

Access type: Read-only

Specifies the maximum number of active virtual system migrations allowed. This is a read-only property, but it can be changed by using the ModifyServiceSettings method of the Msvm_VirtualSystemMigrationService class.

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