Skip to main content

Update Hypervisor Credentials

Select

SaaS
Customer Managed

Update Hypervisor's credentials information

Path Parameters
  • HypervisorId string required
Request Body

  • 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

    Guest credential for content VMs

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

    if credential validation has to be skipped.

  • hypervisorType string required

    Possible values: [GOOGLE_CLOUD]

  • serviceAccountId string

    service account id of google cloud

  • userName string

    username of GCP login Application

  • password string

    Base64 encrypted Service Account ID

Responses

OK


Schema
  • hypervisorId int32
  • warningCode int32
  • errorCode int32
  • errorMessage string

    Response message

  • warningMessage string

    Response message

PUT /v4/hypervisor/:hypervisorid/credentials    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
HypervisorId — path required
Body

{
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"fbrUnixMediaAgent": {
"id": 0,
"name": "string"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "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": {
"name": "string",
"password": "string"
},
"applicationCredentials": {
"name": "string",
"password": "string"
},
"mountAccessNode": {
"id": 0,
"name": "string"
}
},
"credentials": {
"id": 0,
"name": "string"
},
"skipCredentialValidation": false,
"hypervisorType": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/Hypervisor/:HypervisorId/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"fbrUnixMediaAgent": {
"id": 0,
"name": "string"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "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": {
"name": "string",
"password": "string"
},
"applicationCredentials": {
"name": "string",
"password": "string"
},
"mountAccessNode": {
"id": 0,
"name": "string"
}
},
"credentials": {
"id": 0,
"name": "string"
},
"skipCredentialValidation": false,
"hypervisorType": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'