Get all VM Groups (Deprecated)

Select

SaaS

Customer Managed

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation returns all the virtual machine (VM) groups that are available in a virtual client.

More Details

Query Parameters

clientName string required

Header Parameters

PagingInfo string

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

vmGroupInfo object[]
lastBackupTime integer
vmBackupInfo object
vmPendingCount integer
vmProtectedCount integer
vmNotProtectedCount integer
vmNeverBackedUpCount integer
vmBackedUpWithErrorCount integer
vmTotalCount integer
vmGroupEntity object
clientName string
instanceName string
displayName string
backupsetId integer
_type_ integer
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
subclientName string
planEntity object

{
  "vmGroupInfo": [
    {
      "lastBackupTime": 0,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 0,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 0
      },
      "vmGroupEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      },
      "planEntity": {}
    }
  ]
}

{
  "vmGroupInfo": [
    {
      "lastBackupTime": 1539802766,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 0,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 0
      },
      "vmGroupEntity": {
        "clientName": "hv-2019-1",
        "instanceName": "Hyper-V",
        "displayName": "hv-2019-1_DN",
        "backupsetId": 29,
        "_type_": 7,
        "commCellName": "bhavnacs",
        "instanceId": 7,
        "csGUID": "F7151C50-88BE-4B70-B79D-CF334777553C",
        "subclientGUID": "51647646-99C5-4E09-93BB-1026625B6ACA",
        "subclientId": 33,
        "clientId": 28,
        "appName": "Virtual Server",
        "backupsetName": "defaultBackupSet",
        "applicationId": 106,
        "subclientName": "default"
      },
      "planEntity": {}
    },
    {
      "lastBackupTime": 1544380040,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 0,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 0
      },
      "vmGroupEntity": {
        "clientName": "hv-2019-1",
        "instanceName": "Hyper-V",
        "displayName": "hv-2019-1_DN",
        "backupsetId": 29,
        "_type_": 7,
        "commCellName": "bhavnacs",
        "instanceId": 7,
        "csGUID": "F7151C50-88BE-4B70-B79D-CF334777553C",
        "subclientGUID": "53731923-D817-4D70-83F4-C8F8E7031EE1",
        "subclientId": 35,
        "clientId": 28,
        "appName": "Virtual Server",
        "backupsetName": "defaultBackupSet",
        "applicationId": 106,
        "subclientName": "SNapNetapp"
      },
      "planEntity": {}
    },
    {
      "lastBackupTime": 1541616226,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 0,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 0
      },
      "vmGroupEntity": {
        "clientName": "hv-2019-1",
        "instanceName": "Hyper-V",
        "displayName": "hv-2019-1_DN",
        "backupsetId": 29,
        "_type_": 7,
        "commCellName": "bhavnacs",
        "instanceId": 7,
        "csGUID": "F7151C50-88BE-4B70-B79D-CF334777553C",
        "subclientGUID": "97B8F6CB-3140-4EAC-B9C6-EDB2B407E609",
        "subclientId": 89,
        "clientId": 28,
        "appName": "Virtual Server",
        "backupsetName": "defaultBackupSet",
        "applicationId": 106,
        "subclientName": "Windows Snap"
      },
      "planEntity": {}
    }
  ]
}

GET /v2/vsa/vmgroups

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

clientName — query required

PagingInfo — header

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vmgroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get all VM Groups (Deprecated)​

Authorization

Request

Get all VM Groups (Deprecated)