Browse the Inventory of your hypervisor by hypervisor ID

Browse the Inventory of your hypervisor

Path Parameters

• hypervisorId string required

  Hypervisor client ID to browse

• InventoryEntityName string required

  Name of the inventory entity that needs to be browsed like ESX Host name in VCenter

Query Parameters

• InventoryType string

  Possible values: [NONE, SERVER, RES_POOL, VAPP, DATACENTER, FOLDER, CLUSTER, DATASTORE, DATASTORE_CLUSTER, VM, VM_NAME, VM_GUEST_OS, VM_GUEST_HOST_NAME, CLUSTER_SHARED_VOLUMES, LOCAL_DISK, CLUSTER_DISK, UNPROTECTED_VMS, ROOT, FILE_SERVER, SMB_SHARE, TYPES_FOLDER, VM_FOLDER, SERVER_FOLDER, TEMPLATE_FOLDER, STORAGE_REPOSITORY_FOLDER, VAPPFOLDER, DATACENTER_FOLDER, CLUSTER_FOLDER, VM_POWER_STATE, VM_NOTES, VM_CUSTOM_ATTRIBUTE, NETWORK, USER, VM_TEMPLATE, TAG, TAG_CATEGORY, SUBCLIENT, CLIENT_GROUP, PROTECTION_DOMAIN, CONSISTENCY_GROUP, INSTANCE_SIZE, ORGANIZATION, IMAGES, STORAGE_POLICY, DATABASE, TABLE, PROJECT, SELECTOR, MANAGED_BY, REPLICATION_MODE, METADATATAG, CATALOG, VAPPTEMPLATE, VOLUME]

  Type of resource to browse in inventory

Responses

• 200
• 404
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

oneOf

• NetworkInventoryResponseList
• DatastoreInventoryResponseList
• ResourcePoolInventoryResponseList

---

hostInfo object[]

dataCenterName string

dataCenter Name of the Network.

dnsHostName string

dns Hostname of the Network.

esxServerName string

esx server name of the Network.

networkSettings object[]

id int32

name string

hostInfo object[]

dataCenterName string

dataCenter Name of the datastore.

dnsHostName string

dns Hostname of the datastore.

esxServerName string

esx server name of the datastore.

dataStore object[]

dataStoreName string

name of the datastore.

dataStoreLocation string

location of the datastore.

dataStoreType string

type of the datastore.

hostInfo object[]

dataCenterName string

dataCenter Name of the ResourcePool.

dnsHostName string

dns Hostname of the ResourcePool.

esxServerName string

esx server name of the ResourcePool.

resources object[]

resourcePoolPath string

path of the resource pool.

name string

name of the resource pool.

type string

type of the resource pool.

{
  "hostInfo": [
    {
      "dataCenterName": "string",
      "dnsHostName": "string",
      "esxServerName": "string",
      "networkSettings": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Requested Details not found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

GET /v4/hypervisor/:hypervisorid/:inventoryentityname/browse    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

hypervisorId — path required

InventoryEntityName — path required

InventoryType — query

---NONESERVERRES_POOLVAPPDATACENTERFOLDERCLUSTERDATASTOREDATASTORE_CLUSTERVMVM_NAMEVM_GUEST_OSVM_GUEST_HOST_NAMECLUSTER_SHARED_VOLUMESLOCAL_DISKCLUSTER_DISKUNPROTECTED_VMSROOTFILE_SERVERSMB_SHARETYPES_FOLDERVM_FOLDERSERVER_FOLDERTEMPLATE_FOLDERSTORAGE_REPOSITORY_FOLDERVAPPFOLDERDATACENTER_FOLDERCLUSTER_FOLDERVM_POWER_STATEVM_NOTESVM_CUSTOM_ATTRIBUTENETWORKUSERVM_TEMPLATETAGTAG_CATEGORYSUBCLIENTCLIENT_GROUPPROTECTION_DOMAINCONSISTENCY_GROUPINSTANCE_SIZEORGANIZATIONIMAGESSTORAGE_POLICYDATABASETABLEPROJECTSELECTORMANAGED_BYREPLICATION_MODEMETADATATAGCATALOGVAPPTEMPLATEVOLUME

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId/:InventoryEntityName/Browse' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'