Update Hypervisor Credentials
Select
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
- AzureStackHCI
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name 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
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
VMW
] - vcenterHostName string
Vcenter hostname
- userName string
Vcenter username
- password string
Vcenter password
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
VCLOUD
] - 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:
false
True if organization account to be used
- userName string
vCloud username
- password string
VCloud base 64 encoded password
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
Amazon
] - 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
- useHostedInfrastructure boolean
Use Metallic hosted infrastructure
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
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
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
AZURE_STACK
] - 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
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
Hyper-V
] - serverName string
Hyper-V hostname
- userName string
Hyper-V userName
- password string
Hyper-V password
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
REDHAT
] - RhevMManager string
Rhev Manager
- userName string
Rhev userName
- password string
Rhev password
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
OPENSTACK
] - keynoteAddress string
OpenStack KeyNote address
- userName string
OpenStack userName
- password string
OpenStack password
- openstackDomain string
OpenStack Domain Name
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
ORACLE_CLOUD_INFRASTRUCTURE
] - 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
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
ALIBABA_CLOUD
] - accessKey string
Access key of alibaba cloud
- secretKey string
secret key of alibaba cloud
- hostURL string
host URL of alibaba cloud
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
ORACLE_VM
] - oracleVMManager string
oracle VM Manager
- userName string
Username of the oracle VM info
- password string
password of the oracle VM info
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
NUTANIX
] - hostName string
Nutanix hostname
- userName string
Nutanix userName
- password string
Nutanix password
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
fbrUnixMediaAgent object
id int32name stringactivityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
security object
clientOwners stringClient owners for the Hypervisor
associatedUserGroups object[]
id int32name string- newName string
The name of the hypervisor that has to be changed
settings object
regionInfo object
id int32Region Id
name stringRegion Name
displayName stringDisplay Name of Region
latitude stringGeolocation Latitude
longitude stringGeolocation Longitude
timeZone object
id int32name stringmetricsMonitoringPolicy object
id int32Metrics Moitoring PolicyId
name stringMetrics Moitoring Policy Name
isEnabled booleanTrue if Metrics Monioring policy is enabled
customAttributes object[]
Array of all the customAttributes associated with hypervisor.
type int32client custom attribute type . Ex- 3 - For client 8- For clientGroup
value stringclient/Client Group custom attribute value
guestCredentials object
name stringusername to access the network path
password stringpassword to access the network path
applicationCredentials object
name stringusername to access the network path
password stringpassword to access the network path
mountAccessNode object
id int32name stringcredentials object
id int32name string- skipCredentialValidation boolean
Default value:
false
if credential validation has to be skipped.
- hypervisorType string required
Possible values: [
AZURE_STACK_HCI
] - clusterName string
Azure Stack HCI cluster name
- userName string
Azure Stack HCI userName
- password string
Azure Stack HCI password
- 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
}