Edit

MigrateVirtualSystemToHost method of the Msvm_VirtualSystemMigrationService class

  • Article

Migrates a virtual system or the storage of a virtual system to a destination host specified by a hostname.

Syntax

uint32 MigrateVirtualSystemToHost(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [in]  string                 DestinationHost,
  [in]  string                 MigrationSettingData,
  [in]  string                 NewSystemSettingData,
  [in]  string                 NewResourceSettingData[],
  [out] CIM_ConcreteJob    REF Job
);

Parameters

ComputerSystem [in]

A reference to an instance of the Msvm_ComputerSystem class that represents the virtual computer system to be migrated.

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.

Job [out]

If the operation is performed asynchronously, this method will return 4096, and this parameter will contain a reference to an object derived from CIM_ConcreteJob.

Return value

This method returns one of the following values.

Method Parameters Checked - Job Started (4096)

Failed (32768)

Access Denied (32769)

Not Supported (32770)

Status is unknown (32771)

Timeout (32772)

Invalid parameter (32773)

System is in used (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

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