Hierarchical List of Inventory Items

Product version: 10.11

Last modified: 31 July 2024

Lists all inventory items and their children in a hierarchical structure.

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

Copy 
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
        "action": "InventoryManagement",
        "method": "collect",
        "data": [{
            "viewType": "VIRTUAL_ENVIRONMENT",
            "rootNodeVid": null}],
        "type": "rpc",
        "tid": 9}'

Request Fields

Field
Type
Value(s)
action string

InventoryManagement

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

VIRTUAL_ENVIRONMENT for VMware inventory

HYPERV_VIRTUAL_ENVIRONMENT for Hyper-V inventory

AWS_ENVIRONMENT for AWS inventory

NUTANIX_VIRTUAL_ENVIRONMENT for Nutanix inventory

PHYSICAL_ENVIRONMENT for physical servers inventory
rootNodeVid string The VID of the parent node. null for the top-level one

Response Samples

Copy 
 {
  "action": "InventoryManagement",
  "method": "collect",
  "tid": "9",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "children": [{
      "identifier": 1,
      "vid": "VMWARE_VC-1",
      "type": "VMWARE_VC",
      "subType": null,
      "name": "vCenter",
      "accessible": true,
      "isDisabled": false,
      "replicable": true,
      "hvType": "VMWARE",
      "flags": 0,
      "children": [{
          "identifier": 1,
          "vid": "VMWARE_DATACENTER-1",
          "type": "VMWARE_DATACENTER",
          "subType": null,
          "name": "DEV",
          "accessible": true,
          "isDisabled": false,
          "replicable": true,
          "hvType": "VMWARE",
          "flags": 0,
          "children": [{
            "version": "6.5.0",
            "hwVersion": 13,
            "free": false,
            "standalone": false,
            "managed": true,
            "powerState": "ON",
            "lid": "VMWARE_VMWARE_ESX_host-2322_10.30.29.103_44454c4c-3800-1052-8042-c3c04f53334a",
            "sc": 1,
            "extendedInfo": null,
            "identifier": 1,
            "vid": "VMWARE_ESX-1",
            "type": "VMWARE_ESX",
            "subType": null,
            "name": "10.30.29.103",
            "accessible": true,
            "isDisabled": false,
            "replicable": true,
            "hvType": "VMWARE",
            "flags": 2,
            "children": null
          }]
        }
}

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 Node ID
vid string Node VID
type string The type of the node
subType string Subtype of the node
name string Display name

description

string

Node description
accesible boolean true if the node is accessible
isDisabled boolean true if the node is disabled
replicable boolean true if the node can be replicated
hvType string Platform type
flags

For VMware ESXi hosts:

  • 0th bit checks if the ESXi host is free;
  • 1st bit checks if the host is managed by vCenter.

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

memorySize

long

host specific. Memory size

morId

string

host specific. Managed object reference ID of VM
lid string Item identifier for licensing purposes

hostCount

int

cluster specific. Host count

largestMemorySize

long

cluster specific. Largest memory size
sc int Socket count

hostLid

string

VM specific. Host LID

hostSc

int

VM specific. Host socket count. Applicable to Microsoft Hyper-V

hostVid

string

VM specific. Host VID

hostVersion

string

VM specific. Host version

isTemplate

boolean

VM specific. true if the VM is a template

isWindowsPlatform

boolean

VM specific. true if VM is on Windows platform

replicationState

string

VM specific. Replication state

notSupportedReason

string

VM specific. Reason for not being supported

warningReason

string

VM specific. Warning reason

isReplicatedFromBackupObject

boolean

VM specific. true if VM is replicated from a backup object
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

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

For VMware ESXi hosts:

  • 0th bit checks if the ESXi host is free
  • 1st bit checks if the host is managed by vCenter