Get Virtual Group ID Properties (Deprecated)

Select

SaaS

Customer Managed

deprecated

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

This operation returns virtual machine (VM) group properties.

Path Parameters

subclientId string required

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
vmSLAInfo object
vmExcludedCount integer
vmMetSLACount integer
vmMissedSLACount integer
planEntity object
content object
children object[]
equalsOrNotEquals boolean
displayName string
allOrAnyChildren boolean
description string
type integer
path string
name string

{
  "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"
      },
      "vmSLAInfo": {
        "vmExcludedCount": 0,
        "vmMetSLACount": 0,
        "vmMissedSLACount": 0
      },
      "planEntity": {},
      "content": {
        "children": [
          {
            "equalsOrNotEquals": true,
            "displayName": "string",
            "allOrAnyChildren": true,
            "description": "string",
            "type": 0,
            "path": "string",
            "name": "string"
          }
        ]
      }
    }
  ]
}

{
  "vmGroupInfo": [
    {
      "lastBackupTime": 1613672745,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 1,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 1
      },
      "vmGroupEntity": {
        "clientName": "vsaqa",
        "instanceName": "VMware",
        "displayName": "vsaqa",
        "backupsetId": 3870,
        "_type_": 7,
        "commCellName": "dm2perf4",
        "instanceId": 503,
        "csGUID": "31B8C004-387A-4DC9-A156-ED798AFF7647",
        "subclientGUID": "E05F5009-5B52-44C5-BF8E-BFE928EA8277",
        "subclientId": 3895,
        "clientId": 865,
        "appName": "Virtual Server",
        "backupsetName": "defaultBackupSet",
        "applicationId": 106,
        "subclientName": "YashVMs"
      },
      "vmSLAInfo": {
        "vmExcludedCount": 0,
        "vmMetSLACount": 1,
        "vmMissedSLACount": 0
      },
      "planEntity": {},
      "content": {
        "children": [
          {
            "equalsOrNotEquals": true,
            "displayName": "YashCISCS100",
            "allOrAnyChildren": true,
            "description": "",
            "type": 9,
            "path": "YashCISCS100",
            "name": "500bdd39-b2db-ffb3-4c35-13e465f55f6c"
          }
        ]
      }
    }
  ]
}

GET /v2/vsa/vmgroups/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

subclientId — path required

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

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

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

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

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

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

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

Get Virtual Group ID Properties (Deprecated)​

Authorization

Request

Get Virtual Group ID Properties (Deprecated)