unifi_* — UniFi (via SHTops cache)
The read-only UniFi tool namespace — sites, devices, hosts, health, WLANs, and networks served from the SHTops local and cloud caches, with the local-vs-cloud source split.
The unifi_* family reads UniFi network data from the caches on SHTops —
it does not talk to controllers live, and it’s read-only. For configuration
changes, use the UniFi controller directly. The defining concept is the
source split: data comes from a local controller
(unifi.super-ht.com), a cloud Site Manager API (customer Cloud Keys like
JElectric), or all (default).
unifi_get
Structured UniFi data by entity type.
unifi_get(entity_type, site=None, source="all")entity_type | Returns | Source |
|---|---|---|
sites | All sites with metadata | both |
devices | Device inventory | both |
hosts | UniFi consoles / network-servers | cloud only |
health | Health subsystem data per site | local only |
wlans | SSID / WLAN configs per site | local only |
networks | LAN / VLAN configs per site | local only |
site is an optional case-insensitive substring filter — matches site name,
site_id, or host name. Omit for all sites.
unifi_search
Free-text search across hosts, sites, and devices in both caches — names, models, IPs, MACs, locations.
unifi_search(query, source="all")This is the tool for “find this customer” when you don’t know whether they’re
on the hosted controller or their own Cloud Key. source narrows to local
or cloud when you do know.
unifi_status
Fleet rollup: cache freshness, site/device counts, and any sites with zero devices (a potential connectivity red flag).
unifi_status(source="all")source="local" covers unifi.super-ht.com only; source="cloud" covers the
Site Manager API hosts only.
Related pages
- SHTops — the host these caches live on
- shtops — operating the SHTops host itself
- Network Topology — where UniFi sits in the network