Skip to main content

VM Details By GUID​

Select

SaaS
Customer Managed

Get Virtual Machine Details by GUID

Path Parameters
  • vmGUID string required

    GUID of Virtual Machine

Responses

OK

Schema
  • name string

    Name of virtual machine

  • state VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • ipAddress string

    IP address of virtual machine

  • operatingSystem string

    Operating system of virtual machine

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

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

  • expirationTime int32

    Expiration time of virtual machine in UNIX timestamp format

  • creator string

    Creator of virtual machine

  • description string

    Description of virtual machine

  • owners string[]

    List of owners for virtual machine

  • numberOfCPUs int32

    Number of CPUs in virtual machine

  • memory int64

    Memory size of virtual machine

  • vmSize string

    Instance type associated with virtual machine

  • dnsHostName string

    Domain name associated with the virtual machine

  • enableRenew boolean

    Is renew operation supported

  • loginUser object
  • id int32
  • name string
  • numberOfNICs int32

    Number of network interface cards

  • networks object[]

    List of networks associated with virtual machine

  • name string

    Name of network

  • subnet string[]

    List of subnets associated to network

  • disks object[]

    List of the disks associated with virtual machine

  • label string

    Label of disk

  • diskSize int64

    Size of disk associated with virtual machine

  • uniqueDiskName string

    Unique name of disk

  • diskId string

    Unique identifier of disk

  • isSystemDisk boolean

    Whether the disk is system disk or not

  • isSnapshotSupported boolean

    Whether the live mount is enabled or disabled

  • lab object
  • id int32
  • name string
  • vmGUID string

    GUID of virtual machine

  • target object

    Details of target associated to virtual machine

  • id int32
  • name string
  • sourceMachine object

    Details of source virtual machine for live mounted machine

  • GUID string
  • name string
  • vmRunningJobs object[]

    List of active jobs associated with virtual machine

  • id int64

    Job id

  • progress float

    Job progress in percentage

  • operationType VMOperationEnum

    Possible values: [CREATE = 0, RESTART = 1, SHUTDOWN = 2, SNAPSHOT = 3, RESTORE_SNAP = 4, DELETE = 5, CLONE = 6, PAUSE = 7, POWERON = 10, EDIT = 11, VIEW_SNAPSHOTS = 12, DELETE_SNAP_VM = 15, RENEW_VM = 17, REFRESH_VM = 20, EDIT_OWNERS = 21, POWER_OFF = 29, EDIT_CREATOR = 30, REFRESH = 31, LIST_OWNERS = 32, CREATE_LAB = 34]

GET /v4/vmprovisioning/virtualmachine/:vmguid

Authorization

type: apiKeyname: Authtokenin: header

Request

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