Provider

Get Provider

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

GET/api/Agent/Diagnostic/Provider

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.

stateProviderDiagnosticState (enum)

Provider Agent Diagnostic State Provider Agent Diagnostic State

0 = StartCheck,1 = NotVerified,2 = Pending,3 = Error,4 = OK,5 = NeedsUpdate,6 = CheckCredentials,7 = InvalidCredentials,8 = CannotConnectToVDIAgent,11 = UnsupportedVDI,12 = VDITypeCheck,16 = FreeESXLicenseNotSupported,17 = ManagedESXNotSupported,20 = StartCheckUDP,22 = InvalidProviderVersion,25 = SettingsNotApplied,26 = InvalidVDIType,27 = UnsupportedOS

connectedBrokerIPnullable string

Connected Broker IP.

providerPortinteger (int32)

Provider port.

versioninteger (int32)

Version.

Request

JavaScriptCurlPython

const response = await fetch('/api/Agent/Diagnostic/Provider', {
    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 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = CheckCredentials",
    "7 = InvalidCredentials",
    "8 = CannotConnectToVDIAgent",
    "11 = UnsupportedVDI",
    "12 = VDITypeCheck",
    "16 = FreeESXLicenseNotSupported",
    "17 = ManagedESXNotSupported",
    "20 = StartCheckUDP",
    "22 = InvalidProviderVersion",
    "25 = SettingsNotApplied",
    "26 = InvalidVDIType",
    "27 = UnsupportedOS"
  ],
  "connectedBrokerIP": "text"
}