Skip to main content

Get Virtual Machine Details​

Get details for virtual machine

Path Parameters
  • vmUUID string required

    The vmUUID can be obtained from GET /virtualMachines UUID property

Query Parameters
  • showInheritedAssociation boolean
Responses

Success

Schema
  • vmDetails object
  • displayName string

    The display name of the virtual machine

  • summary object

    The Virtual Machine detail summary. Hypervisor is the software that creates and runs virtual machines(VMs).

  • hypervisor object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • host string

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

  • os string

    The operating system version for the VM or instance.

  • 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, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

  • vmSize int64

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

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

  • 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 time for the vm(in unix)

  • oldestRecoveryPoint int64

    The oldest recovery time for the vm(in unix)

  • status string

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

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

  • 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
  • appJobInfo object[]
  • instanceName string

    The name of the instance.

  • appName string

    The name of the App.

  • jobId int32

    The child JobId for which the app has been backedup.

  • applicationValidationResults object
  • bootStatus boolean

    true if backup validation is set

  • lastValidationJobId int64

    job id of the last backup validation job

  • backupValidated int64

    job id of the last backup job that was validated

  • backupCompletionDate int64

    timestamp(in unix) for the last backup job completed

  • appsDiscovered object[]
  • name string

    name of the VM apps discovered for validation

  • scriptStatus boolean

    true if validation status is true

  • failureReason string

    reason for failure of validation of app

  • passkey object
  • authType string

    Possible values: [USE_LOGIN, USE_PASSKEY, USE_LOGGEDIN_SESSION]

    The authentication type set for browse and restore

  • expirationTime int32

    The duration(in unix time) for which a user can continue browsing and restoring backup data without being prompted to enter the passkey, again.

  • passKeyRequiredForRestore boolean

    To tell if passkey is required for browse and restore

  • enableAuthorizeForRestore boolean

    To tell if user is authorized for restore

  • security object
  • associations object[]
  • user object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • role object
  • id int32
  • name string
  • permissions 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.

  • owners object[]
  • userId int32
  • userName string
  • userGroupId int32
  • userGroupName string
  • activityControl object[]
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE, AUXCOP, DRBACKUP, MEDIARECYCLE, SYNTHETICFULL, ALLACTIVITY, SCHEDULE, OFFLINECI, DDBACTIVITY, DATAVERIFICATION, SENDLOGFILEACTIVITY]

    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

  • tags object[]
  • id int32
  • name string
  • value string
  • additionalProperties object
  • isContentIndexed boolean

    Returns true if content is indexed on VM client

  • isIndexingV2 boolean

    Returns true if the VM is a indexing V2 client

  • isSnapshotV2 boolean

    Returns true if snapshot V2 is enabled

  • isPasskeyFeatureEnabled boolean

    Returns true if passkey feauture is enabled

  • isPrivacyFeatureEnabled boolean

    Returns true if privacy feauture is enabled

  • isAppValidationEnabled boolean

    Returns true if app validation 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.

  • isBackupAllowed boolean

    Returns true if the backups are allowed for the VM client

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

  • bkpEndTime int64

    UNIX time for the backup end time

  • bkpStartTime int64

    UNIX time for the backup start time

  • vmBackupJob int32

    Backup job Id of the VM

  • pseudoClientDisabled boolean

    Returns true if the client is disabled

  • isDeleted boolean

    Returns true if the VM is deleted

  • isSnapBackupEnabled boolean

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

  • 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
  • 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
  • client object
  • id int32
  • name string
  • replicationSiteInfo object
  • BkpJobsToSync string

    Backup jobs that need to be synchronized to the replication site

  • isIndexingV2 boolean

    Returns true if the VM is a indexing V2 client

  • lastRestoreTime int64

    UNIX time of last restore operation

  • replicationId int32

    Replication ID of particular VM

  • destinationName string

    Name of the recovered entity

  • lastSyncedBkpJob int64

    ID of the last synchronized backup job

  • FailoverStatus string

    Current failover status of the VM

  • DRVendor 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, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

  • SourceVendor 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, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

  • replicationGroup object
  • id int32
  • name string
  • replicationTarget object
  • id int32
  • name string
  • destinationHypervisor object
  • id int32
  • name string
  • UUID string

    Unique identifier of the VM

  • vmStatusError string

    VM status error message

  • vmFailureReasonForWarning string

    Warning reason for VM failure

Loading...