REST API - GET Virtual Machine User Interface IDs

This operation returns virtual machine (VM) group information that is available in a virtual client .

Request

Syntax

GET webservice/v2/vsa/vmGroups/vmgroupID HTTP/1.1
Host: host name
Accept: {application/json}
Content-type: application/json

where <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
vmgroupID	The ID of the virtual group. If the virtual group is not known, use the GET Virtual Group IDs to retrieve it.

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center 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 value is application/json.

Response

Response Parameters

Parameter	Description
vmGroupInfo	The information of the VM group.
vmGroupId	The unique ID of the VM group.
clientName	The name of the VM client.
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.
vmSLAInfo	The SLA information for a VM.
vmExcludedCount	The number of VMs that are excluded in SLA
vmMetSLACount	The number of VMs that met SLA.
vmMissedSLACount	The number of VMs that missed SLA.
equalsOrNotEquals	The condition for a rule while adding content. For example, VM name or pattern EQUALS test. For a positive condition such as EQUALS , CONTAINS equalsOrNotEquals will be 1. For a negative condition such as DOES_NOT_EQUALS, DOES_NOT_CONTAINS equalsOrNotEquals will be 0.
path	The path of the content. For example, for a VM, it is GUID.
displayName	The display name of the content that you added. For example, VM display name.
name	The name of the content that you added. For example, datastore name.
allOrAnyChildren	The condition for rules in rule groups . For theAll condition in rule group , allOrAnyChildren will be 1, For Any condition in rule group , allOrAnyChildren will be 0.
type	The type of the content to be added to the subclient. Valid values are: VMName - to add a virtual machine to the subclient content. DATASTORE - to add a datastore to the subclient content. This only applies to VMware agents. For a complete list of values, see VSA Object Types.

Examples

Sample Request

GET webservice/v2/vsa/vmGroups/521 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Content-type: application/json

Sample Response

{
  "vmGroupInfo": [
    {
      "vmGroupId": 521,
      "clientName": "VMWare_Client",
      "vmGroupName": "VMWare LiveSyncDirect",
      "planName": "Plan_1",
      "lastBackupTime": 0,
      "vmBackupInfo": {
        "vmPendingCount": 0,
        "vmProtectedCount": 0,
        "vmNotProtectedCount": 0,
        "vmNeverBackedUpCount": 0,
        "vmBackedUpWithErrorCount": 0,
        "vmTotalCount": 0
      },
      "vmSLAInfo": {
        "vmExcludedCount": 3,
        "vmMetSLACount": 0,
        "vmMissedSLACount": 0
      },
      "content": {
        "children": [
          {
            "equalsOrNotEquals": true,
            "path": "",
            "displayName": "LiveSyncDirectVM1",
            "name": "5026b5cc-1f53-bd8b-2a79-9bf6ee9bc9a4",
            "allOrAnyChildren": true,
            "type": 9
          },
          {
            "equalsOrNotEquals": true,
            "path": "",
            "displayName": "LiveSyncDirectVM10",
            "name": "5026f812-cb97-9cef-8152-cecf8c05b150",
            "allOrAnyChildren": true,
            "type": 9
          },
          {
            "equalsOrNotEquals": true,
            "path": "",
            "displayName": "LiveSyncDirectVM2",
            "name": "5026d5cb-b72a-b901-72a2-9a5bb38878dd",
            "allOrAnyChildren": true,
            "type": 9
          }
        ]
      }
    }
  ]
}