HALB Device

Get HALB Device

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

GET/api/Agent/Diagnostic/HALBDevice

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.

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

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

JavaScriptCurlPython

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