Page tree

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

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

VmwareDiscovery for VMware

HypervDiscovery for Hyper-V

AwsDiscovery for AWS
NutanixDiscovery for Nutanix AHV
PhysicalDiscovery for physical server

methodstring
getDiscoveryItems
dataarraynull
typestringrpc
tidinteger1

Response Sample

 {
  "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
messagestringMessage if the request failed
wherestringReference to the method where a problem occurred
causestringCause of failure
dataJsonInformation about the inventory item

Data

Field
Value
Description
hoststringThe IP-address or hostname of the inventory item
usernamestringUsername to log into the inventory item
portintTCP port opened on a host for the communication with the product
vidstringVID of the inventory item
namestringDisplay 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
statestringState of the inventory item: OK, warning, inaccessible, error
statusstringThe status of the current operation on inventory item: updating or none
changeStatusstringThe change status of the inventory item. Possible values: NONE, CREATE_PENDING, CHANGE_PENDING
preventModificationbooleanChecks if the item is locked for the manual editing
lockedbooleanChecks if the item is locked by some task
wasDiscoveredOncebooleanChecks if the inventory item was discovered once
wasEditedbooleanCheck if the inventory item was edited
progressintThe progress of the currently running operation (percentage)
targetVidstring
First platform-specific item in the inventory under the discovery item. Hyper-V/VMware/Nutanix: host/cluster. AWS/physical server: none
hostCountintThe number of hosts inside the inventory item
vmCountintThe number of VMs inside the inventory item
alertErrorCodelongThe error code of the alert (if any)
alertTitle
stringThe title of the alert (if any)
alertDescriptionstringThe description of the alert (if any)


  • No labels