HALB Device

Get HALB Device

get

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

Query parameters

ServerstringOptional

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 · int32Optional

Site ID from which to retrieve the specified HALB Device Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

HALB Device Agent Status

serverstring · nullableOptional

Server name.

agentDiagnosticTypestring · enumOptional

RAS Agent Diagnostic Type

Possible values:

agentVersionstring · nullableOptional

Agent Version.

osVersionstring · nullableOptional

Operating System Version.

statestring · enumOptional

Diagnostic State Diagnostic State

Possible values:

initializedbooleanOptional

Whether the HALB Device is initialized or not.

ipAddressstring · nullableOptional

IP Address.

loggingbooleanOptional

Whether Logging is enabled or not.

macAddressstring · nullableOptional

MACAddress.

supportedbooleanOptional

Whether the HALB Device is supported or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Agent/Diagnostic/HALBDevice

HTTPcURLJavaScriptPython

GET /api/Agent/Diagnostic/HALBDevice HTTP/1.1
Accept: */*

{
  "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": true,
  "ipAddress": "text",
  "logging": true,
  "macAddress": "text",
  "supported": true
}