Skip to main content

Get Virtual Machine Details​

Select

SaaS
Customer Managed

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]

  • vmSize int32

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

  • applicationSize int32

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

  • plan object
  • id int32
  • name string
  • latestRecoveryPoint int32

    The latest recovery time for the vm(in unix)

  • oldestRecoveryPoint int32

    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.

  • reason string

    The reason for the current SLA status of the VM client

  • company object
  • id int32
  • name string
  • applicationValidationResults object
  • bootStatus boolean

    true if backup validation is set

  • lastValidationJobId int32

    job id of the last backup validation job

  • backupValidated int32

    job id of the last backup job that was validated

  • backupCompletionDate int32

    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]

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

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