1 of 10

Agents

Logs

Diagnostics

Broker

Enrollment Server

Gateway

Guest

HALB Device

Provider

RDS

Logs

Get

Retrieve RAS Agent Log(s).

GET/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server.

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Response

Success

Request

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

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Update

Update RAS Agent Log level.

PUT/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Body

RAS Agent Log Level

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

logLevel*RASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

durationInSecinteger (int32)

RAS Log Level Duration The duration before the log level is reset back to Standard level (in seconds). Only applies for 'Extended' and 'Verbose' levels (Default: 43200 (12 hours), Max: 259200 (72 hours), Never: 0).

Response

No Content

Request

const response = await fetch('/api/Agent/logs', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "logLevel": [
        "0 = Critical",
        "1 = Error",
        "2 = Warning",
        "3 = Standard",
        "4 = Extended",
        "5 = Verbose",
        "-1 = None"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Clear RAS Agent Log(s).

DELETE/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Body

RAS Agent server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

Response

No Content

Request

const response = await fetch('/api/Agent/logs', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Broker

Get Connection Broker

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

GET/api/Agent/Diagnostic/Broker

Query parameters

Serverstring

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

SiteIdinteger (int32)

Site ID from which to retrieve the specified Connection Broker 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.

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

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

Response

{
  "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"
}

Gateway

Get Gateway

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

GET/api/Agent/Diagnostic/Gateway

Query parameters

Serverstring

The name of server from which to retrieve RAS Secure Gateway Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified RAS SecureGateway 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.

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

extendedInfonullable string

Extended info.

fipsModeFIPSMode (enum)

FIPS Mode FIPS Mode

0 = Disabled,1 = Enabled,2 = Failed,3 = Unsupported

iPsnullable array of string

Gateway IP List.

itemsstring

Request

Response

Provider

Get Provider

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

GET/api/Agent/Diagnostic/Provider

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

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

Response

Enrollment Server

Get Enrollment Server

Retrieves the agent diagnostic information about an installed RAS Enrollment Server Agent.

GET/api/Agent/Diagnostic/EnrollmentServer

Query parameters

Serverstring

The name of server from which to retrieve Enrollment Server Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified Enrollment Server 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.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

connectedBrokerIPnullable string

Connected Broker IP.

versioninteger (int32)

Version.

Request

Response

HALB Device

Get HALB Device

Retrieves the agent diagnostic information about an installed RAS HALB Device Agent.

GET/api/Agent/Diagnostic/HALBDevice

Query parameters

Serverstring

The name of server from which to retrieve HALB Device Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified HALB Device 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.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

initializedboolean

Whether the HALB Device is initialized or not.

ipAddressnullable string

IP Address.

loggingboolean

Whether Logging is enabled or not.

macAddressnullable string

MACAddress.

supportedboolean

Whether the HALB Device is supported or not.

Request

Response

Get

Retrieve RAS Agent Log(s).

GET/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server.

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Response

Success

Request

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

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Clear RAS Agent Log(s).

DELETE/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Body

RAS Agent server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

Response

No Content

Request

const response = await fetch('/api/Agent/logs', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Update

Update RAS Agent Log level.

PUT/api/Agent/logs

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID of the specified server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

Body

RAS Agent Log Level

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

logLevel*RASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

durationInSecinteger (int32)

Response

No Content

Request

const response = await fetch('/api/Agent/logs', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "logLevel": [
        "0 = Critical",
        "1 = Error",
        "2 = Warning",
        "3 = Standard",
        "4 = Extended",
        "5 = Verbose",
        "-1 = None"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get Connection Broker

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

GET/api/Agent/Diagnostic/Broker

Query parameters

Serverstring

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

SiteIdinteger (int32)

Site ID from which to retrieve the specified Connection Broker 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.

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

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

Response

{
  "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"
}

Agents

List

Retrieve RAS Agent(s) information.

GET/api/Agent

Query parameters

siteIdinteger (int32)

Site ID for which to retrieve RAS Agent information.

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

serverTypeRASServerType (enum)

RAS Status Type

Request

Response

Update

Modify RAS Agent.

PUT/api/Agent

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID in which to modify the specified server.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation.

usernamestring

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstring

The password of the account specified in the Username parameter.

Body

RAS Agent server

server*nullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Response

No Content

Request

Response

Delete

Remove RAS Agent.

DELETE/api/Agent

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID from which to delete the specified server.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation.

usernamestring

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstring

The password of the account specified in the Username parameter.

Body

RAS Agent server

server*nullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Response

No Content

Request

Response

Get

Retrieve RAS Agent(s) information.

GET/api/Agent/{server}

Path parameters

server*string

RAS Agent Server name

Query parameters

siteIdinteger (int32)

Site ID for which to retrieve RAS Agent information.

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

Request

Response

Guest

Get Guest

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

GET/api/Agent/Diagnostic/Guest

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

dhcpboolean

Whether DHCP is enabled or not.

protocolVersioninteger (int32)

Protocol Version.

rdshModeboolean

Whether RDSH Mode is enabled or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

Request

Response

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

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

Update

Modify RAS Agent.

PUT/api/Agent

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID in which to modify the specified server.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation.

usernamestring

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstring

The password of the account specified in the Username parameter.

Body

RAS Agent server

server*nullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Response

No Content

Request

Response

Delete

Remove RAS Agent.

DELETE/api/Agent

Query parameters

serverstring

RAS Agent Server name

siteIdinteger (int32)

Site ID from which to delete the specified server.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation.

usernamestring

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstring

The password of the account specified in the Username parameter.

Body

RAS Agent server

server*nullable string

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forceboolean

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Response

No Content

Request

Response

List

Retrieve RAS Agent(s) information.

GET/api/Agent

Query parameters

siteIdinteger (int32)

Site ID for which to retrieve RAS Agent information.

serverTypeRASServerType (enum)

RAS Status Type

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

Request

Response

Get

Retrieve RAS Agent(s) information.

GET/api/Agent/{server}

Path parameters

server*string

RAS Agent Server name

Query parameters

siteIdinteger (int32)

Site ID for which to retrieve RAS Agent information.

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

Request

Response

Get Enrollment Server

Retrieves the agent diagnostic information about an installed RAS Enrollment Server Agent.

GET/api/Agent/Diagnostic/EnrollmentServer

Query parameters

Serverstring

The name of server from which to retrieve Enrollment Server Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified Enrollment Server 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.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

connectedBrokerIPnullable string

Connected Broker IP.

versioninteger (int32)

Version.

Request

Response

Get Provider

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

GET/api/Agent/Diagnostic/Provider

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

stateProviderDiagnosticState (enum)

Provider Agent Diagnostic State Provider Agent Diagnostic State

connectedBrokerIPnullable string

Connected Broker IP.

providerPortinteger (int32)

Provider port.

versioninteger (int32)

Version.

Request

Response

Get Guest

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

GET/api/Agent/Diagnostic/Guest

Query parameters

Serverstring

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

SiteIdinteger (int32)

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

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

dhcpboolean

Whether DHCP is enabled or not.

protocolVersioninteger (int32)

Protocol Version.

rdshModeboolean

Whether RDSH Mode is enabled or not.

terminalServicesInstalledboolean

Whether Terminal Services are installed or not.

Request

Response

Get HALB Device

Retrieves the agent diagnostic information about an installed RAS HALB Device Agent.

GET/api/Agent/Diagnostic/HALBDevice

Query parameters

Serverstring

The name of server from which to retrieve HALB Device Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified HALB Device 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.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

initializedboolean

Whether the HALB Device is initialized or not.

ipAddressnullable string

IP Address.

loggingboolean

Whether Logging is enabled or not.

macAddressnullable string

MACAddress.

supportedboolean

Whether the HALB Device is supported or not.

Request

Response

Get Gateway

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

GET/api/Agent/Diagnostic/Gateway

Query parameters

Serverstring

The name of server from which to retrieve RAS Secure Gateway Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger (int32)

Site ID from which to retrieve the specified RAS SecureGateway 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.

stateDiagnosticState (enum)

Diagnostic State Diagnostic State

extendedInfonullable string

Extended info.

fipsModeFIPSMode (enum)

FIPS Mode FIPS Mode

0 = Disabled,1 = Enabled,2 = Failed,3 = Unsupported

iPsnullable array of string

Gateway IP List.

itemsstring

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', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "server": "text"
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/Agent', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "server": "text"
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

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

[
  {
    "id": "text",
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ]
  }
]

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

[
  {
    "id": "text",
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ]
  }
]

const response = await fetch('/api/Agent/Diagnostic/EnrollmentServer', {
    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",
  "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"
}

const response = await fetch('/api/Agent/Diagnostic/Provider', {
    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",
  "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"
}

const response = await fetch('/api/Agent/Diagnostic/Guest', {
    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",
  "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"
  ],
  "dhcp": false,
  "rdshMode": false,
  "terminalServicesInstalled": false
}

const response = await fetch('/api/Agent/Diagnostic/HALBDevice', {
    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",
  "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"
  ],
  "initialized": false,
  "ipAddress": "text",
  "logging": false,
  "macAddress": "text",
  "supported": false
}

const response = await fetch('/api/Agent/Diagnostic/Gateway', {
    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",
  "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"
  ],
  "extendedInfo": "text",
  "fipsMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Failed",
    "3 = Unsupported"
  ],
  "iPs": [
    "text"
  ]
}

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"
  ]
}