Virtual Machine Compatibility Checker Check Power On Task
Tests whether the provided virtual machine can be powered on on the given host and/or resource pool.
Required privileges: System.View
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualMachineCompatibilityChecker/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"pool": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"testType": [
"string"
]
}
The set of tests to run. If this argument is not set, all tests will be run. See CheckTestTypeEnum for possible values.
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}
InvalidArgument: if the desired host and pool are not associated with the same compute resource, the host parameter is left unset when the specified pool is associated with a non-DRS cluster, or if the provided vm does not exist.
DatacenterMismatch: if the provided host and pool do not belong to the same datacenter.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
The base data object type for all the object model faults that an application might handle.
Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.