Broker

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

200

Success

application/json; api-version=1.0

Broker 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

Broker Agent State Broker Agent State

Possible values:

canTakeoverbooleanOptional

Whether the Broker can be taken over or not.

ipstring · nullableOptional

Broker IP.

primaryServerstring · nullableOptional

Primary Server.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Agent/Diagnostic/Broker

HTTPcURLJavaScriptPython

GET /api/Agent/Diagnostic/Broker 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 = 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"
}