Get Virtual Machine Details
Get details for virtual machine
Path Parameters
- vmUUID string required
The vmUUID can be obtained from GET /virtualMachines UUID property
Query Parameters
- showInheritedAssociation boolean
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
vmDetails object
displayName stringThe display name of the virtual machine
summary object
The Virtual Machine detail summary. Hypervisor is the software that creates and runs virtual machines(VMs).
hypervisor object
id int32name stringvmGroup object
id int32name stringhost stringThe host name for the computer where the source virtual machine or instance resides.
os stringThe operating system version for the VM or instance.
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
,PROXMOX
]vmSize int32The total space allocated(in bytes) for the virtual machine.
applicationSize int32The amount of data being protected for the VM client(in bytes)
plan object
id int32name stringlatestRecoveryPoint int32The latest recovery time for the vm(in unix)
oldestRecoveryPoint int32The oldest recovery time for the vm(in unix)
status stringPossible values: [
PROTECTED
,NOT_PROTECTED
,PENDING
,BACKED_UP_WITH_ERROR
,DISCOVERED
]The status of the backup for the VM, instance, or container.
SLA object
status stringPossible values: [
MET_SLA
,MISSED_SLA
,EXCLUDED_SLA
,YET_TO_BE_PROTECTED
,MIGHT_MISS_SLA
,UNKNOWN
]Provides the SLA status.
reason stringThe reason for the current SLA status of the VM client
company object
id int32name stringapplicationValidationResults object
bootStatus booleantrue if backup validation is set
lastValidationJobId int32job id of the last backup validation job
backupValidated int32job id of the last backup job that was validated
backupCompletionDate int32timestamp(in unix) for the last backup job completed
appsDiscovered object[]
name stringname of the VM apps discovered for validation
scriptStatus booleantrue if validation status is true
failureReason stringreason for failure of validation of app
passkey object
authType stringPossible values: [
USE_LOGIN
,USE_PASSKEY
]The authentication type set for browse and restore
expirationTime int32The duration(in unix time) for which a user can continue browsing and restoring backup data without being prompted to enter the passkey, again.
passKeyRequiredForRestore booleanTo tell if passkey is required for browse and restore
enableAuthorizeForRestore booleanTo tell if user is authorized for restore
security object
associations object[]
user object
id int32name stringcompany object
id int32name stringuseGroup object
id int32name stringcompany object
id int32name stringrole object
id int32name stringpermissions object[]
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES
,CATEGORY_ENTITY
,PERMISSION_ENTITY
]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
owners object[]
userId int32userName stringuserGroupId int32userGroupName stringactivityControl 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
tags object[]
id int32name stringvalue string
{
"vmDetails": {
"displayName": "string",
"summary": {
"hypervisor": {
"id": 0,
"name": "string"
},
"vmGroup": {
"id": 0,
"name": "string"
},
"host": "string",
"os": "string",
"vendor": "NONE",
"vmSize": 0,
"applicationSize": 0,
"plan": {
"id": 0,
"name": "string"
},
"latestRecoveryPoint": 0,
"oldestRecoveryPoint": 0,
"status": "PROTECTED",
"SLA": {
"status": "MET_SLA",
"reason": "string"
},
"company": {
"id": 0,
"name": "string"
}
},
"applicationValidationResults": {
"bootStatus": true,
"lastValidationJobId": 0,
"backupValidated": 0,
"backupCompletionDate": 0,
"appsDiscovered": [
{
"name": "string",
"scriptStatus": true,
"failureReason": "string"
}
]
},
"passkey": {
"authType": "USE_LOGIN",
"expirationTime": 0,
"passKeyRequiredForRestore": true,
"enableAuthorizeForRestore": true
},
"security": {
"associations": [
{
"user": {
"id": 0,
"name": "string",
"company": {
"id": 0,
"name": "string"
}
},
"useGroup": {
"id": 0,
"name": "string",
"company": {
"id": 0,
"name": "string"
}
},
"role": {
"id": 0,
"name": "string"
}
}
],
"permissions": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
],
"owners": [
{
"userId": 0,
"userName": "string",
"userGroupId": 0,
"userGroupName": "string"
}
]
},
"activityControl": [
{
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
],
"tags": [
{
"id": 0,
"name": "string",
"value": "string"
}
]
}
}
Requested Details not found