Guest

Get Guest

get

Retrieves the agent diagnostic information about an installed RAS Guest Agent.

Query parameters

ServerstringOptional

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

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Guest Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

Guest Agent Diagnostic

serverstring · nullableOptional

Server name.

agentDiagnosticTypestring · enumOptional

RAS Agent Diagnostic Type

Possible values:

agentVersionstring · nullableOptional

Agent Version.

osVersionstring · nullableOptional

Operating System Version.

statestring · enumOptional

Diagnostic State Diagnostic State

Possible values:

dhcpbooleanOptional

Whether DHCP is enabled or not.

protocolVersioninteger · int32Optional

Protocol Version.

rdshModebooleanOptional

Whether RDSH Mode is enabled or not.

terminalServicesInstalledbooleanOptional

Whether Terminal Services are installed or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Agent/Diagnostic/Guest

HTTPcURLJavaScriptPython

GET /api/Agent/Diagnostic/Guest HTTP/1.1
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "96 = AVDTemplateVersion"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "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"
  ],
  "dhcp": true,
  "protocolVersion": 1,
  "rdshMode": true,
  "terminalServicesInstalled": true
}