Unifi
Manage a Ubiquiti UniFi Dream Machine (UDM / UDM Pro / UDM SE) via the legacy Network API: firewall groups, firewall rules, clients, client diagnostics, PoE device restarts, and networks. Complements @stack72/ubiquity (which focuses on traffic collection) by enabling configuration-as-data workflows: sync existing groups/rules into the swamp data model, reconcile group membership, create or delete firewall rules, toggle rule state, safely power-cycle a wired client's resolved switch port, and capture read-only client roaming snapshots.
| Argument | Type | Description |
|---|---|---|
| activeOnly? | boolean | If true, only fetch currently-connected clients (/stat/sta). |
| Argument | Type | Description |
|---|---|---|
| device | string | Exact UniFi client name, hostname, or MAC address, e.g. front-door-camera |
| expectedSwitch? | string | Optional safety assertion: expected switch name or MAC |
| expectedPort? | coerce.number | Optional safety assertion: expected physical switch port |
| Argument | Type | Description |
|---|---|---|
| mac? | string | Client MAC address, preferred. |
| ip? | string | Client IP address, used as fallback. |
Resources
| Argument | Type | Description |
|---|---|---|
| id? | string | Group _id (preferred) |
| name? | string | Group name (resolved if id is omitted) |
| members | array | Full replacement member list (MACs, IPs, CIDRs, or ports) |
Resources
| Argument | Type | Description |
|---|---|---|
| ruleset? | string | Filter by ruleset, e.g. LAN_IN, LAN_OUT, WAN_OUT, WAN_LOCAL |
| Argument | Type | Description |
|---|---|---|
| name | string | |
| ruleset | enum | |
| action | enum | |
| protocol? | string | |
| enabled? | boolean | |
| logging? | boolean | |
| rule_index? | number | |
| src_firewallgroup_ids? | array | |
| dst_firewallgroup_ids? | array | |
| src_address? | string | |
| dst_address? | string | |
| src_networkconf_id? | string | |
| dst_networkconf_id? | string | |
| src_port? | string | |
| dst_port? | string | |
| state_new? | boolean | |
| state_established? | boolean | |
| state_invalid? | boolean | |
| state_related? | boolean |
| Argument | Type | Description |
|---|---|---|
| id | string |
| Argument | Type | Description |
|---|---|---|
| id | string | |
| enabled | boolean |
Resources
Resources
Modified 3 behaviors
Add exact UniFi IDS/IPS event investigation across Network 10.x traffic flows and system logs plus the legacy IDS endpoint. Preserve matched raw records, paginate supported APIs, tolerate unsupported endpoints, and distinguish incomplete searches from definitive absence.
Modified 1 behaviors
Modified 1 behaviors
Add TOTP authentication support for MFA-enabled UniFi accounts.
Rebuild against swamp CLI 20260716
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned