Page tree

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

curl
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)
actionstring

InventoryManagement

methodstring
collect
dataarrayRequest parameters. See below
typestringrpc
tidint1

Data

FieldTypeDescriptionPossible values
viewTypestringDefines 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

rootNodeVidstringThe VID of the parent node. null for the top-level one

Response Samples

VMware

 {
  "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
messagestringMessage if the request failed
wherestringReference to the method where a problem occurred
causestringCause of failure
dataarraySee below
data.children and data.children.children (vCenter and data center levels)
FieldTypeDescription
identifierlongObject ID
vidstringObject VID
typestringThe type of the object
subTypestringSubtype of the object
namestringDisplay name

description

string

Object description

accesiblebooleantrue if the object is accessible
isDisabledbooleantrue if the object is disabled
replicablebooleantrue if the object can be replicated
hvTypestringPlatform 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)
FieldTypeDescription
versionstringPlatform version
hwVersionlongFor VMware, Hyper-V, and Nutanix, max supported virtual hardware version
freebooleanFor ESXi hosts: checks if the host is free
standalonebooleantrue if the object is a standalone one
managedbooleanFor ESXi hosts: is managed by the vCenter
powerStatestringPower state of the object

memorySize

long

host specific. Memory size

morId

string

host specific. Managed object reference ID of VM

lidstringItem identifier for licensing purposes

hostCount

int

cluster specific. Host count

largestMemorySize

long

cluster specific. Largest memory size

scintSocket 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)
identifierlongObject ID
vidstringObject VID
typestringObject type
subTypestringObject subtype
namestringDisplay name

description

string

Object description

accessiblebooleantrue if the object is accessible
isDisabledbooleantrue if the object is disabled
replicablebooleantrue if the object can be replicated
hvTypestringPlatform type
flagsint

For VMware ESXi hosts:

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



  • No labels