Service Instance Query V Motion Compatibility

Deprecated as of vSphere API 4.0, use QueryVMotionCompatibilityEx_Task instead.

Investigates the general VMotion compatibility of a virtual machine with a set of hosts.

The virtual machine may be in any power state. Hosts may be in any connection state and also may be in maintenance mode.

Required privileges: Resource.QueryVMotion

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ServiceInstance/{moId}/QueryVMotionCompatibility

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

string

release

Required

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

Request Body

QueryVMotionCompatibilityRequestType of type(s) application/json

Required

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "host": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "compatibility": [
        "string"
    ]
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

array of MoRefHostSystem

host

Required

The group of hosts to analyze for compatibility.

array of string

compatibility

Optional

The set of compatibility types to investigate. Each is a string chosen from VMotionCompatibilityType. If this argument is not set, then all compatibility types are investigated.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array where each element, associated with one of the input hosts, specifies which of the requested compatibility types applies to that host. If an input host has never been connected and therefore has no information available for determining its compatibility, it is omitted from the return list.

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

[
    {
        "_typeName": "string",
        "host": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "compatibility": [
            "string"
        ]
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Service Instance Operations

POST

Service Instance Current Time

GET