Skip to main content

Update the Hypervisor details​

Select

SaaS
Customer Managed

Updates the Hypervisors

Path Parameters
  • hypervisorId int32 required

    Id of the Hypervisor to update

Request Body
    oneOf
  • accessNodes 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
  • 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

  • restoreActivityControlOptions 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

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

    Array of all the customAttributes associated with hypervisor.

  • type int32

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

  • value string

    client/Client Group custom attribute value

  • guestCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • applicationCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • mountAccessNode object
  • id int32
  • name string
  • credentials object
  • id int32
  • name string
  • skipCredentialValidation boolean

    Default value: true

    if credential validation has to be skipped.

  • hypervisorType string required

    Possible values: [Azure_V2]

  • tenantId string

    Tenant id of Azure login Application

  • serverName string

    Client Name to Update

  • subscriptionId string

    subscription id of Azure

  • userName string

    Application id of Azure login Application

  • password string

    Application Password of Azure login Application

  • useManagedIdentity boolean

    Use managed identities for Azure authentication

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, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI]

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

  • restoreActivityControlOptions 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

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

    Array of all the customAttributes associated with hypervisor.

  • type int32

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

  • value string

    client/Client Group custom attribute value

  • guestCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • applicationCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • 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
Loading...