Skip to main content

Get All Virtual Machines​

Select

SaaS
Customer Managed

Get all virtual machines

Query Parameters
  • additionalProperties boolean

    When set to true, additional properties of the Virtual Machine are fetched.

  • start integer

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

  • limit integer

    Default value: 20

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

Responses

Success

Schema
  • virtualMachines object[]
  • name string

    The display name of the VM.

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

    The hypervisor where the VM is located.

  • description string

    The description of the VM.

  • displayName string

    The display name of the VM.

  • hypervisor object
  • id int32
  • name string
  • cloudVendor string

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

    Cloud Vendor of the VM.

  • regionName string

    The region name of the VM.

  • vmGroup object
  • id int32
  • name string
  • backupset object
  • backupSetId int32
  • backupSetName string
  • os string

    The operating system version for the VM or instance.

  • host string

    The host name for the computer where the source virtual machine or instance resides.

  • vmSize int64

    The total space allocated(in bytes) for the virtual machine.

  • status string

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

    The status of the backup for the VM, instance, or container.

  • UUID string

    The globally unique identifier for the VM client.

  • commcellName string

    Name of the commcell the VM belongs

  • 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

  • latestRecoveryPoint int64

    The latest recovery point for the virtual machine. (in unix)

  • oldestRecoveryPoint int64

    The oldest recovery point for the virtual machine. (in unix)

  • applicationSize int64

    The amount of data being protected for the VM client(in bytes)

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

  • SLA object
  • status string

    Possible values: [MET_SLA, MISSED_SLA, EXCLUDED_SLA, YET_TO_BE_PROTECTED, MIGHT_MISS_SLA, UNKNOWN]

    Provides the SLA status.

  • slaMayMissReason string

    The reason for the missed SLA of the VM client

  • reason string

    The reason for the current SLA status of the VM client

  • company object
  • id int32
  • name string
  • tags object[]
  • id int32
  • name string
  • value string
  • commcell object
  • name string

    Name of the commcell the entity belongs to.

  • additionalProperties object
  • bkpEndTime int64

    UNIX time for the backup end time

  • bkpStartTime int64

    UNIX time for the backup start time

  • client object
  • id int32
  • name string
  • isPhysicalClient boolean

    Returns true if the VM is a physical client

  • isSnapBackupEnabled boolean

    Returns true if the snap backup is enabled for the VM client

  • osType string

    Possible values: [CLIENT_PLATFORM_OSTYPE_UNKNOWN, CLIENT_PLATFORM_OSTYPE_WINDOWS, CLIENT_PLATFORM_OSTYPE_UNIX, CLIENT_PLATFORM_OSTYPE_NETWARE, CLIENT_PLATFORM_OSTYPE_NAS_FILTER, CLIENT_PLATFORM_OSTYPE_DATA_ONTAP]

    VM OS types

  • isBackupAllowed boolean

    Returns true if the backups are allowed for the VM client

  • isContextIndexed boolean

    Returns true if context indexed

  • isDeleted boolean

    Returns true if the VM is deleted

  • isIndexingV2 boolean

    Returns true if the VM is a indexing V2 client

  • isSnapshotV2 boolean

    Returns true if snapshot V2 is enabled

  • latestBackupTimeCatalogedSuccessfully int64

    Last successfully cataloged backup time

  • indexingStatus string

    Possible values: [NOT_APPLICABLE, ENABLED, SETUP_IN_PROGRESS]

    Default value: NOT_APPLICABLE

    Type of indexing status.

  • pseudoClientDisabled boolean

    Returns true if the client is disabled

  • isBackupActivityEnabled boolean

    Returns true if the backup activity is enabled for the VM

  • isRestoreActivityEnabled boolean

    Returns true if the restore activity is enabled for the VM

  • retireAgentPhase RetireClientPhase

    Possible values: [UNKNOWN, RETIRE_IN_PROGRESS, DECONFIGURED]

  • retireClientPhase RetireClientPhase

    Possible values: [UNKNOWN, RETIRE_IN_PROGRESS, DECONFIGURED]

  • proxyClient object
  • id int32
  • name string
  • subclient object
  • id int32
  • name string
  • vmAgent string

    The name of the VM agent

  • vmBackupJob int32

    Backup job Id of the VM

  • vmUsedSpace int64

    Space used by the VM

  • vsaNextBackupSubClientEntity object

    Summary of VMEntity in Virtual Machine summary

  • instance object
  • id int32
  • name string
  • backupset object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • associatedVMSubclient object

    Summary of VMEntity in Virtual Machine summary

  • instance object
  • id int32
  • name string
  • backupset object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • virtualMachinesCount int32
Loading...