Broker

Get Connection Broker

Retrieves the agent diagnostic information about an installed RAS Connection Broker.

GET/api/Agent/Diagnostic/Broker

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

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.

stateBrokerDiagnosticState (enum)

Broker Agent State Broker Agent State

0 = Connecting,1 = Verified,2 = NotVerified,4 = InUse,5 = CannotBeUsed,6 = NeedUpdate,8 = Disabled,9 = NotFound,10 = Standby,11 = OSNotSupported

canTakeoverboolean

Whether the Broker can be taken over or not.

ipnullable string

Broker IP.

primaryServernullable string

Primary Server.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = Connecting",
    "1 = Verified",
    "2 = NotVerified",
    "4 = InUse",
    "5 = CannotBeUsed",
    "6 = NeedUpdate",
    "8 = Disabled",
    "9 = NotFound",
    "10 = Standby",
    "11 = OSNotSupported"
  ],
  "canTakeover": false,
  "ip": "text",
  "primaryServer": "text"
}