get_console_health

get_console_health

Diagnose the gateway’s two layers separately: UniFi OS and Network.

Start here when anything UniFi-related is failing. Every other tool in this server talks to the UniFi Network application; this one also checks the UniFi OS console underneath it, so it can tell you whether the box is down, the application is down, or your credentials are wrong — three very different problems that otherwise look identical.

Side effects: None (read-only, two GET probes).

Returns a record with:

• state: one of healthy, network_app_starting, network_app_down, credentials_invalid, console_unreachable, unknown.
• unifi_os / network_app: per-layer status words.
• summary: plain-language explanation of what is wrong.
• next_step: the recommended action, or null when healthy.
• checks: the raw probe results (path + HTTP status) behind the verdict, so the reasoning is auditable.
• network_app_version: the Network app version, when it reported one.

Note on the network_app_down verdict: UniFi OS handles routing, so the Network application being down does not mean the internet is down. It means configuration and monitoring are unavailable.

Example

get_console_health(controller="default")

Parameters

Parameter	Type	Required	Default	Description
controller	string	no	“default”	Name of the UniFi controller to target. Defaults to "default".