Get all Hypervisor

Get the details of all Hypervisor

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

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.

  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, PROXMOX]

  status RetireClientPhase

  Possible values: [UNKNOWN, RETIRE_IN_PROGRESS, DECONFIGURED]

  version string

  VMware Vcenter Version

  instance 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

{
  "HypervisorCount": 0,
  "Hypervisors": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "hostName": "string",
      "HypervisorType": "NONE",
      "status": "UNKNOWN",
      "version": "string",
      "instance": {
        "id": 0,
        "name": "string"
      },
      "clientActivityControl": {
        "activityType": "BACKUP",
        "enableAfterADelay": true,
        "enableActivityType": true,
        "delayTime": {
          "timeZone": {
            "id": 0,
            "name": "string"
          },
          "time": 0,
          "value": "string"
        }
      },
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "commcell": {
        "name": "string"
      },
      "manageSnapshot": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

Requested Details not found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

GET /v4/hypervisor    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

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

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

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

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

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

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

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