Get Network Info for a Specific ESXi Host

Product version: 10.11

Last modified: 31 July 2024

Collects the data for all networks within a specific ESXi host in Inventory. The returned identifier parameter for the necessary virtual network 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": [{ 
            "nodeType": "VMWARE_ESX",
            "nodeId": 1,
            "includeTypes": ["VMWARE_NETWORK"]
            }], 
        "type": "rpc",
        "tid": 2}'

Request Fields

Field	Type	Value(s)
`action`	string	`InventoryManagement`
`method`	string	`list`
`data`	array	See parameters below
`type`	string	`rpc`
`tid`	integer	`2`

data

Field	Type	Value(s)
`nodeType`	string	Type of inventory item; in this case, `“VMWARE_ESX”`
`nodeId`	string	The ID of the chosen node type; in this case, the ESXi host identifier value obtained previously
`includeTypes`	string	Specifies the type of objects to list; for networks, `["VMWARE_NETWORK"]`

Response Sample

curl

Copy

 {
   "action": "InventoryManagement",
   "method": "list",
   "tid": "2",
   "type": "rpc",
   "message": null,
   "where": null,
   "cause": null,
   "data": {
       "children": [
           {
               "switchName": null,
               "parentName": "A",
               "identifier": 1,
               "vid": "VMWARE_NETWORK-1",
               "type": "VMWARE_NETWORK",
               "subType": "NORMAL",
               "name": "10.10.88.0",
               "description": null,
               "accessible": false,
               "isDisabled": false,
               "replicable": false,
               "hvType": "VMWARE",
               "flags": 0,
               "subName": null,
               "children": null
           },
           {
               "switchName": null,
               "parentName": "B",
               "identifier": 2,
               "vid": "VMWARE_NETWORK-2",
               "type": "VMWARE_NETWORK",
               "subType": "NORMAL",
               "name": "10.11.88.0",
               "description": null,
               "accessible": false,
               "isDisabled": false,
               "replicable": false,
               "hvType": "VMWARE",
               "flags": 0,
               "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 networks in ESXi host

data.children

Field	Value	Description
`switchName`	string	Name of the switch, if applicable
`parentName`	string	Name of the parent object
`identifier`	`long`	Network ID
`vid`	string	Virtual identifier (VID) of the network
`type`	string	Network type
`subType`	string	Network subtype
`name`	string	Network name
`description`	string	Network description
`accessible`	boolean	`true` if the network is accessible
`isDisabled`	boolean	`true` if the network is disabled
`replicable`	boolean	`true` if the network is replicable
`hvType`	string	Hypervisor type
`flags`	int	0^th-bit checks if the host is free 1^st-bit checks if the host is managed by a vCenter
`children`	array	Network’s child objects, if applicable