Broker

PreviousDiagnostics NextEnrollment Server

Was this helpful?

Get Connection Broker

get

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

Query parameters

Serverstringoptional

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

SiteIdinteger · int32optional

Site ID from which to retrieve the specified Connection Broker information (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Agent/Diagnostic/Broker'

200

401

404

{
  "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": true,
  "ip": "text",
  "primaryServer": "text"
}

Success