GetSystemCompatibilityInfo method of the Msvm_VirtualSystemMigrationService class

Generates an opaque BLOB of data that contains compatibility information for the specified system.

Syntax

uint32 GetSystemCompatibilityInfo(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [out] uint8                  CompatibilityInfo[]
);

Parameters

ComputerSystem [in]

A reference to a CIM_ComputerSystem class that represents the VM to retrieve compatibility information. If the ComputerSystem parameter refers to the hosting computer system, the data returned in the CompatibilityInfo parameter can be used to determine whether any of the VMs on the hosting computer system can be quickly migrated to another hosting computer system.

CompatibilityInfo [out]

An opaque blob of data that can be passed to the CheckSystemCompatibilityInfo method on another hosting computer system to confirm compatibility.

Return value

This method returns one of the following values.

Completed with No Error (0)

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 use (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

Remarks

The GetSystemCompatibilityInfo method is used in conjunction with CheckSystemCompatibilityInfo to determine whether a quick or live migration of a VM to another hosting computer system is possible without first trying the migration. The compatibility information is dependent on the current EnabledState property of the system specified in the ComputerSystem parameter. In addition, the compatibility information for a VM may change when a snapshot is applied or the system is restarted. A VM in the Disabled state (EnabledState property value of 3) is compatible with more systems than one in the Suspended or Enabled states (EnabledState property value of 32769 or 2.)

Requirements

See also

Msvm_VirtualSystemMigrationService