Skip to main content

Create Client Group (Deprecated)​

Select

SaaS
Customer Managed

deprecated

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

This operation creates a client computer group.

More Details

Request Body
  • clientGroupOperationType integer
  • clientGroupDetail object
  • associatedClientsOperationType integer
  • isSmartClientGroup boolean
  • isDiscoveredClientGroup boolean
  • scgRule object
  • clientGroup object
  • clientGroupId integer
  • clientGroupName string
  • discoverRulesInfo object
  • virtualInstanceType integer

    1, VMware 2, Microsoft Hyper-V 3, XenServer 4, Amazon 5, Microsoft Azure 6, Red Hat 7, Microsoft Azure Resource Manager 8, System Center Virtual Machine Manager 9, Nutanix 10, Oracle VM 11, Docker 12, OpenStack 13, Oracle Cloud 14, FusionCompute 15, vCloud Director 16, Google Cloud Platform 17, Microsoft Azure Stack 18, Alibaba Cloud 19, Oracle Cloud Infrastructure 20, Kubernetes 21, Red Hat OpenShift

  • associationRule object
  • children object[]
  • equalsOrNotEquals boolean
  • path string
  • displayName string
  • name string
  • allOrAnyChildren boolean
  • type integer

    1, Server Host 2, Resource Pool 3, vApp 4, Datacenter 5, Folder 6, Cluster 7, Datastore 8, DatastoreCluster 9, VirtualMachine 10, VirtualMachine Name 11, VirtualMachine GuestOS 12, VirtualMachine Guest Host Name 13, Cluster Shared Volumes 14, Local Disk 15, Cluster Disk 16, UnprotectedVMs 17, Root/All 18, File Server 19, SMBShare 20, Types 21, VMs 22, Servers 23, Custom Templates 24, DataStoreList 25, vAppList 26, Datacenters 27, Clusters 28, Virtual Machine Power State 29, Virtual Machine Notes 30, Virtual Machine Custom Attribute 31, Network Adapter 32, User 33, Virual Machine Template 34, Tag 35, TagCategory 36, Subclient 37, ClientGroup 38, Protection Domain 39, Consistency Group 40, Instance Size 41, Organization 42, Images 43, Storage Policy 44, Database 45, Database Table

  • virtualClients object
  • clients object[]
  • clientId integer
Responses

OK

Schema
  • clientGroupDetail object
  • clientGroup object
  • _type_ integer
  • clientGroupId integer
  • clientGroupName string
POST /clientgroup

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Content-Type
Body
{

  "clientGroupOperationType": 0,

  "clientGroupDetail": {

    "associatedClientsOperationType": 0,

    "isSmartClientGroup": true,

    "isDiscoveredClientGroup": true,

    "scgRule": {},

    "clientGroup": {

      "clientGroupId": 0,

      "clientGroupName": "string"

    },

    "discoverRulesInfo": {

      "virtualInstanceType": 0,

      "associationRule": {

        "children": [

          {

            "equalsOrNotEquals": true,

            "path": "string",

            "displayName": "string",

            "name": "string",

            "allOrAnyChildren": true,

            "type": 0

          }

        ]

      },

      "virtualClients": {

        "clients": [

          {

            "clientId": 0

          }

        ]

      }

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ClientGroup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientGroupOperationType": 0,
  "clientGroupDetail": {
    "associatedClientsOperationType": 0,
    "isSmartClientGroup": true,
    "isDiscoveredClientGroup": true,
    "scgRule": {},
    "clientGroup": {
      "clientGroupId": 0,
      "clientGroupName": "string"
    },
    "discoverRulesInfo": {
      "virtualInstanceType": 0,
      "associationRule": {
        "children": [
          {
            "equalsOrNotEquals": true,
            "path": "string",
            "displayName": "string",
            "name": "string",
            "allOrAnyChildren": true,
            "type": 0
          }
        ]
      },
      "virtualClients": {
        "clients": [
          {
            "clientId": 0
          }
        ]
      }
    }
  }
}'