CheckSystemCompatibilityInfo method of the Msvm_VirtualSystemManagementService class

Article
2018-05-31

Verifies whether this computer system is able to host the specified virtual machine (VM).

Syntax

uint32 CheckSystemCompatibilityInfo(
  [in]  uint8  CompatibilityInfo[],
  [out] string Reasons[]
);

Parameters

CompatibilityInfo [in]

Type: uint8[]

An opaque blob generated by the GetSystemCompatibilityInfo method that represents either one VM or all VMs hosted by a computer system.

Reasons [out]

Type: string[]

An array of strings containing Msvm_Error instances in CIM-XML format representing warnings or error information. These strings can be passed to the FormatError method to generate error messages.

Return value

Type: uint32

This method returns one of the following values. A return of 0 (Completed with No Error) indicates the systems are compatible. A return of 32784 (Not compatible) indicates that the systems are not compatible. Any other return value indicates an error checking the compatibility information. If CheckSystemCompatibilityInfo returns either 0 or 32784, the Reasons parameter may contain more detailed warning or error information.

Return code/value	Description
Completed with No Error 0	The computer systems are compatible. Msvm_Error objects that warn about potential problems may still be returned through the Reasons parameter.
Method Parameters Checked - Job Started 4096	The job 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	One of the systems represented 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 CheckSystemCompatibilityInfo 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.
Not compatible 32784	The VM is using features that are not supported by the computer system. For more details, see the Msvm_Error objects returned through the Reasons parameter.

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. For more details, see the Remarks section of GetSystemCompatibilityInfo.

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

Share via