VM Details By GUID

Get Virtual Machine Details by GUID

Path Parameters

• vmGUID string required

  GUID of Virtual Machine

Responses

• 200
• 401
• 404
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

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

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

• expirationTime int32

  Expiration time of virtual machine

• 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

• numberOfNICs int32

  Number of network interface cards

• networks string[]

  List of networks associated with virtual machine

• disks object[]

  List of the disks associated with virtual machine

  label string

  Label of disk

  diskSize int64

  Size of disk associated with virtual machine

  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

{
  "name": "string",
  "state": "STOPPED = 0",
  "ipAddress": "string",
  "operatingSystem": "string",
  "vendor": "NONE",
  "expirationTime": 0,
  "creator": "string",
  "description": "string",
  "owners": [
    "string"
  ],
  "numberOfCPUs": 0,
  "memory": 0,
  "numberOfNICs": 0,
  "networks": [
    "string"
  ],
  "disks": [
    {
      "label": "string",
      "diskSize": 0,
      "isSystemDisk": true
    }
  ],
  "isSnapshotSupported": true,
  "lab": {
    "id": 0,
    "name": "string"
  },
  "vmGUID": "string"
}

Unauthorized

VM Not Found

Internal Server Error

GET /vmprovisioning/virtualmachine/:vmguid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

vmGUID — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VMProvisioning/VirtualMachine/:vmGUID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'