Get VM Groups
Select
Get the details of all vmGroup
Query Parameters
- hypervisorId int32
Id of the hypervisor to list vm groups
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
vmGroups object[]
id int32name stringstatus stringPossible values: [
ALL
,PROTECTED
,NOT_PROTECTED
,PENDING
,BACKED_UP_WITH_ERROR
,DISCOVERED
]HypervisorType 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
]vmGroup object
id int32name stringhypervisor object
id int32name stringdisplayName stringinstance object
id int32name stringplan object
id int32name stringsubType stringPossible values: [
ANY
,DLO
,SERVER
,LAPTOP
,DATABASE
,SNAP
,FS_SERVER
,VSA_SERVER
,VSA_REPLICATION
,EXCHANGE_USER
,EXCHANGE_JOURNAL
,DATA_CLASSIFICATION
,E_DISCOVERY
,OFFICE_365
,ARCHIVER
,FSIBMIVTL
,DYNAMICS_365
,CDM
,ObjectStore
]lastBackup object
jobId int32Returns the job id of the last backup job performed.
status stringPossible values: [
NEVER_BACKED_UP
,COMPLETED
,FAILED
,COMPLETED_WITH_ERRORS
,KILLED
,SUSPENDED
,INTERRUPTED
,ANY_STATUS
,SKIPPED
,FAILED_TO_START
,SYNCHRONIZED
,NOT_SYNCHRONIZED
,NOT_ATTEMPTED
,STARTED
,COMPLETED_WITH_WARNINGS
,SYSTEM_FAILED
,COMMITTED
]Status of the last backup job performed.
time int64Shows the time when the last back up job was carried out. The time is provided in unix time format.
failureReason stringGives the reason for the last backup job failing, if the last backup job fails.
company object
id int32Id of company
name stringName of company
multiCommcellId int32Multi Commcell Id of company
replicationGroup object
id int32name stringisDefaultVMGroup booleanDefault value:
false
True if subclient is default subclient
storagePolicyRetentionExtension booleanDefault value:
false
True if extend storage policy Retention was set in VMGroup for deleted files
indexingStatus stringPossible values: [
NOT_APPLICABLE
,ENABLED
,SETUP_IN_PROGRESS
]Default value:
NOT_APPLICABLE
Type of indexing status.
SnapBackupEnabled booleanDefault value:
false
true if snap backup enabled
tags object[]
id int32name stringvalue string
{
"vmGroups": [
{
"id": 0,
"name": "string",
"status": "ALL",
"HypervisorType": "NONE",
"vmGroup": {
"id": 0,
"name": "string"
},
"hypervisor": {
"id": 0,
"name": "string",
"displayName": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"plan": {
"id": 0,
"name": "string",
"subType": "ANY"
},
"lastBackup": {
"jobId": 0,
"status": "NEVER_BACKED_UP",
"time": 0,
"failureReason": "string"
},
"company": {
"id": 0,
"name": "string",
"multiCommcellId": 0
},
"replicationGroup": {
"id": 0,
"name": "string"
},
"isDefaultVMGroup": false,
"storagePolicyRetentionExtension": false,
"indexingStatus": "NOT_APPLICABLE",
"SnapBackupEnabled": false,
"tags": [
{
"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}