Get Virtual Machine

Get Virtual Machine
Request
URI
GET
https://{api_host}/dt-rest/v100/pool/manager/vm
COPY
Query Parameters
string
vmid
Required

vmid

string
pid
Required

pid

Responses
200

successful operation

Returns DtVirtualMachine of type(s) */* 
{
    "DtVirtualMachineState": "string",
    "type": "string",
    "description": "string",
    "vmId": "string",
    "numCPUs": 0,
    "patternId": "string",
    "templateId": "string",
    "vmPath": "string",
    "inventoryPath": "string",
    "ipAddress": "string",
    "externalIpAddress": "string",
    "refId": "string",
    "vmpowerState": "string",
    "vmlifeState": "string",
    "vmlifeStateDate": "string",
    "threeDEnabled": false,
    "hotplugEnabled": false,
    "vmhardwareVersion": "string",
    "networkId": "string",
    "daaSAgentVersion": "string",
    "daaSAgentState": "string",
    "vmwareToolsState": "string",
    "guestOS": "string",
    "computePoolId": "string",
    "memorySizeMB": 0,
    "goldPatternVersion": 0,
    "powerOnDate": "string",
    "sealDate": "string",
    "poolName": "string",
    "macAddress": "string",
    "desktopManagerName": "string",
    "viewAgentVersion": "string",
    "dnsName": "string",
    "viewAgentPaired": false,
    "agentPairingAcknowledged": false,
    "allocateState": "string",
    "resyncState": "string",
    "customizationState": "string",
    "agentErrorCode": "string",
    "sessionAllocationState": "string",
    "rectify": false,
    "name": "string",
    "id": "string",
    "links": [
        {
            "href": "string",
            "rel": "string",
            "deprecated": false,
            "name": "string",
            "method": "string"
        }
    ]
}
string
DtVirtualMachineState
Required

Virtual Machine State

Possible values are : Success, Pending, Failed, Incomplete,
string
type
Optional

type

string
description
Optional

description

string
vmId
Optional

vmId

integer As int32 As int32
numCPUs
Optional

numCPUs

string
patternId
Optional

patternId

string
templateId
Optional

templateId

string
vmPath
Optional

vmPath

string
inventoryPath
Optional

inventoryPath

string
ipAddress
Optional

ipAddress

string
externalIpAddress
Optional

externalIpAddress

string
refId
Optional

refId

string
vmpowerState
Optional

vmpowerState

Possible values are : POWERED_ON, POWERED_OFF, SUSPENDED, POWER_STATE_POWERING_ON, POWER_STATE_POWERING_OFF, POWER_STATE_RESETTING, POWER_STATE_SUSPENDING,
string
vmlifeState
Optional

vmlifeState

Possible values are : CLONING, CLONE_FAILED, PREPARING, JOINING_DOMAIN, IN_DOMAIN, NOT_IN_DOMAIN, STARTING, READY, UNKNOWN, OFF, DESTROYING, INCOMPLETE,
string As date-time As date-time
vmlifeStateDate
Optional

vmlifeStateDate

boolean
threeDEnabled
Optional

threeDEnabled

boolean
hotplugEnabled
Optional

hotplugEnabled

string
vmhardwareVersion
Optional

vmhardwareVersion

string
networkId
Optional

networkId

string
daaSAgentVersion
Optional

daaSAgentVersion

string
daaSAgentState
Optional

daaSAgentState

Possible values are : ACTIVE, INACTIVE, UNKNOWN, NOT_PAIRED, DISABLED, DRAINING, DRAINING_UNTIL_RESTART,
string
vmwareToolsState
Optional

vmwareToolsState

Possible values are : UNKNOWN, NOT_RUNNING, OUT_OF_DATE, NOT_INSTALLED, OK,
string
guestOS
Optional

guestOS

Possible values are : LINUX_32, LINUX_64, OTHER, UBUNTU_32, UBUNTU_64, WIN_XP, WIN_VISTA, WIN_7, WIN_7_64, WIN_8, WIN_8_64, WIN_10, WIN_10_64, WIN_SERVER_2K8R2_64, WIN_SERVER_2K12_64, DAAS_APPLIANCE, WIN_SERVER_2K16_64, WIN_SERVER_2K19_64, WINDOWS, WIN_10_WVD_64,
string
computePoolId
Optional

computePoolId

integer As int32 As int32
memorySizeMB
Optional

memorySizeMB

integer As int64 As int64
goldPatternVersion
Optional

goldPatternVersion

string As date-time As date-time
powerOnDate
Optional

powerOnDate

string As date-time As date-time
sealDate
Optional

sealDate

string
poolName
Optional

poolName

string
macAddress
Optional

macAddress

string
desktopManagerName
Optional

desktopManagerName

string
viewAgentVersion
Optional

viewAgentVersion

string
dnsName
Optional

dnsName

boolean
viewAgentPaired
Optional

viewAgentPaired

boolean
agentPairingAcknowledged
Optional

agentPairingAcknowledged

string
allocateState
Optional

allocateState

string
resyncState
Optional

resyncState

string
customizationState
Optional

customizationState

string
agentErrorCode
Optional

agentErrorCode

string
sessionAllocationState
Optional

sessionAllocationState

boolean
rectify
Optional

rectify

string
name
Optional

name

string
id
Optional

id

array of DtLink
links
Optional

links


On This Page
Dt Pool Manager Operations
PUT
Assign User To Static Desktop Pattern
POST
Clear Machine Id For VM
POST
Convert To Gold Pattern
POST
Convert VM To Gold Pattern
POST
Convert Vm To Gold Pattern
GET
Create Agent Update Filter
POST
Create Application Session Pool
POST
Create Application Session Pool
POST
Create Desktop Pool
POST
Create Desktop Pool
GET
Create Pattern Filter
GET
Create Pool Filter
POST
Create Session Pool
POST
Create Session Pool
POST
Create User Defined App
GET
Create Virtual Machine Filter
POST
Delete User Defined App
GET
Find Applications
POST
Find Desktop Patterns
POST
Find Pools
POST
Find Virtual Machines
GET
Get Agent Update Config
GET
Get Available Agent Update Details
POST
Get Available Agent Update Details
GET
Get Available Agent Update On Pool
POST
Get Available Agent Updates On Pools
GET
Get Default Mapping Of Users
GET
Get Desktop Manager Id For Pool Id
GET
Get Desktop Pool Of Users
GET
Get Desktop Pools Of Groups
POST
Get Entitled User Count For Pools
GET
Get Gold Patterns
GET
Get Gold Patterns By Attrs
GET
Get Gold Patterns For Desktop Model
GET
Get Gold Patterns For Pool Type
GET
Get Occupancy For Pools
GET
Get Patterns
GET
Get Patterns Of Users
GET
Get Pool
GET
Get Pools
GET
Get Pools With Entitled User Counts
GET
Get Pool With Entitled User Count
GET
Get RDP
POST
Get Update Agent Status On Pool
POST
Get Update Agent Status On Pools
GET
Get Virtual Machine
GET
Get Virtual Machines
GET
Is GP Sync Enabled
GET
Last GP Conversion Error
GET
List Vms With Older Agents
POST
Migrate Desktop Patterns
POST
Migrate Patterns
POST
Migrate Pool Vms
PUT
Modify User Defined App
POST
Perform Pool Batch Power Operation
POST
Purge Recycle Pool
POST
Push Machine Id To VM
POST
Rebuild Dynamic Pool V Ms API
POST
Rectify Migrated Pool Vms
POST
Refresh Dynamic Pool
POST
Reserve Desktop Pattern
POST
Reset Agent Pairing State For Patterns
POST
Reset Agent Pairing State For Pool V Ms
POST
Reset Pairing State For VM
POST
Resync Pool
POST
Schedule Check Agent Updates Job
POST
Set Agent Update Cache Path
POST
Target Pools For Vm Migration
POST
Unreserve Pattern
POST
Update Agents On Pool
POST
Update Agents On Pool By Filter
PUT
Upload User Defined App Icon