Update Hypervisor Credentials
Update Hypervisor's credentials information
Path Parameters
- HypervisorId string required
- application/json
Request Body
- GoogleCloud
- VMWare
- VCloud
- Amazon
- Azure
- AzureStack
- HyperV
- Rhev
- OpenStack
- OracleCloud
- AliCLoud
- OracleVM
- Nutanix
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- serviceAccountId string
service account id of google cloud
- userName string
username of GCP login Application
- password string
Base64 encrypted Service Account ID
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- vcenterHostName string
Vcenter hostname
- userName string
Vcenter username
- password string
Vcenter password
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- vOrganizationName string
Organization name of VCloud Director
- vOrganizationGuid string
Organization Guid of VCloud Director
- hostName string
VCloud Director Name
- vcenterHostName string
Vcenter hostname
- vcenterUserName string
Vcenter username
- vcenterPassword string
Vcenter password
- createOrgAccount boolean
Default value:
falseTrue if organization account to be used
- userName string
vCloud username
- password string
VCloud base 64 encoded password
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- accessKey string
Access Key of Amazon login
- RoleARN string
Role ARN for STS assume role with IAM policy
- secretKey string
secret Key of Amazon login
- Region string
AWS region if Iam role is used
- useIamRole boolean
if Iam Role is used
- useServiceAccount string
Clientname to be used as Admin Account
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- 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
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- tenantId string
Tenant id of Azure Stack login Application
- serverName string
Client Name to Update
- subscriptionId string
subscription id of Azure Stack
- ApplicationId string
Application id of Azure login Application
- ApplicationPassword string
Application Password of Azure login Application
- resourceManagerURL string
Resource manager URL for Azure Stack client
- useManagedIdentity boolean
Use managed identities for Azure stack authentication
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- serverName string
Hyper-V hostname
- userName string
Hyper-V userName
- password string
Hyper-V password
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- RhevMManager string
Rhev Manager
- userName string
Rhev userName
- password string
Rhev password
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- keynoteAddress string
OpenStack KeyNote address
- userName string
OpenStack userName
- password string
OpenStack password
- openstackDomain string
OpenStack Domain Name
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- tenancyOCId string
OCID for the tenant.
- userOCId string
OCID for the admin user for the hypervisor
- fingerPrint string
Finger print for the private key
- privateKeyFileName string
File Name for the private key
- privateKeyPassword string
password for the private key.This is the passphrase that was used to encrypt the private key.
- regionName string
home region for the tenant
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- accessKey string
Access key of alibaba cloud
- secretKey string
secret key of alibaba cloud
- hostURL string
host URL of alibaba cloud
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- oracleVMManager string
oracle VM Manager
- userName string
Username of the oracle VM info
- password string
password of the oracle VM info
accessNode object[]
fbrUnixMediaAgent object
activityControl object
security object
- newName string
The name of the hypervisor that has to be changed
settings object
- skipCredentialValidation boolean
Default value:
trueif credential validation has to be skipped.
- hostName string
Nutanix hostname
- userName string
Nutanix userName
- password string
Nutanix password
Responses
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- hypervisorId int32
- warningCode int32
- errorCode int32
- errorMessage string
Response message
- warningMessage string
Response message
{
"hypervisorId": 0,
"warningCode": 0,
"errorCode": 0,
"errorMessage": "string",
"warningMessage": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
PUT /v4/hypervisor/:hypervisorid/credentials
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/Hypervisor/:HypervisorId/Credentials' \
-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": "GOOGLE_CLOUD",
"serviceAccountId": "string",
"userName": "string",
"password": "string"
}'