RDS

Get RDS

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

GET/api/Agent/Diagnostic/RDS

Query parameters

Serverstring

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 (int32)

Site ID from which to retrieve the specified RD Session Host 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.

deInstalledboolean

Whether Desktop Experience is installed or not.

wiaServiceEnabledboolean

Whether the WIA Service is enabled or not.

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

connectedBrokerIPnullable string

Connected Broker IP.

logonStatusLogonStatus (enum)

Logon Status Logon Status

0 = Disabled,1 = Enabled,2 = DrainUntilReboot,3 = Drain

pendingRebootboolean

Whether the RDS is pending reboot or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

terminalServicesPortinteger (int32)

Terminal Services port.

updStatusUPDStatus (enum)

UPD Status UPD Status

0 = Disabled,1 = Enabled,2 = NotSupported,3 = Unknown

versioninteger (int32)

Version.

Request

Response

Get RDS

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

GET/api/Agent/Diagnostic/RDS

Query parameters

Serverstring

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 (int32)

Site ID from which to retrieve the specified RD Session Host 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.

deInstalledboolean

Whether Desktop Experience is installed or not.

wiaServiceEnabledboolean

Whether the WIA Service is enabled or not.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

connectedBrokerIPnullable string

Connected Broker IP.

logonStatusLogonStatus (enum)

Logon Status Logon Status

0 = Disabled,1 = Enabled,2 = DrainUntilReboot,3 = Drain

pendingRebootboolean

Whether the RDS is pending reboot or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

terminalServicesPortinteger (int32)

Terminal Services port.

updStatusUPDStatus (enum)

UPD Status UPD Status

0 = Disabled,1 = Enabled,2 = NotSupported,3 = Unknown

versioninteger (int32)

Version.

Request

Response

const response = await fetch('/api/Agent/Diagnostic/RDS', {
    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",
  "deInstalled": false,
  "wiaServiceEnabled": false,
  "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": false,
  "terminalServicesInstalled": false,
  "updStatus": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = NotSupported",
    "3 = Unknown"
  ]
}