API Reference

Page tree

Returns info about 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
curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
		"action": "VmwareDiscovery",
		"method": "getDiscoveryItem",
		"data": [1],
		"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

getDiscoveryItem

dataarray of intInventory item ID inside its platform group
typestringrpc
tidinteger1

Response Sample

 {
  "action": "VmwareDiscovery",
  "method": "getDiscoveryItem",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "host": "vc65.zenlar.int",
    "username": "administrator@vsphere.local",
    "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
data JsonParameters. See below

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

type

string

Type of inventory item

subType

string

Subtype of the inventory item

sizeKb

int

Total disk size of the physical server

confirmToProceed

boolean

true if returning info about the inventory item requires confirmation

accessKey

string

Access key for an Amazon EC2 inventory item

namestringDisplay name of the inventory item
statestringState of the inventory item: OK, WARNING, INACCESSIBLE,  or ERROR
statusstringThe status of the current operation on inventory item: UPDATING or NONE
changeStatusstringThe change status of the inventory item: NONE, CREATE_PENDING, or 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: item VID. Physical server: item ID
hostCountintThe number of hosts inside the inventory item
vmCountintThe number of VMs inside the inventory item
alertErrorCodeintThe error code of the alert (if any)
alertTitle
stringThe title of the alert (if any)
alertDescriptionstringThe description of the alert (if any)

 

  • No labels