List Children of Single Inventory Item

Product version: 10.11

Last modified: 31 July 2024

Returns the list of children of a specified inventory item.

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": "8",
             "includeTypes": ["VMWARE_DATASTORE"]
        }],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`InventoryManagement`
`method`	string	`list`
`data`	array	Request parameters. See below
`type`	string	`rpc`
`tid`	int	1

data

Field	Value	Description
`nodeType`	string	Type of an inventory item. Possible values: for VMware `VMWARE_DISCOVERY_ITEM` `VMWARE_VC` `VMWARE_DATACENTER` `VMWARE_FOLDER` `VMWARE_ESX` `VMWARE_CLUSTER` `VMWARE_RESOURCE_POOL` for Microsoft Hyper-V `HYPERV_DISCOVERY_ITEM` `HYPERV_CLUSTER` `HYPERV_VM` `HYPERV_HOST` for Amazon EC2 `AWS_DISCOVERY_ITEM` `AWS_REGION` `AWS_VPC` for Nutanix AHV `NUTANIX_DISCOVERY_ITEM` `NUTANIX_CLUSTER` `NUTANIX_HOST` `NUTANIX_VM` for Oracle databases `ORACLE_RMAN_DISCOVERY_ITEM` `ORACLE_RMAN_DATABASE_GROUP` `ORACLE_RMAN_DATABASE` for Microsoft Office365 `OFFICE365_DISCOVERY_ITEM` `OFFICE365_EXCHANGE_MAILBOX` `OFFICE365_EXCHANGE_FOLDER` for physical machines `PHYSICAL_MACHINE_GROUP` `PM`
`nodeId`	int	ID of an inventory item
`includeTypes`	array	Resource type of an inventory item. Possible values: for VMware `VMWARE_NETWORK` `VMWARE_DATASTORE` `VMWARE_DATASTORE_CLUSTER` `VMWARE_VDISK` `VMWARE_VNIC` for Microsoft Hyper-V `HYPERV_DISK` `HYPERV_NIC` `HYPERV_NETWORK` for Amazon EC2 `AWS_KEY_PAIR` `AWS_SECURITY_GROUP` `AWS_AVAILABILITY_ZONE` `AWS_AMI` `AWS_EC2INSTANCE` `AWS_VPC` `AWS_SUBNET` for Nutanix AHV `NUTANIX_HOST` `NUTANIX_VM` `NUTANIX_NETWORK` for Oracle databses `ORACLE_RMAN_DATABASE` for Microsoft Office 365 `OFFICE365_EXCHANGE_MAILBOX` `OFFICE365_EXCHANGE_FOLDER` for physical machines `PM`

Response Example:

Datastores from an ESXi host

Copy

{
    "action": "InventoryManagement",
    "method": "list",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "readOnlyHostMorIds": [],
                "free": 24563941376,
                "size": 471372660736,
                "online": true,
                "parentStorageVid": null,
                "identifier": 20,
                "vid": "VMWARE_DATASTORE-20",
                "type": "VMWARE_DATASTORE",
                "subType": "VMFS",
                "name": "SSD_Datastore",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "VMWARE",
                "flags": 0,
                "children": null
            },
            {
                "readOnlyHostMorIds": [],
                "free": 424933326848,
                "size": 3999956729856,
                "online": true,
                "parentStorageVid": null,
                "identifier": 18,
                "vid": "VMWARE_DATASTORE-18",
                "type": "VMWARE_DATASTORE",
                "subType": "VMFS",
                "name": "HDD-Datastore",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "VMWARE",
                "flags": 0,
                "children": null
            },
            {
                "readOnlyHostMorIds": [],
                "free": 0,
                "size": 0,
                "online": true,
                "parentStorageVid": null,
                "identifier": 24,
                "vid": "VMWARE_DATASTORE-24",
                "type": "VMWARE_DATASTORE",
                "subType": "vsan",
                "name": "vsanDatastore",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "VMWARE",
                "flags": 0,
                "children": null
            }
        ],
        "totalCount": 3,
        "lastSessionTime": null
    }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	array	Parameters. See below

data

Field	Value	Description
`readOnlyHostMorIds`	array	Datastore, read-only host MorIDs
`free`	`long`	Free space
`size`	`long`	Size of the datastore
`online`	boolean	`true` if the datastore is online
`parentStorageVid`	string	Virtual identifier (VID) of the parent datastore
`identifier`	int	Datastore ID
`vid`	string	Virtual identifier (VID) of the datastore
`type`	string	Datastore type
`subType`	string	Datastore subtype
`name`	string	Datastore name
`description`	string	Datastore description
`accessible`	boolean	`true` if datastore is accessible
`isDisabled`	boolean	`true` if datastore is disabled
`replicable`	boolean	`false` if datastore is not replicable
`hvType`	string	Hypervisor 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 a vCenter