Get Network Info for a Specific ESXi Host
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
Request Example
![Closed](../../../Skins/Default/Stylesheets/Images/transparent.gif)
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) |
---|---|---|
|
string |
|
|
string |
|
|
array |
See parameters below |
|
string |
|
|
integer |
|
data
Field |
Type |
Value(s) |
---|---|---|
|
string |
Type of inventory item; in this case, |
|
string |
The ID of the chosen node type; in this case, the ESXi host identifier value obtained previously |
|
string |
Specifies the type of objects to list; for networks, |
Response Sample
![Closed](../../../Skins/Default/Stylesheets/Images/transparent.gif)
{
"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 |
---|---|---|
|
string |
Message if the request failed |
|
string |
Reference to the method where a problem occurred |
|
string |
Cause of failure |
|
array |
See parameters below |
|
integer |
Total number of located networks in ESXi host |
data.children
Field |
Value |
Description |
---|---|---|
|
string |
Name of the switch, if applicable |
|
string |
Name of the parent object |
|
long |
Network ID |
|
string |
Virtual identifier (VID) of the network |
|
string |
Network type |
|
string |
Network subtype |
|
string |
Network name |
|
string |
Network description |
|
boolean |
|
|
boolean |
|
|
boolean |
|
|
string |
Hypervisor type |
|
int |
0th-bit checks if the host is free 1st-bit checks if the host is managed by a vCenter |
|
array |
Network’s child objects, if applicable |