Skip to main content

Get all Hypervisor​

Select

SaaS
Customer Managed

Get the details of all Hypervisor

Query Parameters
  • start integer

    This value determines the starting point for fetching Hypervisors. For example, if set to 5, the first 5 Hypervisors will be skipped, and fetching will begin from the 6th Hypervisor onward.

  • limit integer

    Default value: 20

    Specifies the number of Hypervisors to fetch. If set to 0, all hypervisors will be fetched starting from the specified start value.

Responses

Success

Schema
  • HypervisorCount int32
  • Hypervisors object[]
  • id int32

    This gives the id of the Hypervisor.

  • name string

    This give the name of the Hypervisor.

  • displayName string

    This gives the name of the Hypervisor as it shown on the admin console or GUI.

  • hostName string

    This give the host name of the Hypervisor.

  • regionName string
  • cloudVendor RegionType

    Possible values: [DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

    Type of region

  • HypervisorType 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]

  • status RetireClientPhase

    Possible values: [UNKNOWN, RETIRE_IN_PROGRESS, DECONFIGURED]

  • version string

    VMware Vcenter Version

  • instance object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • clientActivityControl object[]
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • tags object[]

    Array of all the tags associated with hypervisor.

  • id int32
  • name string
  • value string
  • commcell object
  • name string

    Name of the commcell the entity belongs to.

  • manageSnapshot object
  • id int32
  • name string
  • isManagedIdentity boolean

    True if hypervisor is configured using Azure Managed Service Identity.

  • useHostedInfrastructure boolean

    Default value: false

    Use Metallic hosted infrastructure

  • enableCloudConfigProtection boolean

    Default value: false

    True if cloud config protection is enabled

  • description string

    This give the description of the Hypervisor

GET /v4/hypervisor

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
start — query
limit — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Hypervisor' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'