CheckVirtualSystemIsMigratableToHost method of the Msvm_VirtualSystemMigrationService class

Determines whether the specified virtual system can be migrated to a target host specified by a network name or IP address.

Syntax

uint32 CheckVirtualSystemIsMigratableToHost(
  [in]  Msvm_ComputerSystem REF ComputerSystem,
  [in]  string                  DestinationHost,
  [in]  string                  MigrationSettingData,
  [in]  string                  NewSystemSettingData,
  [in]  string                  NewResourceSettingData[],
  [out] boolean                 IsMigratable
);

Parameters

ComputerSystem [in]

A reference to an instance of the Msvm_ComputerSystem class that represents the virtual machine to test the migration ability of.

DestinationHost [in]

The name of the host system for the migration. The format of this name is specified by the DestinationHostFormatsSupported property of the Msvm_VirtualSystemMigrationCapabilities class associated with this class.

MigrationSettingData [in]

An embedded instance of the Msvm_VirtualSystemMigrationSettingData class that represents settings for the migration operation.

NewSystemSettingData [in]

An embedded instance of the Msvm_VirtualSystemSettingData class that represents new properties applicable to the virtual system after it is migrated.

NewResourceSettingData [in]

An array of strings that contain an embedded instance of the Msvm_ResourceAllocationSettingData class that represents the new properties applicable to virtual resources of the virtual system after it is migrated.

IsMigratable [out]

Receives the migration check result indicating whether the virtual system can be successfully migrated.

Return value

This method returns one of the following values.

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

Invalid State (5)

Incompatible Parameters (6)

DMTF Reserved (..)

Method Reserved (4097..32767)

Vendor Specific (32768..65535 )

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

Msvm_VirtualSystemMigrationService