This operation returns all the virtual machine (VM) groups that are available in a virtual client.
Request
Syntax
GET <webservice>/v2/vsa/vmgroups?clientName={clientName} HTTP/1.1
Host: <host name>
Accept: application/json
Content-type: application/jsonwhere <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description |
|---|---|
clientName | The client name for the client. If the client name is not known, use the GET Client API to retrieve it. |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid value is application/json. |
Content-type | The media type contained in the request body. Valid values is application/json. |
Response
Response Parameters
Parameter | Description |
|---|---|
vmGroupInfo | The information of the VM group. |
vmGroupId | The unique ID of the VM group. |
vmGroupName | The name of the VM group. |
planName | The name of the plan. |
lastBackupTime | Time of the last backup. |
vmBackupInfo | The backup information of the VM that is added as content. |
vmPendingCount | The number of VMs that are pending for backup in the VM group. |
vmProtectedCount | The number of protected VMs in the VM group |
vmNotProtectedCount | The number of unprotected VMs in the VM group. |
vmNeverBackedUpCount | The number of VMs that are never backed up in the VM group |
vmBackedUpWithErrorCount | The number of VMs that are backed up with errors in the VM group. |
vmTotalCount | The total number of VMs in the VM group. |
Examples
Sample Request
GET <webservice>/v2/vsa/vmgroups?clientName=VMWareClient HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Content-type: application/jsonSample Response
{
"vmGroupInfo": [
{
"vmGroupId": 521,
"clientName": "VMWareClient",
"vmGroupName": "default",
"planName": "",
"lastBackupTime": 0,
"vmBackupInfo": {
"vmPendingCount": 0,
"vmProtectedCount": 0,
"vmNotProtectedCount": 0,
"vmNeverBackedUpCount": 0,
"vmBackedUpWithErrorCount": 0,
"vmTotalCount": 0
}
},
{
"vmGroupId": 541,
"clientName": "VMWareClient",
"vmGroupName": "Update69707",
"planName": "Sync Plan",
"lastBackupTime": 0,
"vmBackupInfo": {
"vmPendingCount": 0,
"vmProtectedCount": 0,
"vmNotProtectedCount": 0,
"vmNeverBackedUpCount": 0,
"vmBackedUpWithErrorCount": 0,
"vmTotalCount": 0
}
},
{
"vmGroupId": 552,
"clientName": "VMWareClient",
"vmGroupName": "VMware Group",
"planName": "",
"lastBackupTime": 1542385842,
"vmBackupInfo": {
"vmPendingCount": 0,
"vmProtectedCount": 2,
"vmNotProtectedCount": 0,
"vmNeverBackedUpCount": 0,
"vmBackedUpWithErrorCount": 1,
"vmTotalCount": 3
},
"vmSLAInfo": {
"vmExcludedCount": 0,
"vmMetSLACount": 3,
"vmMissedSLACount": 0
}
},
{
"vmGroupId": 587,
"clientName": "VMWareClient",
"vmGroupName": "VMware Group new",
"planName": "",
"lastBackupTime": 1539748166,
"vmBackupInfo": {
"vmPendingCount": 0,
"vmProtectedCount": 1,
"vmNotProtectedCount": 0,
"vmNeverBackedUpCount": 0,
"vmBackedUpWithErrorCount": 0,
"vmTotalCount": 1
},
"vmSLAInfo": {
"vmExcludedCount": 0,
"vmMetSLACount": 0,
"vmMissedSLACount": 1
}
}
]
}