Virtual Machine Query Fault Tolerance Compatibility Ex

This API can be invoked to determine whether a virtual machine is compatible for Fault Tolerance.

The API only checks for VM-specific factors that impact compatibility for Fault Tolerance. Other requirements for Fault Tolerance such as host processor compatibility, logging nic configuration and licensing are not covered by this API. The query returns a list of faults, each fault corresponding to a specific incompatibility. If a given virtual machine is compatible for Fault Tolerance, then the fault list returned will be empty.

Required privileges: VirtualMachine.Config.QueryFTCompatibility

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/QueryFaultToleranceCompatibilityEx

COPY

Path Parameters

string

moId

Required

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 VirtualMachine/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

QueryFaultToleranceCompatibilityExRequestType of type(s) application/json

Required

{
    "forLegacyFt": false
}

boolean

forLegacyFt

Optional

checks for legacy record-replay FT compatibility only if this is set to true.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns Array of MethodFault of type(s) application/json

[
    {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    }
]

500

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

VmConfigFault: if the virtual machine's configuration is invalid.

NotSupported: if the virtual machine is a template or this operation is not supported.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Machine Operations