Skip to main content

Create a VM Group​

Select

SaaS
Customer Managed

Create a VM Group

Request Body
  • name string required

    subclient name

  • Hypervisor object required
  • id int32
  • name string
  • content object required
  • overwrite boolean

    Default value: true

    False if content in vmgroup has to be appended, by default it will overwrite the content

  • virtualMachines object[]
  • name string

    name of the VM to be added as content

  • GUID string

    GUID of the VM to be added as content

  • type string

    Possible values: [NONE, SERVER, RES_POOL, VAPP, DATACENTER, FOLDER, CLUSTER, DATASTORE, DATASTORE_CLUSTER, VM, VM_NAME, VM_GUEST_OS, VM_GUEST_HOST_NAME, CLUSTER_SHARED_VOLUMES, LOCAL_DISK, CLUSTER_DISK, UNPROTECTED_VMS, ROOT, FILE_SERVER, SMB_SHARE, TYPES_FOLDER, VM_FOLDER, SERVER_FOLDER, TEMPLATE_FOLDER, STORAGE_REPOSITORY_FOLDER, VAPPFOLDER, DATACENTER_FOLDER, CLUSTER_FOLDER, VM_POWER_STATE, VM_NOTES, VM_CUSTOM_ATTRIBUTE, NETWORK, USER, VM_TEMPLATE, TAG, TAG_CATEGORY, SUBCLIENT, CLIENT_GROUP, PROTECTION_DOMAIN, CONSISTENCY_GROUP, INSTANCE_SIZE, ORGANIZATION, IMAGES, STORAGE_POLICY, DATABASE, TABLE, PROJECT, SELECTOR, MANAGED_BY, REPLICATION_MODE, METADATATAG, CATALOG, VAPPTEMPLATE, VOLUME, VM_BADGE]

  • guestCredentialAssocId int32

    Credential association ID given to link entity with credential id.

  • guestCredentials object
  • userName string
  • password string
  • existingCredential object
  • credentialId int32
  • credentialName string
  • ruleGroups object[]
  • matchRule MatchRule

    Possible values: [ALL, ANY]

    Enum which specifies the whether to match all rules or any of the rules

  • rules object[]
  • name string

    name of the VM to be added as content

  • type string

    Possible values: [NONE, SERVER, RES_POOL, VAPP, DATACENTER, FOLDER, CLUSTER, DATASTORE, DATASTORE_CLUSTER, VM, VM_NAME, VM_GUEST_OS, VM_GUEST_HOST_NAME, CLUSTER_SHARED_VOLUMES, LOCAL_DISK, CLUSTER_DISK, UNPROTECTED_VMS, ROOT, FILE_SERVER, SMB_SHARE, TYPES_FOLDER, VM_FOLDER, SERVER_FOLDER, TEMPLATE_FOLDER, STORAGE_REPOSITORY_FOLDER, VAPPFOLDER, DATACENTER_FOLDER, CLUSTER_FOLDER, VM_POWER_STATE, VM_NOTES, VM_CUSTOM_ATTRIBUTE, NETWORK, USER, VM_TEMPLATE, TAG, TAG_CATEGORY, SUBCLIENT, CLIENT_GROUP, PROTECTION_DOMAIN, CONSISTENCY_GROUP, INSTANCE_SIZE, ORGANIZATION, IMAGES, STORAGE_POLICY, DATABASE, TABLE, PROJECT, SELECTOR, MANAGED_BY, REPLICATION_MODE, METADATATAG, CATALOG, VAPPTEMPLATE, VOLUME, VM_BADGE]

  • value string

    value for the few type of VM Content like powerstate

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • GUID string

    GUID of the entity to be added as content

  • displayName string

    The display name of the entity to be added

  • plan object required
  • id int32
  • name string
  • storage object
  • id int32
  • name string
  • enableIntellisnap boolean

    Default value: false

    True if Intellisnap has to be enabled

  • Meditech object
  • systemName string

    Meditech system name

  • listenerIP string

    Meditech Listener IP of FQDN name

  • listenerPort int32

    Meditech Listener Port

  • MBFtimeout int32

    Default value: 60

    MBF timeout (in seconds)

  • userAccount object
  • name string

    username to access the network path

  • password string

    password to access the network path

Responses

Success

Schema
  • subclientId int32
  • warningCode int32
  • errorCode int32
  • errorMessage string

    Response message

  • warningMessage string

    Response message

POST /v4/vmgroup

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "name": "string",

  "Hypervisor": {

    "id": 0,

    "name": "string"

  },

  "content": {

    "overwrite": true,

    "virtualMachines": [

      {

        "name": "string",

        "GUID": "string",

        "type": "NONE",

        "guestCredentialAssocId": 0,

        "guestCredentials": {

          "userName": "string",

          "password": "string"

        },

        "existingCredential": {

          "credentialId": 0,

          "credentialName": "string"

        }

      }

    ],

    "ruleGroups": [

      {

        "matchRule": "ALL",

        "rules": [

          {

            "name": "string",

            "type": "NONE",

            "value": "string",

            "condition": "CONTAINS",

            "GUID": "string",

            "displayName": "string"

          }

        ]

      }

    ]

  },

  "plan": {

    "id": 0,

    "name": "string"

  },

  "storage": {

    "id": 0,

    "name": "string"

  },

  "enableIntellisnap": false,

  "Meditech": {

    "systemName": "string",

    "listenerIP": "string",

    "listenerPort": 0,

    "MBFtimeout": 60,

    "userAccount": {

      "name": "string",

      "password": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VMGroup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "Hypervisor": {
    "id": 0,
    "name": "string"
  },
  "content": {
    "overwrite": true,
    "virtualMachines": [
      {
        "name": "string",
        "GUID": "string",
        "type": "NONE",
        "guestCredentialAssocId": 0,
        "guestCredentials": {
          "userName": "string",
          "password": "string"
        },
        "existingCredential": {
          "credentialId": 0,
          "credentialName": "string"
        }
      }
    ],
    "ruleGroups": [
      {
        "matchRule": "ALL",
        "rules": [
          {
            "name": "string",
            "type": "NONE",
            "value": "string",
            "condition": "CONTAINS",
            "GUID": "string",
            "displayName": "string"
          }
        ]
      }
    ]
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "storage": {
    "id": 0,
    "name": "string"
  },
  "enableIntellisnap": false,
  "Meditech": {
    "systemName": "string",
    "listenerIP": "string",
    "listenerPort": 0,
    "MBFtimeout": 60,
    "userAccount": {
      "name": "string",
      "password": "string"
    }
  }
}'