RDS

Get RDS

get

Retrieves the agent diagnostic information about an installed RAS RD Session Host Agent.

Query parameters
ServerstringOptional

The name of server from which to retrieve RD Session Host Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified RD Session Host Agent information (optional).

Responses
200
Success
application/json; api-version=1.0
get
GET /api/Agent/Diagnostic/RDS HTTP/1.1
Host: 
Accept: */*
{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "deInstalled": true,
  "wiaServiceEnabled": true,
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "connectedBrokerIP": "text",
  "logonStatus": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = DrainUntilReboot",
    "3 = Drain"
  ],
  "pendingReboot": true,
  "terminalServicesInstalled": true,
  "terminalServicesPort": 1,
  "updStatus": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = NotSupported",
    "3 = Unknown"
  ],
  "version": 1
}

Was this helpful?