Skip to main content

Get VM Groups​

Select

SaaS
Customer Managed

Get the details of all vmGroup

Query Parameters
  • hypervisorId int32

    Id of the hypervisor to list vm groups

  • start integer

    This value determines the starting point for fetching VM Groups. For example, if set to 5, the first 5 VM Groups will be skipped, and fetching will begin from the 6th group onward.

  • limit integer

    Default value: 20

    Specifies the number of VM Groups to fetch. If set to 0, all VM Groups will be fetched starting from the specified start value.

Responses

Success

Schema
  • vmGroupCount int32
  • vmGroups object[]
  • status string

    Possible values: [ALL, PROTECTED, NOT_PROTECTED, PENDING, BACKED_UP_WITH_ERROR, DISCOVERED]

  • cloudVendor string

    Possible values: [CV_DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

    Cloud Vendor of the VM.

  • regionName string
  • 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, KUBERNETES_EKS, MORPHEUS]

  • vmGroup object
  • id int32
  • name string
  • Hypervisor object
  • id int32
  • name string
  • displayName string
  • Instance object
  • id int32
  • name string
  • 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]

  • lastBackup object

    last backup job details for the client

  • time int64

    UNIX time for the last backup job run

  • jobId int32

    Job id of the last backup job

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

  • lastSuccessfullBackupTime int64

    UNIX time for the last successful backup job run

  • failureReason string

    Failure reason for the last backup job

  • commcell object
  • name string

    Name of the commcell the entity belongs to.

  • company object
  • id int32

    Id of company

  • name string

    Name of company

  • multiCommcellId int32

    Multi Commcell Id of company

  • replicationGroup object
  • id int32
  • name string
  • isDefaultVMGroup boolean

    Default value: false

    True if subclient is default subclient

  • storagePolicyRetentionExtension boolean

    Default value: false

    True if extend storage policy Retention was set in VMGroup for deleted files

  • indexingStatus string

    Possible values: [NOT_APPLICABLE, ENABLED, SETUP_IN_PROGRESS]

    Default value: NOT_APPLICABLE

    Type of indexing status.

  • SnapBackupEnabled boolean

    Default value: false

    True if snap backup enabled

  • description string

    Description of VMGroup

  • 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

  • Backupset object
  • id int32
  • name string
  • tags object[]
  • id int32
  • name string
  • value string
GET /v5/vmgroups

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
hypervisorId — query
start — query
limit — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/VMGroups' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'