📦 UniFi Advisor — UniFi 顾问
v1.0.1只读的 UniFi 网络顾问,涵盖 Site Manager 云 API 和 Network Integration API。查询设备、客户端、网络、防火墙区域和策略...
运行时依赖
安装命令
点击复制技能文档
UniFi 网络顾问 只读技能,涵盖两个官方 UniFi API 接口。所有操作都是 GET-only —— 没有写操作,没有任何修改。
API 接口 所有请求都通过 https://api.ui.com 发送。无需直接本地连接。
接口前缀 通过 Env vars 需要的 SM Site Manager api.ui.com/v1/... UNIFI_API_KEY NET Network Integration api.ui.com/v1/connector/consoles/{hostId}/proxy/network/integration/v1/... UNIFI_API_KEY (主机/站点自动解析)
如何调用脚本 python3 {baseDir}/scripts/unifi.py <子命令> [--site SITE] [--id ID] [--limit N] [--next-token TOKEN] [子命令特定标志]
一些子命令需要额外的标志 —— 参见下表。使用 python3 {baseDir}/scripts/unifi.py list 查看所有子命令及其描述。
子命令 Site Manager (SM) —— 云,单个 API 密钥 子命令 端点 需要的标志 描述 hosts GET /v1/hosts —— 所有 UniFi OS 控制台 host GET /v1/hosts/{id} --id 控制台详细信息 sites GET /v1/sites —— 所有站点 cloud-devices GET /v1/devices —— 所有设备 isp-metrics GET /ea/isp-metrics/{type} —— ISP 性能指标 sdwan GET /v1/sd-wan-configs —— SD-WAN 配置 sdwan-config GET /v1/sd-wan-configs/{id} --id 特定 SD-WAN 配置 sdwan-status GET /v1/sd-wan-configs/{id}/status --id SD-WAN 部署状态
Network Integration (NET) —— 通过 api.ui.com 代理,站点自动解析 子命令 端点 需要的标志 描述 info GET /v1/info —— 控制器版本和功能 net-sites GET /v1/sites —— 由此控制台管理的站点 devices GET /v1/sites/{siteId}/devices —— 采用设备概述 device GET /v1/sites/{siteId}/devices/{id} --id 设备详细信息 device-stats GET /v1/sites/{siteId}/devices/{id}/statistics/latest --id 最新设备统计数据 devices-pending GET /v1/pending-devices —— 等待采用设备(控制台范围) clients GET /v1/sites/{siteId}/clients —— 连接客户端概述 client GET /v1/sites/{siteId}/clients/{id} --id 客户端详细信息 networks GET /v1/sites/{siteId}/networks —— 网络概述 network GET /v1/sites/{siteId}/networks/{id} --id 网络详细信息 network-refs GET /v1/sites/{siteId}/networks/{id}/references --id 引用特定网络(设备,客户端,WiFi) wifi GET /v1/sites/{siteId}/wifi/broadcasts —— WiFi 广播(SSID)概述 wifi-details GET /v1/sites/{siteId}/wifi/broadcasts/{id} --id WiFi 广播详细信息 firewall-zones GET /v1/sites/{siteId}/firewall/zones —— 防火墙区域 firewall-zone GET /v1/sites/{siteId}/firewall/zones/{id} --id 防火墙区域详细信息 firewall-policies GET /v1/sites/{siteId}/firewall/policies —— 防火墙策略 firewall-policy GET /v1/sites/{siteId}/firewall/policies/{id} --id 防火墙策略详细信息 firewall-ordering GET /v1/sites/{siteId}/firewall/policies/ordering --from-zone --to-zone 两个区域之间的策略顺序 acl-rules GET /v1/sites/{siteId}/acl-rules —— ACL 规则 acl-rule GET /v1/sites/{siteId}/acl-rules/{id} --id ACL 规则详细信息 acl-ordering GET /v1/sites/{siteId}/acl-rules/ordering —— ACL 规则顺序 dns-policies GET /v1/sites/{siteId}/dns/policies —— DNS 策略 dns-policy GET /v1/sites/{siteId}/dns/policies/{id} --id DNS 策略详细信息 traffic-lists GET /v1/sites/{siteId}/traffic-matching-lists —— 流量匹配列表 traffic-list GET /v1/sites/{siteId}/traffic-matching-lists/{id} --id 流量匹配列表详细信息 vouchers GET /v1/sites/{siteId}/hotspot/vouchers —— 热点凭证 voucher GET /v1/sites/{siteId}/hotspot/vouchers/{id} --id 凭证详细信息 wans GET /v1/sites/{siteId}/wans —— WAN 接口概述 vpn-tunnels GET /v1/sites/{siteId}/vpn/site-to-site-tunnels —— 站点间 VPN 隧道 vpn-servers GET /v1/sites/{siteId}/vpn/servers —— VPN 服务器配置 radius GET /v1/sites/{siteId}/radius/profiles —— RADIUS 配置 device-tags GET /v1/sites/{siteId}/device-tags —— 设备标签 dpi-categories GET /v1/dpi/categories —— DPI 应用类别 dpi-applications GET /v1/dpi/applications —— DPI 应用 countries GET /v1/countries —— 国家列表(用于地理 IP 规则)
示例 # 列出所有站点并选择一个 python3 {baseDir}/scripts/unifi.py library # firewall-ordering:首先获取区域 ID,然后查询两个区域之间的顺序 # --from-zone 和 --to-zone 必须是来自 firewall-zones 输出的真实 UUID python3 {baseDir}/scripts/unifi.py firewall-zones --site hq python3 {baseDir}/scripts/unifi.py firewall-ordering --site hq --from-zone --to-zone # network-refs:首先获取网络列表,然后查询特定网络的引用 python3 {baseDir}/scripts/unifi.py networks --site hq python3 {baseDir}/scripts/unifi.py network-refs --site hq --id # sdwan-config / sdwan-status:首先列出配置以获取 ID python3 {baseDir}/scripts/unifi.py sdwan python3 {baseDir}/scripts/unifi.py sdwan-config --id python3 {baseDir}/scripts/unifi.py sdwan-status --id