Unifi Networks
@dmc/unifi-networksv2026.07.07.1
01README
Query UniFi Network sites via the official integration API — VLANs, firewall zones/policies, connected clients, and WiFi SSIDs, all mapped together — with firewall-summary and zone-matrix reports. Supports local (per-console key) and cloud (unifi.ui.com key, multi-console fan-out) modes.
02Models
@dmc/unifi-networksv2026.07.07.1unifi_networks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| mode | enum | Connection mode. Determines which API key you must create: |
| apiKey | string | UniFi API key matching the chosen mode |
| host? | string | Console hostname or IP — required when mode='local' (e.g. 192.168.1.1) |
| consoleId? | string | Cloud console ID to target. When mode='cloud' and omitted, all consoles |
| verifyTls | boolean | Verify the console's TLS certificate in local mode. Set false for the |
fn consoles()
List UniFi consoles visible to the cloud API key (cloud mode only).
fn scan()
Fetch all networks/VLANs. Local mode scans the configured host; cloud
fn scanFirewall()
Fetch firewall zones and policies per site, joined so policies show
fn scanWifi()
Fetch WiFi broadcasts (SSIDs) per site and map each to its VLAN via
fn scanClients()
Fetch connected clients per site and map each to its VLAN/network by
fn deletePolicy(siteId: string, policyId: string, consoleId?: string)
Delete a single user-defined firewall policy by ID. Verifies the
| Argument | Type | Description |
|---|---|---|
| siteId | string | Site ID containing the policy |
| policyId | string | Firewall policy ID to delete |
| consoleId? | string | Console to target when the key sees more than one |
Resources
consoles(infinite)— UniFi consoles visible to the cloud API key
siteNetworks(infinite)— Networks (VLANs) per UniFi site
siteFirewall(infinite)— Firewall zones and policies per UniFi site
siteClients(infinite)— Connected clients per UniFi site, mapped to VLAN by IP subnet
siteWifi(infinite)— WiFi broadcasts (SSIDs) per UniFi site, mapped to VLAN by network
03Reports
@dmc/unifi-firewall-summarymethod
unifi_firewall_summary.ts
Zone inventory and a detailed firewall policy table (flow, action,
networkingunififirewallsecurity
@dmc/unifi-zone-matrixmethod
unifi_zone_matrix.ts
Source→destination firewall posture between zones (from catch-all
networkingunififirewallsecurity
04Stats
A
100 / 100
Downloads
4
Archive size
25.7 KB
- 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels