CheckVirtualSystemIsMigratableToHost method of the CIM_VirtualSystemMigrationService class

Verifies whether a pending virtual system migration to a host is likely to succeed.

Note

Due to dynamic resource availability, this method does not guarantee that the pending migration will always succeed.

Syntax

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

Parameters

ComputerSystem [in]

A reference to the source virtual system to migrate.

DestinationHost [in]

The host system that will receive the migration. The format of this property is specified in the DestinationHostFormatsSupported property of the CIM_VirtualSystemMigrationCapabilities instance that is associated with the migration operation.

MigrationSettingData [in]

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

NewSystemSettingData [in]

An embedded instance of the CIM_VirtualSystemSettingData class that represents new properties for the virtual system after migration is complete.

NewResourceSettingData [in]

Array that contains embedded instances of the CIM_ResourceAllocationSettingData class that represents new properties for virtual resources of the virtual system after migration is complete.

IsMigratable [out]

true if the virtual system can be successfully migrated to the host; otherwise, false.

Return value

The possible return values are:

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

Invalid State (5)

Incompatible Parameters (6)

DMTF Reserved (7 4096)

Method Reserved (4097 32767)

Vendor Specific (32768 65535)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Namespace
Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

CIM_VirtualSystemMigrationService