Single Child Item Info

Product version: 10.11

Last modified: 31 July 2024

Returns a single child item info.

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": "getNodes",
        "data": [true,["VM-311"]],
        "type": "rpc",
        "tid": 1}'

Request Fields

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

Data

Field	Value	Description
`fillInExtendeInfo`	boolean	True if extended node info
`vidList`	`Array of string`	VID of the requested inventory item

Response Sample

curl

Copy

{
    "action": "InventoryManagement",
    "method": "getNodes",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "powerState": "OFF",
                "hostLid": "VMWARE_VMWARE_ESX_host-58_182.20.0.16_00000000-0000-0000-0000-ac1f6b776d38",
                "hostSc": 1,
                "hostVid": "VMWARE_ESX-4",
                "hostVersion": "6.7.0",
                "lid": "VMWARE_VM_vm-1995_529dca90-18e0-5bed-d2b0-9cd9902acd7b_564d4045-9430-46d1-0013-e259b6ba8eb4",
                "isTemplate": false,
                "isWindowsPlatform": false,
                "replicationState": "UNKNOWN",
                "notSupportedReason": null,
                "warningReason": null,
                "isReplicatedFromBackupObject": false,
                "osType": "UNKNOWN",
                "ftEnabled": null,
                "ftVmVids": null,
                "extendedInfo": {
                    "hostVid": "VMWARE_ESX-4",
                    "clusterVid": null,
                    "disks": [
                        {
                            "diskIdentifier": "[HDD-Datastore] binh_centos7/binh_centos7.vmdk",
                            "allocated": 1314816,
                            "storageVid": "VMWARE_DATASTORE-14",
                            "storagePath": null,
                            "controllerType": null,
                            "canBeProcessed": true,
                            "isRoot": null,
                            "identifier": 733,
                            "vid": "VMWARE_VDISK-733",
                            "type": "VMWARE_VDISK",
                            "subType": null,
                            "name": "Hard disk 1",
                            "description": null,
                            "accessible": true,
                            "isDisabled": false,
                            "replicable": true,
                            "hvType": "VMWARE",
                            "flags": 0,
                            "children": null
                        },
                        {
                            "diskIdentifier": "[HDD-Datastore] binh_centos7/binh_centos7_1.vmdk",
                            "allocated": 0,
                            "storageVid": "VMWARE_DATASTORE-14",
                            "storagePath": null,
                            "controllerType": null,
                            "canBeProcessed": true,
                            "isRoot": null,
                            "identifier": 734,
                            "vid": "VMWARE_VDISK-734",
                            "type": "VMWARE_VDISK",
                            "subType": null,
                            "name": "Hard disk 2",
                            "description": null,
                            "accessible": true,
                            "isDisabled": false,
                            "replicable": true,
                            "hvType": "VMWARE",
                            "flags": 0,
                            "children": null
                        }
                    ],
                    "nics": [
                        {
                            "nicIdentifier": "00:0c:29:ba:8e:b4",
                            "networkVid": "VMWARE_NETWORK-41",
                            "canBeProcessed": true,
                            "identifier": 322,
                            "vid": "VMWARE_VNIC-322",
                            "type": "VMWARE_VNIC",
                            "subType": null,
                            "name": "Network adapter 1",
                            "description": null,
                            "accessible": true,
                            "isDisabled": false,
                            "replicable": true,
                            "hvType": "VMWARE",
                            "flags": 0,
                            "children": null
                        }
                    ],
                    "originalInfo": null,
                    "cpu": 1,
                    "memorySize": 512,
                    "size": 1314816,
                    "version": 13,
                    "hwUuid": "564d4045-9430-46d1-0013-e259b6ba8eb4",
                    "storageVid": "VMWARE_DATASTORE-14",
                    "virtualizationType": null,
                    "instanceType": null,
                    "vpcId": null,
                    "vpcCidrBlock": null,
                    "subnetId": null,
                    "subnetCidrBlock": null,
                    "availabilityZoneId": null,
                    "securityGroupIds": null,
                    "hasRootDisk": null
                },
                "identifier": 311,
                "vid": "VM-311",
                "type": "VM",
                "subType": "VM",
                "name": "binh_centos7",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": true,
                "hvType": "VMWARE",
                "flags": 0,
                "children": null
            }
        ],
        "totalCount": 1,
        "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	See below

data.children (container level: host, cluster, folder, VM)

Field	Value	Description
`powerState`	string	Power state of the object
`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
`lid`	string	Item identifier for licensing purposes
`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
`osType`	string	WINDOWS, LINUX, UNKNOWN
`ftEnabled`	boolean	True if FaultTolerance is enabled
`ftVmVids`	string	Fault tolerance VM VIDs
`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

data.children.Extend Info

Field	Value	Description
`hostVid`	string	VM specific. Host VID
`clusterVid`	string	Cluster VID
`disks`	array	See below
`nics`	array	See below
`originalInfo`	string	VM original info
`cpu`	int	VM specific. Number of CPU
`memorySize`	`long`	VM specific. Memory size
`size`	`long`	VM specific. VM size
`version`	`long`	Platform version
`hwUuid`	string	HW UUID
`storageVid`	string	Storage VID
`virtualizationType`	string	AWS-specific: virtualization type
`instanceType`	string	AWS-specific: instance type
`vpcId`	string	AWS-specific: VPC ID
`vpcCidrBlock`	string	AWS-specific: VPC CIDR Block
`availabilityZoneId`	string	AWS-specific: availability zone ID
`securityGroupIds`	string	AWS-specific:security group ID
`hasRootDisk`	boolean	AWS-specific: backup count which savepoints have a Root volume

children.ExtendInfo.Disk

Field	Value	Description
`diskIdentifier`	string	Disk identity name
`allocated`	`long`	Size of backup repository file(s) on the filesystem
`storageVid`	string	Storage VID
`storagePath`	string	Storage path
`controllerType`	string	Disk controller type
`canBeProcessed`	boolean	True if disk can be processed
`isRoot`	boolean	AWS-specific: true if it is root
`identifier`	`long`	Disk identity number
`vid`	string	Disk VID
`type`	string	Disk type
`subType`	string	Disk subtype
`name`	string	Disk name
`description`	string	Disk description
`accessible`	boolean	True if Disk is accessible
`isDisabled`	boolean	True if Disk is disabled
`replicable`	boolean	True if the Disk can be replicated
`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 vCenter
`children`		Partitions into disks (If present)

children.ExtendInfo.nics

Field	Value	Description
`nicIdentifier`	string	NIC mac address
`networkVid`	string	Network VID
`canBeProcessed`	boolean	True if NIC is not SKIP
`identifier`	`long`	Network identity
`type`	string	NIC type
`subType`	string	NIC subtype
`name`	string	NIC name
`description`	string	NIC description
`accessible`	boolean	True if NIC is accessible
`isDisabled`	boolean	True if NIC is disabled
`replicable`	boolean	True if the NIC 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