Skip to main content

Browse Virtual Server Entities​

Browse Virtual Server Entities with entityName as query parameter. Used to discover and list various virtual infrastructure components like datastores, networks, hosts, etc.

Path Parameters
  • hypervisorId int32 required

    Client Id of the Hypervisor (pseudoClientId)

Query Parameters
  • entityName string required

    Name of the entity to browse. For special characters, use entityNameParam instead.

  • entityNameParam string

    Alternative parameter for entityName. Takes precedence over entityName if provided.

  • requestType string

    Possible values: [MOUNTSNAP,, INVENTORY,, DATASTORES_ON_HOST,, RESOURCE_POOLS_ON_HOST,, FILES_ON_DATASTORE,, NETWORKS_ON_HOST,, VM_INVENTORY_FROM_HOST,, AVAILABLE_VM_SIZE,, IMAGES,, NETWORK_SECURITY_GROUPS_ON_HOST,, KEYPAIRS_ON_HOST,, ROLES_ON_HOST,, AVAILABILITY_DOMAIN,, SUPPORTED_GUEST_OS,, STAGING_STORAGE_ON_HOST,, TEMPLATE_VM_ON_HOST,, VOLUME_TYPES_ON_HOST,, VOLUME_ENCRYPTION_KEYS_ON_HOST,, STORAGE_POLICIES_ON_HOST,, DATASTORES_ON_HOST_AND_STORAGE_POLICY,, DISK_ENCRYPTION_TYPES,, PUBLIC_IP_ADDRESSES,, PRIVATE_IP_ADDRESSES,, SOLE_TENANCY_NODE_GROUP,, SOLE_TENANCY_NODE,, AVAILABLE_HOSTS,, PROXIMITY_PLACEMENT_GROUPS,, KEY_VAULTS,, APPLICATION_SECURITY_GROUPS,, AVAILABILITY_SETS,, PUBLIC_IP_PREFIXES,, USER_ASSIGNED_IDENTITIES,, NETWORK_CARDS,, HOSTS_IN_CLUSTER,, CLUSTERS_IN_DATACENTER,, VM_LICENSES,, VCLOUD_VDC_IN_ORG,, VCLOUD_VAPP_IN_VDC,, VCLOUD_NETWORK_IN_VAPP,, VCLOUD_USER_IN_ORG,, MANAGED_HYPERVISORS,, VCLOUD_STORAGE_PROFILES_IN_VDC,, VCLOUD_CATALOG_IN_ORG,, VCLOUD_ORG_LIST]

    Default value: DATASTORES_ON_HOST

    Type of browse request

  • proxyId int32

    Proxy client ID. Default is 0. Necessary only when pseudoClientId is not provided.

  • vendor string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION]

    Vendor type. Necessary only when server is provided.

  • includeVMs boolean

    Flag to include virtual machines in the response

  • browseLocalHost boolean

    Flag to browse localhost

  • server string

    Custom server to browse. If specified, vendor must be set.

  • filter string

    Filter criteria for browse results

  • browseHost string

    Specific host to browse

  • projectId string

    Google Cloud project ID (required for GOOGLE_CLOUD vendor for certain request types)

  • region string

    Region for cloud providers (used with Google Cloud)

  • nodeGroup string

    Node group for sole tenancy (Google Cloud)

  • machineType string

    Machine type for filtering (Google Cloud)

  • architecture string

    Architecture filter for VM size browsing

  • bootMode string

    Boot mode filter for VM size browsing

Responses

Success

Schema
  • hostInfo object[]
  • esxServerName string

    ESX server name

  • dnsHostName string

    DNS hostname of the ESX server

  • dataCenterName string

    Name of the datacenter

  • vmFolderPath string

    Path to the VM folder

  • dataStore object[]
  • dataStoreName string

    Data Store Name

  • totalSizeInBytes int64

    Total size of the datastore in bytes

  • freeSpaceInBytes int64

    Free space available in the datastore in bytes

  • dataStoreType string

    Type of the datastore

  • filepath string[]

    List of file paths associated with the datastore

  • dataStoreLocation string

    Location of the datastore

  • dataStoreId string

    Unique identifier of the datastore

  • isCompatibleWithStorageProfile boolean

    Indicates whether the datastore is compatible with the specified VM Storage Policy

  • inventoryInfo object[]
  • name string

    Name of the virtual machine

  • type 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, VM_BADGE, REGION]

    Type of the entity

  • strGUID string

    Unique identifier for the virtual machine

  • strGuestOS string

    Guest operating system of the virtual machine

  • templateVM boolean

    Indicates whether the virtual machine is a template

  • isSharedTemplate boolean

    Indicates whether the virtual machine is a shared template

  • poweredOff boolean

    Indicates whether the virtual machine is powered off

  • toolsStatus string

    Status of VMware tools on the virtual machine

  • maintenanceMode boolean

    Indicates whether the vm is in maintenance mode

  • isDefault boolean

    Indicates whether the virtual machine is a default VM

  • inventoryInfo object[]
  • name string

    Name of the virtual machine

  • type 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, VM_BADGE, REGION]

    Type of the entity

  • strGUID string

    Unique identifier for the virtual machine

  • strGuestOS string

    Guest operating system of the virtual machine

  • templateVM boolean

    Indicates whether the virtual machine is a template

  • isSharedTemplate boolean

    Indicates whether the virtual machine is a shared template

  • poweredOff boolean

    Indicates whether the virtual machine is powered off

  • toolsStatus string

    Status of VMware tools on the virtual machine

  • maintenanceMode boolean

    Indicates whether the vm is in maintenance mode

  • isDefault boolean

    Indicates whether the virtual machine is a default VM

  • path string

    Path of the virtual machine in the inventory

  • isDisconnected boolean

    Indicates whether the virtual machine is disconnected

  • hostnames string[]

    List of hostnames associated with the virtual machine

  • strRegion string

    Region of the virtual machine

  • isNotAuthorized boolean

    Indicates whether the virtual machine is not authorized

  • path string

    Path of the virtual machine in the inventory

  • isDisconnected boolean

    Indicates whether the virtual machine is disconnected

  • hostnames string[]

    List of hostnames associated with the virtual machine

  • strRegion string

    Region of the virtual machine

  • isNotAuthorized boolean

    Indicates whether the virtual machine is not authorized

Loading...