List Top-Level Inventory Items

Product version: 10.11

Last modified: 31 July 2024

Lists all inventory items for the selected platform.

The platform is selected by invoking a certain action. See the Request Fields description. Method is the same.

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": "VmwareDiscovery",
        "method": "getDiscoveryItems",
        "data": null,
        "type": "rpc",
        "tid": 1}'

Request Fields

Field
Type
Value(s)
action string

VmwareDiscovery for VMware

HypervDiscovery for Hyper-V

AwsDiscovery for AWS
NutanixDiscovery for Nutanix AHV
PhysicalDiscovery for physical server
method string 
getDiscoveryItems
data array null
type string rpc
tid integer 1

Response Sample

Copy 
 {
  "action": "VmwareDiscovery",
  "method": "getDiscoveryItems",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "items": [
      {
        "host": "hostname",
        "username": "administrator@hostname",
        "port": 443,
        "vid": "VMWARE_DISCOVERY_ITEM-1",
        "name": "vCenter",
        "state": "OK",
        "status": "NONE",
        "changeStatus": "NONE",
        "preventModification": false,
        "locked": false,
        "wasDiscoveredOnce": true,
        "wasEdited": false,
        "progress": 0,
        "targetVid": "VMWARE_VC-1",
        "hostCount": 15,
        "vmCount": 185,
        "alertErrorCode": null,
        "alertTitle": null,
        "alertDescription": null
      }
    ]
  }
}

Response Fields

Field
Value
Description
message string Message if the request failed
where string Reference to the method where a problem occurred
cause string Cause of failure
data Json Information about the inventory item

Data

Field
Value
Description
host string The IP-address or hostname of the inventory item
username string Username to log into the inventory item
port int TCP port opened on a host for the communication with the product
vid string VID of the inventory item
name string Display name of the inventory item

accessKey

string

An access key. Valid for AWS EC2 only

confirmToProceed

boolean

true if user confirmation is required. Valid for AWS EC2 only

type

string

Used for AWS, Hyper-V, and Physical Server. Possible values:

  • For AWS EC2: NORMAL, US_GOVCLOUD, CHINA_BEIJING
  • For Hyper-V: HOST, CLUSTER
  • For Physical: LINUX, WINDOWS

subtype

string

Used for AWS, Hyper-V, and Physical Server. Possible values:

  • For AWS: NORMAL, US_GOVCLOUD, CHINA_BEIJING
  • For Hyper-V: HOST, CLUSTER
  • For Physical: LINUX, WINDOWS
state string State of the inventory item: OK, warning, inaccessible, error
status string The status of the current operation on inventory item: updating or none
changeStatus string The change status of the inventory item. Possible values: NONE, CREATE_PENDING, CHANGE_PENDING
preventModification boolean Checks if the item is locked for the manual editing
locked boolean Checks if the item is locked by some task
wasDiscoveredOnce boolean Checks if the inventory item was discovered once
wasEdited boolean Check if the inventory item was edited
progress int The progress of the currently running operation (percentage)
targetVid string
First platform-specific item in the inventory under the discovery item. Hyper-V/VMware/Nutanix: host/cluster. AWS/physical server: none
hostCount int The number of hosts inside the inventory item
vmCount int The number of VMs inside the inventory item
alertErrorCode long The error code of the alert (if any)
alertTitle string The title of the alert (if any)
alertDescription string The description of the alert (if any)