Guest

Get Guest

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

GET/api/Agent/Diagnostic/Guest

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

Response

Success

Body

servernullable string

Server name.

agentDiagnosticTypeRASAgentDiagnosticType (enum)

RAS Agent Diagnostic Type

1 = RDS,2 = Provider,3 = Gateway,4 = Guest,7 = Broker,25 = HALBDevice,46 = EnrollmentServer

agentVersionnullable string

Agent Version.

osVersionnullable string

Operating System Version.

stateDiagnosticState (enum)

Diagnostic State Diagnostic 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

dhcpboolean

Whether DHCP is enabled or not.

protocolVersioninteger (int32)

Protocol Version.

rdshModeboolean

Whether RDSH Mode is enabled or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

Request

Response

Get Guest

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

GET/api/Agent/Diagnostic/Guest

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

Response

Success

Body

servernullable string

Server name.

agentDiagnosticTypeRASAgentDiagnosticType (enum)

RAS Agent Diagnostic Type

1 = RDS,2 = Provider,3 = Gateway,4 = Guest,7 = Broker,25 = HALBDevice,46 = EnrollmentServer

agentVersionnullable string

Agent Version.

osVersionnullable string

Operating System Version.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

dhcpboolean

Whether DHCP is enabled or not.

protocolVersioninteger (int32)

Protocol Version.

rdshModeboolean

Whether RDSH Mode is enabled or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

Request

Response

const response = await fetch('/api/Agent/Diagnostic/Guest', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "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": false,
  "rdshMode": false,
  "terminalServicesInstalled": false
}