Skip to main content

Create a VM Group​

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, REGION]

  • guestCredentialAssocId int32

    Credential association ID given to link entity with credential id.

  • guestCredentials object
  • userName string
  • password string
  • existingCredential object
  • credentialId int32
  • credentialName string
  • description string

    Description of the VM

  • 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, REGION]

  • 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

  • description string

    Description of the rule

  • description string
  • 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

  • settings object
  • useChangedBlockTrackingOnVM boolean

    Default value: true

    True if Changed Block Tracking is enabled

  • customSnapshotResourceGroup string

    Custom snapshot resource group name for Azure

  • customSnapshotTags object[]

    represents custom tags to be set on snapshots in Azure

  • name string

    represents name of the tag

  • value string

    represents value of the tag

  • diskAccesses object[]

    represents Disk accesses per region in Azure

  • region string

    represents name of the region

  • diskAccessId string

    represents the disk access ID

  • snapshotStorageType string

    Possible values: [Standard_LRS, Premium_LRS, Standard_ZRS]

    Default SKU for all VM snapshots created for that VM Group

  • softwareCompression string

    The software compression value in the VM Group.

  • encryptionFlag string

    The encryption value in the VM Group.

  • canChangeEncryptionSetting boolean

    True if encryption setting can be modified.

  • isSnapshotV2 boolean

    True if snapshotv2 prop set on VM group.

  • regionalSnapshot boolean

    Default value: true

    True when snapshot storage location is regional

  • autoDetectVMOwner boolean

    Default value: false

    True if auto detect VM Owner enabled

  • allowEmptySubclient boolean

    True if empty subclient is allowed

  • noOfReaders int32

    Default value: 5

    Number of readers for backup

  • isVMGroupDiskFiltersIncluded boolean

    Is VM group disk filters included in VM instance disk filters

  • vmBackupType string

    Possible values: [APPLICATION_AWARE, FILE_SYSTEM_AND_APPLICATION_CONSISTENT, CRASH_CONSISTENT, APP_BASED_BACKUP, INHERITED]

  • isApplicationAware boolean

    Is the VM App Aware

  • guestCredentials object

    Guest credential for contennt VMs of VM Group

  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • applicationCredentials object

    Application credential for contennt VMs of VM Group and VMs

  • savedCredentials object
  • id int32
  • name string
  • useVMCheckpointSetting boolean

    Default value: false

    True if use VM CheckPoint setting is enabled

  • transportMode string

    Possible values: [AUTO, SAN, HOT_ADD, NAS, NBD_SSL, NBD]

    Default value: AUTO

    transport mode based on environment. Values are case sensitive

  • datastoreFreespaceCheck boolean

    Default value: false

    True if Datastore Free space check is enabled

  • datastoreFreespaceRequired int32

    precentage of datastore free space check value

  • collectFileDetailsforGranularRecovery boolean

    Default value: false

    True if metadata collection is enabled. Only applicable for Indexing v1

  • collectFileDetailsFromSnapshotCopy boolean

    Default value: false

    True if metadata collection is enabled for intellisnap jobs. Only applicable for Indexing v1

  • jobStartTime int32

    Start Time for the VM Group Job

  • crossAccount object
  • shareOnly boolean

    True if replicate and copy or sharing of amazon snapshot to different amazon account in same or different geographic location is enabled

  • fullCopy boolean

    True if full copy of amazon snapshot to different amazon account is enabled

  • destinationAccount object
  • id int32
  • name string
  • quiesceGuestFileSystemAndApplications boolean

    True if VM backup type is File system and application consistent

  • useBackupsetDiskFilters boolean

    True if use of backupset disk filters is allowed

  • backupStagingStorage string

    It can be a datastore name, file path or Automatic

Responses

Success

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

    Response message

  • warningMessage string

    Response message

Loading...