Search Index APIs

Search Index APIs

The SearchIndex service allows a client to efficiently query the inventory for a specific managed entity by attributes such as UUID, IP address, DNS name, or datastore path.

Such searches typically return a VirtualMachine or a HostSystem. While searching, only objects for which the user has sufficient privileges are considered. The findByInventoryPath and findChild operations only search on entities for which the user has view privileges; all other SearchIndex find operations only search virtual machines and hosts for which the user has read privileges. If the user does not have sufficient privileges for an object that matches the search criteria, that object is not returned.

Operations
POST
Search Index Find All By Dns Name
Finds all virtual machines or hosts by DNS name.
POST
Search Index Find All By Ip
Finds all virtual machines or hosts by IP address, where the IP address is in dot-decimal notation.
POST
Search Index Find All By Uuid
Finds all virtual machines or hosts by UUID.
POST
Search Index Find By Datastore Path
Finds a virtual machine by its location on a datastore.
POST
Search Index Find By Dns Name
Finds a virtual machine or host by DNS name.
POST
Search Index Find By Inventory Path
Finds a managed entity based on its location in the inventory.
POST
Search Index Find By Ip
Finds a virtual machine or host by IP address, where the IP address is in dot-decimal notation.
POST
Search Index Find By Uuid
Finds a virtual machine or host by BIOS or instance UUID.
POST
Search Index Find Child
Finds a particular child based on a managed entity name.