Get Hypervisor Details
Select
Get the details of HYpervisor
Path Parameters
- hypervisorId int32 required
Id of the HYpervisor to get
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- id int32
- name string
Hypervisor Name
- displayName string
Display Name
instance object
id int32name stringgeneral object
vendor stringPossible 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 int32VMs pending for Backup
vmProtectedCount int32Protected vm Count
vmNotProtectedCount int32VM Missed to protect count
vmNeverBackedUpCount int32vm never Backed up count
vmBackedUpWithErrorCount int32VM Backed up with error count
vmTotalCount int32Total vm Count
version stringHypervisor OS version
accountDetails object
hostName stringHost Name
activityControl 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
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 stringaccessNodeList object
accessNodeMessage stringresourcePoolName stringaccessNode object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
hypervisorCommonProperties object
isIndexingV2 booleanTrue if Indexing version is 2
company object
id int32name stringisDeconfigured booleanTrue if the hypervisor is deconfigured
retirePhase RetireClientPhasePossible values: [
UNKNOWN
,RETIRE_IN_PROGRESS
,DECONFIGURED
]isSnapBackupEnabled booleanTrue if the hypervisor is snap backup enabled
isRegionBasedBackup booleanTrue if region based backup is enabled
manageSnapshot object
id int32name string
{
"id": 0,
"name": "string",
"displayName": "string",
"instance": {
"id": 0,
"name": "string"
},
"general": {
"vendor": "NONE",
"vmBackupInfo": {
"vmPendingCount": 0,
"vmProtectedCount": 0,
"vmNotProtectedCount": 0,
"vmNeverBackedUpCount": 0,
"vmBackedUpWithErrorCount": 0,
"vmTotalCount": 0
},
"version": "string"
},
"accountDetails": {
"hostName": "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"
}
}
},
"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"
}
},
"accessNodeList": {
"accessNodeMessage": "string",
"resourcePoolName": "string",
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
]
},
"hypervisorCommonProperties": {
"isIndexingV2": true,
"company": {
"id": 0,
"name": "string"
},
"isDeconfigured": true,
"retirePhase": "UNKNOWN",
"isSnapBackupEnabled": true,
"isRegionBasedBackup": true
},
"manageSnapshot": {
"id": 0,
"name": "string"
}
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}