Search Index Find By Uuid

Search Index Find By Uuid

Finds a virtual machine or host by BIOS or instance UUID.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/SearchIndex/{moId}/FindByUuid
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 SearchIndex/{moId}.

string
release
Required

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


Request Body
FindByUuidRequestType of type(s) application/json
Required
{
    "datacenter": {
        "type": "string",
        "value": "string"
    },
    "uuid": "string",
    "vmSearch": false,
    "instanceUuid": false
}
datacenter
Optional

Reference to an instance of the Datacenter managed object.

string
uuid
Required

The UUID to find. If vmSearch is true, the uuid can be either BIOS or instance UUID.

boolean
vmSearch
Required

If true, search for virtual machines, otherwise search for hosts.

boolean
instanceUuid
Optional

Should only be set when vmSearch is true. If specified, search for virtual machines whose instance UUID matches the given uuid. Otherwise, search for virtual machines whose BIOS UUID matches the given uuid.

Authentication
This operation uses the following authentication methods.
Responses
200

The virtual machine or host managed entity that is found. If no managed entities are found, null is returned. Only a single entity is returned, even if there are multiple matches.

Returns MoRefManagedEntity of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}