Skip to main content

Get VM Group Details​

Select

SaaS
Customer Managed

Get the details of vmGroup

Path Parameters
  • VmGroupId int32 required

    Id of the VmGroup to get

Responses

Success

Schema
  • id int32
  • name string
  • status int32

    subclient entity status

  • vmBackupInfo object
  • vmPendingCount int32

    VMs pending for Backup

  • vmProtectedCount int32

    Protected vm Count

  • vmNotProtectedCount int32

    VM Missed to protect count

  • vmNeverBackedUpCount int32

    vm never Backed up count

  • vmBackedUpWithErrorCount int32

    VM Backed up with error count

  • vmTotalCount int32

    Total vm Count

  • summary object
  • hypervisorName string
  • lastBackupTime int32

    Last Backup time of the VMGroup

  • lastBackupSize int64

    Last Backup Job Size

  • nextBackupTime int32

    Next Backup Job start time

  • isDefaultVMGroup boolean

    Default value: false

    True if subclient is default subclient

  • backupActivityStatus string

    Current backup activity status

  • plan object
  • id int32
  • name string
  • subType string

    Possible values: [ANY, DLO, SERVER, LAPTOP, DATABASE, SNAP, FS_SERVER, VSA_SERVER, VSA_REPLICATION, EXCHANGE_USER, EXCHANGE_JOURNAL, DATA_CLASSIFICATION, E_DISCOVERY, OFFICE_365, ARCHIVER, FSIBMIVTL, DYNAMICS_365, CDM, ObjectStore]

  • region object
  • id int32

    Region Id

  • name string

    Region Name

  • displayName string

    Display Name of Region

  • latitude string

    Geolocation Latitude

  • longitude string

    Geolocation Longitude

  • replicationGroup object
  • id int32
  • name string
  • timeZone object
  • id int32
  • name string
  • content object[]
  • overwrite boolean

    Default value: false

    True if content in vmgroup has to be overwritten, by default it will append 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]

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

  • 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

  • filters object[]
  • overwrite boolean

    Default value: false

    True if content in vmgroup has to be overwritten, by default it will append 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]

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

  • 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

  • diskFilters object[]
  • overwrite boolean

    Default value: false

    True if content in vmgroup has to be overwritten, by default it will append the content

  • rules object[]
  • overwrite boolean

    Default value: false

    True if disk filter in vmgroup has to be overwritten, by default it will append the content

  • filterType string

    Possible values: [NONE, DISK_PATH, DISK_PATTERN, DISK_VIRTUAL_DEVICE_NODE, DISK_DATASTORE, DISK_LABEL, DISK_TYPE, DISK_ADDRESS, CONTAINER_PATTERN, DISK_TAG]

  • name string

    The string to be filtered

  • value string

    The value string to be filtered, in case of disk tag , value of tag to be filtered

  • condition RuleOperationType

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

    Operation type for VM rules/filters

  • vmName string

    VM Name of the Virtual Machine whose disk has to be filtered . This is optional. if not given, all disks of name and type from all Vms added in content will be filtered

  • vmGuid string

    VM Guid of the Virtual Machine whose disk has to be filtered . This is optional. if not given, all disks of name and type from all Vms added in content will be filtered

  • lastBackup object
  • jobId int32

    Returns the job id of the last backup job performed.

  • status string

    Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

    Status of the last backup job performed.

  • time int64

    Shows the time when the last back up job was carried out. The time is provided in unix time format.

  • failureReason string

    Gives the reason for the last backup job failing, if the last backup job fails.

  • securityAssociations object[]
  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • externalUserGroup object

    External User Group Entity

  • id int32

    User Group Id

  • name string

    External Group Name

  • providerId int32

    Provider id

  • providerName string

    Provider Name

  • isCreatorAssociation boolean
  • role object
  • id int32
  • name string
  • permissionList object[]
  • permissionId int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag to specify if this is included permission or excluded permission.

  • 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

  • name string

    represents name of the tag

  • value string

    represents value of the tag

  • regionalSnapshot boolean

    Default value: true

    True when snapshot storage location is regional

  • autoDetectVMOwner boolean

    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
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • 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: true

    True if Datastore Free space check is enabled

  • datastoreFreespaceRequired int32

    Default value: 10

    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

  • snapshotManagement object
  • enableHardwareSnapshot boolean

    Default value: false

    True if hardware snapshot is enabled

  • snapEngine object
  • id int32
  • name string
  • snapMountESXHost string

    Name of ESX Host

  • isIndependentDisksEnabled boolean

    True if independent disk option is enabled

  • isRawDeviceMapsEnabled boolean

    True if raw device maps option is enabled

  • useSeparateProxyForSnapToTape boolean

    True if separate proxy client is used for snap to tape

  • snapMountProxy object
  • id int32
  • name string
  • vmApplicationUserName string

    Virtual machine application user name

  • backupCopyInterface string

    Possible values: [FILE_SYSTEM, RMAN, VOLUME_COPY]

  • activityControl object
  • enableBackup boolean

    true if Backup is enabled

  • enableRestore boolean

    true if Restore is enabled

  • backupActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • restoreActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • applicationValidation object
  • validateVMBackups boolean

    True if VM Backup validation is enabled

  • recoveryTarget object
  • id int32
  • name string
  • schedule object

    Schedule for application validation for VM Group

  • id int32
  • taskId int32

    Job Id for the application validation task. 0 if schedule is disabled

  • description string

    Description for validation schedule

  • isScheduleEnabled boolean

    True if application validation schedule is enabled

  • useSourceVmESXToMount boolean

    Use Source VM ESX To Mount

  • keepValidatedVMsRunning boolean

    If true then validated VMs will be available until expiration time set on the recovery target

  • maximumNoOfThreads int32

    Number of backup Validation Threads

  • customValidationScript object

    Custom validation script to be used during VM backup validation

  • windows object
  • path string

    Path for the validation script

  • arguments string

    Arguments for the script

  • isDisabled boolean

    Default value: false

    Is the script disabled

  • isLocal boolean

    True if the script is local

  • UNCCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • UNCSavedCredentials object
  • id int32
  • name string
  • unix object
  • path string

    Path for the validation script

  • arguments string

    Arguments for the script

  • isDisabled boolean

    Default value: false

    Is the script disabled

  • isLocal boolean

    True if the script is local

  • UNCCredentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

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

    username to access the network path

  • password string

    password to access the network path

  • copy object

    Application validation source copy details

  • id int32

    Id of the source copy

  • name string

    Name of the source copy

  • isActive boolean

    Is this an active backup destination?

  • isSnapCopy boolean

    Is this a snap copy?

  • copyPrecedence int32

    Order of backup destinaion copy created in storage policy

  • backupDestination object
  • id int32
  • name string
  • accessNodeList object
  • accessNodeMessage string
  • resourcePoolName string
  • accessNode object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • commonProperties object
  • isIndexingV2 boolean

    True if Indexing version is 2

  • isDeletedHypervisor boolean

    True if the hypervisor is deleted

  • isETCDSubclient boolean

    True if this is a ETCD Subclient

  • showFullBackupLevel boolean

    True if we need to show full backup level

  • indexingInfo object
  • status string

    Possible values: [NOT_APPLICABLE, ENABLED, SETUP_IN_PROGRESS]

    Default value: NOT_APPLICABLE

    Type of indexing status.

  • message string

    Indexing Message

  • isHypervisorDeconfigured boolean

    true if the hypervisor has been deconfigured

  • hypervisorType string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI]

  • hypervisor object

    Common properties of hypervisor in vmgroup

  • id int32
  • name string

    Name of the hypervisor client

  • activityControl object
  • enableBackup boolean

    true if Backup is enabled

  • enableRestore boolean

    true if Restore is enabled

  • backupActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • restoreActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • instance object
  • id int32
  • name string
  • backupset object
  • id int32
  • name string
  • iDataAgent object
  • id int32
  • name string
  • dataBackupStoragePolicy object
  • id int32
  • name string
  • meditechSystems 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

GET /v4/vmgroup/:vmgroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
VmGroupId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'