get_console_info
get_console_info
Section titled “get_console_info”Show UniFi OS console identity and connectivity, independent of Network.
Answers from the UniFi OS layer, so it keeps working while the UniFi Network application is down. Useful for confirming the box itself is alive, which model it is, and whether it still has internet and cloud connectivity.
Side effects: None (read-only).
Returns model (hardware short name), name, mac,
device_state, device_error_code, has_internet,
cloud_connected, remote_access_enabled, sso_enabled, and
installed_apps (application inventory reported by the console).
This firmware’s UniFi OS API exposes no CPU, memory, or disk metrics — those fields are absent by design here rather than fabricated. Read storage from the console UI if you need it.
Example
Section titled “Example”get_console_info(controller="default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |