Skip to main content

Update the Hypervisor details​

Updates the Hypervisors

Path Parameters
  • hypervisorId int32 required

    Id of the Hypervisor to update

Request Body
  • accessNode object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • fbrUnixMediaAgent object
  • id int32
  • name string
  • activityControl object
  • enableBackup boolean

    true if Backup is enabled

  • enableRestore boolean

    true if Restore is enabled

  • backupActivityControlOptions object
  • enableAfterDelay boolean

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

  • delayTime string

    Delayed by n Hrs

  • timeZone object
  • id int32
  • name string
  • restoreActivityControlOptions object
  • enableAfterDelay boolean

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

  • delayTime string

    Delayed by n Hrs

  • timeZone object
  • id int32
  • name string
  • security object
  • clientOwners string

    Client owners for the Hypervisor

  • associatedUserGroups object[]
  • id int32
  • name string
  • newName string

    The name of the hypervisor that has to be changed

  • settings object
  • regionInfo object
  • id int32

    Region Id

  • name string

    Region Name

  • displayName string

    Display Name of Region

  • latitude string

    Geolocation Latitude

  • longitude string

    Geolocation Longitude

  • timeZone object
  • id int32
  • name string
  • metricsMonitoringPolicy object
  • id int32

    Metrics Moitoring PolicyId

  • name string

    Metrics Moitoring Policy Name

  • isEnabled boolean

    True if Metrics Monioring policy is enabled

  • customAttributes object
  • type int32

    client custom attribute type . Ex- 3 - For client 8- For clientGroup

  • value string

    client/Client Group custom attribute value

  • guestCredentials object
  • id int32
  • name string
  • applicationCredentials object
  • id int32
  • name string
  • mountAccessNode object
  • id int32
  • name string
  • skipCredentialValidation boolean

    Default value: true

    if credential validation has to be skipped.

  • vcenterHostName string

    Vcenter hostname

  • userName string

    Vcenter username

  • password string

    Vcenter password

Responses

Success

Schema
  • id int32
  • name string

    Hypervisor Name

  • displayName string

    Display Name

  • instance object
  • id int32
  • name string
  • general object
  • 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, PROXMOX]

  • vmBackupInfo object
  • vmPendingCount int32

    VMs pending for Backup

  • vmProtectedCount int32

    Protected vm Count

  • vmNotProtectedCount int32

    VM Missed to protect count

  • vmNeverBackedUpCount int32

    vm never Backed up count

  • vmBackedUpWithErrorCount int32

    VM Backed up with error count

  • vmTotalCount int32

    Total vm Count

  • version string

    Hypervisor OS version

  • accountDetails object
  • hostName string

    Host Name

  • activityControl object
  • enableBackup boolean

    true if Backup is enabled

  • enableRestore boolean

    true if Restore is enabled

  • backupActivityControlOptions object
  • enableAfterDelay boolean

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

  • delayTime string

    Delayed by n Hrs

  • timeZone object
  • id int32
  • name string
  • restoreActivityControlOptions object
  • enableAfterDelay boolean

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

  • delayTime string

    Delayed by n Hrs

  • timeZone object
  • id int32
  • name string
  • settings object
  • regionInfo object
  • id int32

    Region Id

  • name string

    Region Name

  • displayName string

    Display Name of Region

  • latitude string

    Geolocation Latitude

  • longitude string

    Geolocation Longitude

  • timeZone object
  • id int32
  • name string
  • metricsMonitoringPolicy object
  • id int32

    Metrics Moitoring PolicyId

  • name string

    Metrics Moitoring Policy Name

  • isEnabled boolean

    True if Metrics Monioring policy is enabled

  • customAttributes object
  • type int32

    client custom attribute type . Ex- 3 - For client 8- For clientGroup

  • value string

    client/Client Group custom attribute value

  • guestCredentials object
  • id int32
  • name string
  • applicationCredentials object
  • id int32
  • name string
  • mountAccessNode object
  • id int32
  • name string
  • accessNodeList object
  • accessNodeMessage string
  • resourcePoolName string
  • accessNode object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • hypervisorCommonProperties object
  • isIndexingV2 boolean

    True if Indexing version is 2

  • company object
  • id int32
  • name string
  • isDeconfigured boolean

    True if the hypervisor is deconfigured

  • retirePhase RetireClientPhase

    Possible values: [UNKNOWN, RETIRE_IN_PROGRESS, DECONFIGURED]

  • isSnapBackupEnabled boolean

    True if the hypervisor is snap backup enabled

  • isRegionBasedBackup boolean

    True if region based backup is enabled

  • manageSnapshot object
  • id int32
  • name string
PUT /v4/hypervisor/:hypervisorid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
hypervisorId — path required
Body
{

  "accessNode": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "type": 0

    }

  ],

  "fbrUnixMediaAgent": {

    "id": 0,

    "name": "string"

  },

  "activityControl": {

    "enableBackup": true,

    "enableRestore": true,

    "backupActivityControlOptions": {

      "enableAfterDelay": true,

      "delayTime": "string",

      "timeZone": {

        "id": 0,

        "name": "string"

      }

    },

    "restoreActivityControlOptions": {

      "enableAfterDelay": true,

      "delayTime": "string",

      "timeZone": {

        "id": 0,

        "name": "string"

      }

    }

  },

  "security": {

    "clientOwners": "string",

    "associatedUserGroups": [

      {

        "id": 0,

        "name": "string"

      }

    ]

  },

  "newName": "string",

  "settings": {

    "regionInfo": {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "latitude": "string",

      "longitude": "string"

    },

    "timeZone": {

      "id": 0,

      "name": "string"

    },

    "metricsMonitoringPolicy": {

      "id": 0,

      "name": "string",

      "isEnabled": true

    },

    "customAttributes": {

      "type": 0,

      "value": "string"

    },

    "guestCredentials": {

      "id": 0,

      "name": "string"

    },

    "applicationCredentials": {

      "id": 0,

      "name": "string"

    },

    "mountAccessNode": {

      "id": 0,

      "name": "string"

    }

  },

  "skipCredentialValidation": true,

  "hypervisorType": "VMW",

  "vcenterHostName": "string",

  "userName": "string",

  "password": "string"

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:hypervisorId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "accessNode": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "type": 0
    }
  ],
  "fbrUnixMediaAgent": {
    "id": 0,
    "name": "string"
  },
  "activityControl": {
    "enableBackup": true,
    "enableRestore": true,
    "backupActivityControlOptions": {
      "enableAfterDelay": true,
      "delayTime": "string",
      "timeZone": {
        "id": 0,
        "name": "string"
      }
    },
    "restoreActivityControlOptions": {
      "enableAfterDelay": true,
      "delayTime": "string",
      "timeZone": {
        "id": 0,
        "name": "string"
      }
    }
  },
  "security": {
    "clientOwners": "string",
    "associatedUserGroups": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  },
  "newName": "string",
  "settings": {
    "regionInfo": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "latitude": "string",
      "longitude": "string"
    },
    "timeZone": {
      "id": 0,
      "name": "string"
    },
    "metricsMonitoringPolicy": {
      "id": 0,
      "name": "string",
      "isEnabled": true
    },
    "customAttributes": {
      "type": 0,
      "value": "string"
    },
    "guestCredentials": {
      "id": 0,
      "name": "string"
    },
    "applicationCredentials": {
      "id": 0,
      "name": "string"
    },
    "mountAccessNode": {
      "id": 0,
      "name": "string"
    }
  },
  "skipCredentialValidation": true,
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'