GetSystemCompatibilityInfo method of the Msvm_VirtualSystemManagementService class

Article
05/31/2018

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]

Type: CIM_ComputerSystem

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]

Type: uint8[]

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

Return value

Type: uint32

This method returns one of the following values.

Return code/value	Description
Completed with No Error 0	The operation completed with no error.
Method Parameters Checked - Job Started 4096	The system has started.
Failed 32768	The operation failed.
Access Denied 32769	The user does not have the permissions required to complete this operation.
Not Supported 32770	The operation is not supported.
Status is unknown 32771	The operation failed due to an unknown status.
Timeout 32772	The operation did not complete due to a time-out.
Invalid parameter 32773	The operation did not complete due to a parameter that is not valid.
System is in use 32774	The operation did not complete because a required service is in use.
Invalid state for this operation 32775	The system represented by the ComputerSystem parameter is in a transitional state (for example, Starting, Stopping, Saving) or a snapshot operation is in progress. Please wait for the operation to complete and call the GetSystemCompatibilityInfo method again.
Incorrect data type 32776	The operation failed due to an incorrect data type.
System is not available 32777	The operation failed because a required system service is not available.
Out of memory 32778	The operation did not complete because there is insufficient memory available.

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.)

Access to the Msvm_VirtualSystemManagementService class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2
End of client support	None supported
End of server support	Windows Server 2012
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof