Single Item Info

Product version: 10.11

Last modified: 31 July 2024

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

Copy

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)
`action`	string	`VmwareDiscovery` for VMware `HypervDiscovery` for Hyper-V `AwsDiscovery` for AWS `NutanixDiscovery` for Nutanix AHV `PhysicalDiscovery` for physical server
`method`	string	`getDiscoveryItem`
`data`	`array of int`	Inventory item ID inside its platform group
`type`	string	`rpc`
`tid`	integer	`1`

Response Sample

curl

Copy

{
  "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
`message`	string	Message if the request failed
`where`	string	Reference to the method where a problem occurred
`cause`	string	Cause of failure
`data`	Json	Parameters. See below

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
`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
`name`	string	Display name of the inventory item
`state`	string	State of the inventory item: `OK`, `WARNING`, `INACCESSIBLE`, or `ERROR`
`status`	string	The status of the current operation on inventory item: `UPDATING` or `NONE`
`changeStatus`	string	The change status of the inventory item: `NONE`, `CREATE_PENDING`, or `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: item VID. Physical server: item ID
`hostCount`	int	The number of hosts inside the inventory item
`vmCount`	int	The number of VMs inside the inventory item
`alertErrorCode`	int	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)