Get Virtual Machine By ID
DescriptionGet an individual template virtual machine by its id/name.
Request
URLURL
Path Parameters
Path Parameters
ID of template containing the VM
ID of the virtual machine
Query Parameters
Query Parameters
Organization ID: non-super users can only access their own organization
Page number to retrieve.
Size of each page.
Ascending/Descending. Format is property,{asc|desc} and default is ascending.
Authentication
Response
Response BodyResponse Body
200 OK
Successfully retrieved template VirtualMachines
{
"agentStatus": "string",
"agentVersion": "string",
"cloudId": "string",
"createdAt": "string",
"error": "string",
"haiAgentVersion": "string",
"id": "string",
"image": "string",
"lifecycleStatus": "string",
"loadIndex": 0,
"maxSessions": 0,
"powerState": "string",
"privateIp": "string",
"publicKey": "string",
"sessionPlacementStatus": "string",
"snapshotId": "string",
"statusCode": 0,
"timestamp": 0,
"updatedAt": "string",
"updatedLoadIndexAt": "string",
"viewAgentVersion": "string",
"vmFreeSessions": 0
}
Agent status
Agent version
VM ID from cloud provider
Reason for error status
HAI Agent version
VM ID
Image used to create the VM
VM lifecycle status
Indicates maximum number of sessions supported by the VM
Power state
Indicates the availability of the vm for session placement
VM snapshot ID
Agent status code
Agent message timestamp. The inventory will only store the the latest record ever seen, and discard stale ones if received later
View Agent version
Indicates the number of free sessions on the VM
Errors
Unauthorized
Forbidden
Not Found
Unexpected internal server error
