67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
# UniFi Network Monitoring
|
|
|
|
**Status:** 🔄 In Progress
|
|
**Location:** `~/.openclaw/workspace/skills/unifi/`
|
|
**Added:** 2026-02-27
|
|
|
|
## Overview
|
|
|
|
Network monitoring via UniFi Controller API. Read-only access to:
|
|
- Device status (APs, switches, USG)
|
|
- Connected clients
|
|
- Network health
|
|
- DPI traffic stats
|
|
- Alerts/alarms
|
|
|
|
## Hardware
|
|
|
|
- **Gateway:** UniFi USG
|
|
- **Controller:** Running on Home Assistant box (192.168.0.39:8123)
|
|
- **API URL:** `https://192.168.0.39:8443` (standard controller port)
|
|
|
|
## Setup Status
|
|
|
|
- [x] Skill files installed
|
|
- [ ] Credentials configured
|
|
- [ ] Connection tested
|
|
- [ ] Commands verified working
|
|
|
|
## Commands
|
|
|
|
| Script | Purpose |
|
|
|--------|---------|
|
|
| `bash scripts/devices.sh` | List UniFi devices |
|
|
| `bash scripts/clients.sh` | List connected clients |
|
|
| `bash scripts/health.sh` | Network health |
|
|
| `bash scripts/top-apps.sh` | Top bandwidth consumers |
|
|
| `bash scripts/alerts.sh` | Recent alarms |
|
|
| `bash scripts/dashboard.sh` | Full dashboard |
|
|
|
|
All support `json` argument for raw output.
|
|
|
|
## Configuration
|
|
|
|
File: `~/.clawdbot/credentials/unifi/config.json`
|
|
|
|
```json
|
|
{
|
|
"url": "https://192.168.0.39:8443",
|
|
"username": "admin",
|
|
"password": "YOUR_PASSWORD",
|
|
"site": "default"
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Requires local admin account (not UniFi SSO)
|
|
- Scripts use `curl -k` for self-signed controller certs
|
|
- DPI must be enabled in UniFi for bandwidth stats
|
|
- Read-only API access (safe for monitoring)
|
|
|
|
## Related
|
|
|
|
- **Skill Docs:** `skills/unifi/README.md`
|
|
- **API Reference:** `skills/unifi/references/unifi-readonly-endpoints.md`
|
|
- **Source:** OpenClaw official skills repo
|