UniFi: List Devices
unifi_list_devicesRead-only
List UniFi devices adopted by a site with their state, model, IP, MAC, and firmware. Filter by firmwareUpdatable to find devices needing upgrades or state to identify offline devices.
Instructions
List the UniFi devices adopted by a site — access points, switches, gateways — with their state, model, IP, MAC and firmware. Use firmwareUpdatable: true to find what needs upgrading, or state: "OFFLINE" to find what is down. The nested features and interfaces blocks are omitted here; unifi_get_device returns the complete object for one device.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Match the device name, with `*` as a wildcard — e.g. "*garage*". | |
| site | No | Which site to act on. Accepts the site UUID, its `internalReference` (the legacy 8-character name, usually "default") or its display name ("Default") — all three are resolved for you, so a guess costs nothing. Defaults to UNIFI_SITE, or to the only site when this console has just one. `unifi_list_sites` shows all three for every site. | |
| limit | No | Maximum items to return (1-200; the console rejects more). Defaults to UNIFI_PAGE_LIMIT (50). Prefer narrowing with `filter` over raising this — the console filters server-side, so a filtered request is both smaller and faster than a large page read here. | |
| state | No | Only devices in this state. | |
| filter | No | Raw server-side filter expression, applied by the console before it answers — much cheaper than fetching pages and filtering here. Syntax: `property.function(value)`, combined with `and(...)`, `or(...)` and `not(...)`. Strings take single quotes (double an embedded quote to escape it); `*` is the wildcard in `like`. Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull, contains, containsAny, containsAll. Examples: `state.eq('OFFLINE')`, `firmwareUpdatable.eq(true)`, `and(type.eq('WIRED'),name.like('*lab*'))`. The structured arguments on this tool build the common expressions for you — use this only for what they cannot express, and do not pass both. | |
| firmwareUpdatable | No | True to list only devices with a firmware update available. |