Get
Request
URI
GET
https://{api_host}/dt-rest/v100/infrastructure/vm/{id}
COPY
Path Parameters
string
id
Required
id
Query Parameters
boolean
returnsessiondetails
Optional
returnsessiondetails
Responses
200
successful operation
Returns DtActiveSession of type(s) */*
{
"vmId": "string",
"patternId": "string",
"vmName": "string",
"lastActiveTime": "string",
"connectionType": "string",
"userSid": "string",
"duration": 0,
"gatewayName": "string",
"gatewayIpAddress": "string",
"firstConnectTime": "string",
"lastConnectTime": "string",
"lastDisconnectTime": "string",
"idleDuration": 0,
"launchedApplications": [
{
"description": "string",
"status": "string",
"applicationId": "string",
"processId": 0,
"name": "string"
}
],
"historicalPerformanceMetrics": [
{
"diskIops": 0,
"hostCpuPercentage": "number",
"hostMemoryPercentage": "number",
"sessionCpuPercentage": "number",
"sessionMemoryPercentage": "number",
"sessionLatencyInMs": 0,
"diskLatencyInMs": 0,
"diskReadIops": 0,
"diskWriteIops": 0,
"collectionTime": "string"
}
],
"s4BPairingMode": {
"skypeForBusinessPairingMode": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"horizonClientInfo": {
"version": "string",
"type": "string",
"ipAddress": "string",
"domainName": "string",
"macAddress": "string",
"machineName": "string",
"remoteIpAddress": "string",
"loggedOnDomainName": "string",
"loggedOnUserName": "string",
"brokerDnsName": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"logonTiming": {
"duration": 0,
"start": 0,
"end": 0,
"unaccounted": 0,
"unadjustedStart": 0,
"unadjustedEnd": 0,
"unadjustedDuration": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"base64Id": "string",
"loginStatus": "string",
"loginTime": "string",
"helpdeskEnabledInDesktop": false,
"processes": [
{
"username": "string",
"processId": 0,
"diskIOBytes": 0,
"createdTime": "string",
"cpuPercentage": 0,
"memoryBytes": 0,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"displayProtocolPerformanceData": {
"blastPerformanceData": {
"estimatedFPS": 0,
"estimatedThroughput": 0,
"estimatedRTT": 0,
"estimatedBandwidth": 0,
"blastSessionStatistics": {
"roundTripTime": 0,
"bandwidthUplink": 0,
"packetLossUplink": 0,
"bytesTransmitted": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"blastImagingStatistics": {
"framesPerSecond": 0,
"bytesTransmitted": 0,
"bytesReceived": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"blastAudioStatistics": {
"bytesTransmitted": 0,
"bytesReceived": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"blastCDRStatistics": {
"bytesTransmitted": 0,
"bytesReceived": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"pcoipPerformanceData": {
"pcoipGeneralStatistics": {
"bytesReceived": 0,
"durationSeconds": 0,
"packetsSent": 0,
"bytesSent": 0,
"packetsReceived": 0,
"rxPacketsLost": 0,
"txPacketsLost": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"pcoipNetworkStatistics": {
"txBandwidthActiveLimit": 0,
"rxBandwidth": 0,
"rxPacketLoss": 0,
"roundTripLatency": 0,
"rxBandwidthPeak": 0,
"txBandwidth": 0,
"txBandwidthLimit": 0,
"txPacketLoss": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"pcoipUsbStatistics": {
"bytesReceived": 0,
"rxBandwidth": 0,
"bytesSent": 0,
"txBandwidth": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"pcoipAudioStatistics": {
"bytesReceived": 0,
"rxBandwidth": 0,
"bytesSent": 0,
"txBandwidth": 0,
"txBandwidthLimit": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"pcoipImagingStatistics": {
"bytesReceived": 0,
"rxBandwidth": 0,
"bytesSent": 0,
"txBandwidth": 0,
"activeMinimumQuality": 0,
"decoderCapability": 0,
"encodedFrames": 0,
"megapixel": 0,
"svgaDevTapFrames": 0,
"negativeAcknowledgements": 0,
"apex2800Offload": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"userName": "string",
"elementId": "string",
"userId": "string",
"domain": "string",
"poolType": "string",
"gatewayLocation": "string",
"clientBuild": "string",
"userAgentOrHostOsName": "string",
"protocol": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}string
vmId
Optional
vmId
string
patternId
Optional
patternId
string
vmName
Optional
vmName
string As date-time As date-time
lastActiveTime
Optional
lastActiveTime
string
connectionType
Optional
connectionType
string
userSid
Optional
userSid
integer As int64 As int64
duration
Optional
duration
string
gatewayName
Optional
gatewayName
string
gatewayIpAddress
Optional
gatewayIpAddress
string As date-time As date-time
firstConnectTime
Optional
firstConnectTime
string As date-time As date-time
lastConnectTime
Optional
lastConnectTime
string As date-time As date-time
lastDisconnectTime
Optional
lastDisconnectTime
integer As int32 As int32
idleDuration
Optional
idleDuration
string
base64Id
Optional
base64Id
string
loginStatus
Optional
loginStatus
string As date-time As date-time
loginTime
Optional
loginTime
boolean
helpdeskEnabledInDesktop
Optional
helpdeskEnabledInDesktop
displayProtocolPerformanceData
Optional
displayProtocolPerformanceData
string
userName
Optional
userName
string
elementId
Optional
elementId
string
userId
Optional
userId
string
domain
Optional
domain
string
poolType
Optional
poolType
string
gatewayLocation
Optional
gatewayLocation
string
clientBuild
Optional
clientBuild
string
userAgentOrHostOsName
Optional
userAgentOrHostOsName
string
protocol
Optional
protocol
string
id
Optional
id
Dt Virtual Machine Operations
DELETE
Delete
GET
Get
GET
Get GP Name
POST
Perform Operation
POST
Update