Get ESXi Host Info

Product version: 10.11

Last modified: 31 July 2024

Collects the data for all ESXi hosts in Inventory. The returned identifier parameter for the necessary ESXi host is required to deploy a transporter as a VMware vSphere appliance.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
        "action": "InventoryManagement",
        "method": "list",
        "data": [{"includeTypes": ["VMWARE_ESX"]}],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`InventoryManagement`
`method`	string	`list`
`data`	array	Inventory search parameters
`type`	string	`rpc`
`tid`	integer	`1`

Response Sample

curl

Copy

 {
   "action": "InventoryManagement",
   "method": "list",
   "tid": "1",
   "type": "rpc",
   "message": null,
   "where": null,
   "cause": null,
   "data": {
       "children": [
           {
               "version": "6.0.0",
               "apiVersion": "6.0",
               "hwVersion": 11,
               "free": false,
               "standalone": false,
               "managed": true,
               "powerState": "UNKNOWN",
               "memorySize": 16374,
               "lid": "VMWARE_VMWARE_ESX_host-361_10.74.0.4_2f3c4544-0032-3810-804c-c4c04g4b344a",
               "sc": 1,
               "morId": "host-361",
               "tc": 4,
               "proxyTransporterNodeInfo": null,
               "extendedInfo": null,
               "identifier": 2,
               "vid": "VMWARE_ESX-2",
               "type": "VMWARE_ESX",
               "subType": null,
               "name": "10.84.0.4",
               "description": null,
               "accessible": false,
               "isDisabled": false,
               "replicable": true,
               "hvType": "VMWARE",
               "flags": 2,
               "subName": null,
               "children": null
           },
           {
               "version": "6.0.0",
               "apiVersion": "6.0",
               "hwVersion": 11,
               "free": false,
               "standalone": false,
               "managed": true,
               "powerState": "ON",
               "memorySize": 131037,
               "lid": "VMWARE_VMWARE_ESX_host-23_10.74.255.12_00000000-0000-0000-0000-003540a2d690",
               "sc": 2,
               "morId": "host-23",
               "tc": 40,
               "proxyTransporterNodeInfo": null,
               "extendedInfo": null,
               "identifier": 1,
               "vid": "VMWARE_ESX-1",
               "type": "VMWARE_ESX",
               "subType": null,
               "name": "10.84.255.17",
               "description": null,
               "accessible": false,
               "isDisabled": false,
               "replicable": true,
               "hvType": "VMWARE",
               "flags": 2,
               "subName": null,
               "children": null
           }
       ],
       "totalCount": 2
   }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where a problem occurred
`cause`	string	Cause of failure
`data.children`	array	See parameters below
`data.totalCount`	integer	Total number of located ESXi hosts in inventory

data.children

Field	Value	Description
`version`	string	Platform version
`apiVersion`	string	API version
`hwVersion`	string	Highest supported virtual hardware version
`free`	boolean	`true` if the ESXi host is free
`standalone`	boolean	`true` if the object is a standalone one
`managed`	boolean	`true` if the host is managed by the vCenter
`powerState`	string	Power state of the object
`memorySize`	`long`	host specific. Memory size
`lid`	string	Item identifier for licensing purposes
`sc`	int	Socket count
`morId`	string	Managed object reference ID
`tc`	integer
`proxyTransporterNodeInfo`		Proxy transporter node information, if applicable
`extendedInfo`		Extended info (if applicable)
`identifier`	`long`	Host ID
`vid`	string	Object VID
`type`	string	Object type
`subType`	string	Object subtype, if applicable
`name`	string	Display name
`description`	string	Object description
`accessible`	boolean	`true` if the object is accessible
`isDisabled`	boolean	`true` if the object is disabled
`replicable`	boolean	`true` if the object can be replicated
`hvType`	string	Platform type
`flags`	int	0th bit checks if the host is free 1st bit checks if the host is managed by vCenter
`subName`	string	Sub-name, if applicable
`children`	array	ESXi host’s child objects, if applicable