360 Secure SkillHub
360 安全技能中心

Unifi

该技能通过本地UniFi OS网关API提供只读监控,核心功能包括查询设备状态、活跃客户端、网络健康概览、DPI流量洞察及近期告警。典型场景为用户询问UniFi网络设备、在线人员、健康状况、带宽占用或异常告警时触发。输入为自然语言指令或bash命令,支持可选`json`参数输出原始JSON,默认输出易读的表格/文本,所有操作仅用GET请求,安全无风险,需提前配置网关凭证。

jmagar
jmagar
热度 98.62
最近更新 2026-05-11 15:50:48
分类:数据依赖:代码执行 / 第三方 API / 读写文件应用场景:数据处理 / 报告撰写

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add unifi
Metadata
name
unifi
description
Query and monitor UniFi network via local gateway API (Cloud Gateway Max / UniFi OS). Use when the user asks to "check UniFi", "list UniFi devices", "show who's on the network", "UniFi clients", "UniFi health", "top apps", "network alerts", "UniFi DPI", or mentions UniFi monitoring/status/dashboard.
version
1.0.1
metadata
{"clawdbot":{"emoji":"📡","requires":{"bins":["curl","jq"]}}}

UniFi Network Monitoring Skill

Monitor and query your UniFi network via the local UniFi OS gateway API (tested on Cloud Gateway Max).

Purpose

This skill provides read-only access to your UniFi network's operational data:

  • Devices (APs, switches, gateway) status and health
  • Active clients (who's connected where)
  • Network health overview
  • Traffic insights (top applications via DPI)
  • Recent alarms and events

All operations are GET-only and safe for monitoring/reporting.

Setup

Create the credentials file: ~/.clawdbot/credentials/unifi/config.json

{
  "url": "https://10.1.0.1",
  "username": "api",
  "password": "YOUR_PASSWORD",
  "site": "default"
}
  • url: Your UniFi OS gateway IP/hostname (HTTPS)
  • username: Local UniFi OS admin username
  • password: Local UniFi OS admin password
  • site: Site name (usually default)

Commands

All commands support optional json argument for raw JSON output (default is human-readable table).

Network Dashboard

Comprehensive view of all network stats (Health, Devices, Clients, Networks, DPI, etc.):

bash scripts/dashboard.sh
bash scripts/dashboard.sh json  # Raw JSON for all sections

Output: Full ASCII dashboard with all metrics.

List Devices

Shows all UniFi devices (APs, switches, gateway):

bash scripts/devices.sh
bash scripts/devices.sh json  # Raw JSON

Output: Device name, model, IP, state, uptime, connected clients

List Active Clients

Shows who's currently connected:

bash scripts/clients.sh
bash scripts/clients.sh json  # Raw JSON

Output: Hostname, IP, MAC, AP, signal strength, RX/TX rates

Health Summary

Site-wide health status:

bash scripts/health.sh
bash scripts/health.sh json  # Raw JSON

Output: Subsystem status (WAN, LAN, WLAN), counts (up/adopted/disconnected)

Top Applications (DPI)

Top bandwidth consumers by application:

bash scripts/top-apps.sh
bash scripts/top-apps.sh 15  # Show top 15 (default: 10)

Output: App name, category, RX/TX/total traffic in GB

Recent Alerts

Recent alarms and events:

bash scripts/alerts.sh
bash scripts/alerts.sh 50  # Show last 50 (default: 20)

Output: Timestamp, alarm key, message, affected device

Workflow

When the user asks about UniFi:

  1. "What's on my network?" → Run bash scripts/devices.sh + bash scripts/clients.sh
  2. "Is everything healthy?" → Run bash scripts/health.sh
  3. "Any problems?" → Run bash scripts/alerts.sh
  4. "What's using bandwidth?" → Run bash scripts/top-apps.sh
  5. "Show me a dashboard" or general checkup → Run bash scripts/dashboard.sh

Always confirm the output looks reasonable before presenting it to the user (check for auth failures, empty data, etc.).

Notes

  • Requires network access to your UniFi gateway
  • Uses UniFi OS login + /proxy/network API path
  • All calls are read-only GET requests
  • Tested endpoints are documented in references/unifi-readonly-endpoints.md

Reference

  • Tested Endpoints — Full catalog of verified read-only API calls on your Cloud Gateway Max