Search Index Find By Dns Name

Search Index Find By Dns Name

Finds a virtual machine or host by DNS name.

The DNS name for a virtual machine is the one returned from VMware tools, hostName.

Required privileges: System.View

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

Request Body
FindByDnsNameRequestType of type(s) application/json
Required

Show optional properties

{
    "dnsName": "string",
    "vmSearch": false
}
{
    "datacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "dnsName": "string",
    "vmSearch": false
}
MoRefDatacenter
datacenter
Optional

Reference to an instance of the Datacenter managed object.

string
dnsName
Required

The fully qualified domain name to find.

boolean
vmSearch
Required

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

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"
}

On This Page
Virtual Infrastructure Operations
POST
Search Index Find All By Dns Name
POST
Search Index Find All By Ip
POST
Search Index Find All By Uuid
POST
Search Index Find By Datastore Path
POST
Search Index Find By Dns Name
POST
Search Index Find By Inventory Path
POST
Search Index Find By Ip
POST
Search Index Find By Uuid
POST
Search Index Find Child