Lists all inventory items and their children in a hierarchical structure.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
Request Fields
Field | Type | Value(s) |
---|---|---|
action | string |
|
method | string | collect |
data | array | Request parameters. See below |
type | string | rpc |
tid | int | 1 |
Data
Field | Type | Description | Possible values |
---|---|---|---|
viewType | string | Defines the platform, for which the inventory must be returned |
|
rootNodeVid | string | The VID of the parent node. null for the top-level one |
Response Samples
VMware
Response Fields
Field | Type | Description |
---|---|---|
message | string | Message if the request failed |
where | string | Reference to the method where a problem occurred |
cause | string | Cause of failure |
data | array | See below |
data.children and data.children.children (vCenter and data center levels)
Field | Type | Description |
---|---|---|
identifier | long | Object ID |
vid | string | Object VID |
type | string | The type of the object |
subType | string | Subtype of the object |
name | string | Display name |
| string | Object description |
accesible | 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 | For VMware ESXi hosts:
|
data.children.children.children (container level: host, cluster, folder, VM
)
Field | Type | Description |
---|---|---|
version | string | Platform version |
hwVersion | long | For VMware, Hyper-V, and Nutanix, max supported virtual hardware version |
free | boolean | For ESXi hosts: checks if the host is free |
standalone | boolean | true if the object is a standalone one |
managed | boolean | For ESXi hosts: is managed by the vCenter |
powerState | string | Power state of the object |
| long |
|
| string |
|
lid | string | Item identifier for licensing purposes |
| int |
|
| long |
|
sc | int | Socket count |
| string |
|
| int |
|
| string |
|
| string |
|
| boolean |
|
| boolean |
|
| string |
|
| string |
|
| string |
|
| boolean |
|
extendedInfo | Extended info (if present) | |
identifier | long | Object ID |
vid | string | Object VID |
type | string | Object type |
subType | string | Object subtype |
name | string | Display name |
| 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 | For VMware ESXi hosts:
|