Safe Tp Link Omada Mcp

Safe Omada MCP

专注安全的 MCP 服务，用于 TP-Link Omada Open API 工作流。

概览

• 适用于生产环境的安全基线使用 stdio
• Omada 凭据仅通过环境变量配置
• 通过能力配置文件和类别限制控制开放的工具
• HTTP 仅作为明确标注为不安全、仅供实验室使用的路径保留在代码库中
• 使用有文档记录的 Open API 路由；控制器和设备验证因操作而异（参见支持矩阵）

0.19 候选版本

此分支用于准备 0.19.0-rc.1。写入预览、精简发现、诊断和可靠性改进详见迁移指南。稳定版写入工具仍需等待在临时控制器和硬件上完成验证；latest 仍指向现有稳定版本。

快速开始

选项 1：通过 Docker 与 Claude Desktop 搭配使用

1. 拉取或构建镜像：

   docker pull ghcr.io/gaspareduard/omada-mcp:latest
   

   如果暂未发布镜像，请改为在本地构建：

   npm run docker:build
   

2. 编辑 Claude Desktop MCP 配置：

   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%\Claude\claude_desktop_config.json

3. 添加服务条目：

   {
     "mcpServers": {
       "safe-omada": {
         "command": "docker",
         "args": [
           "run",
           "-i",
           "--rm",
           "-e", "OMADA_BASE_URL=https://your-omada-controller.local",
           "-e", "OMADA_CLIENT_ID=your-client-id",
           "-e", "OMADA_CLIENT_SECRET=your-client-secret",
           "-e", "OMADA_OMADAC_ID=your-omadac-id",
           "-e", "OMADA_SITE_ID=your-site-id",
           "-e", "OMADA_STRICT_SSL=true",
           "ghcr.io/gaspareduard/omada-mcp:latest"
         ]
       }
     }
   }
   

4. 重启 Claude Desktop，并通过列出站点或设备来验证服务。

选项 2：直接运行容器

docker run --rm -it \
  --env-file .env \
  ghcr.io/gaspareduard/omada-mcp:latest

选项 3：在本地运行以进行开发

npm install
npm run build
npm start

配置

服务从环境变量中读取配置。完整参考请参见 .env.example。

必需的 Omada 变量

变量	必需	默认值	描述
OMADA_BASE_URL	是	-	Omada 控制器的基础 URL
OMADA_CLIENT_ID	是	-	来自 Omada Platform Integration 的 OAuth 客户端 ID
OMADA_CLIENT_SECRET	是	-	OAuth 客户端密钥
OMADA_OMADAC_ID	是	-	Omada 控制器 ID（omadacId）
OMADA_SITE_ID	否	-	可选的默认站点 ID。若未设置且工具级别未提供站点 ID，则自动选择唯一可用的站点；若没有或有多个站点，则返回错误。
OMADA_STRICT_SSL	否	true	强制验证 TLS 证书
OMADA_CA_FILE	否	-	PEM 私有 CA 证书包路径；保留主机名验证。在 Docker 中以只读方式挂载该文件。
OMADA_TIMEOUT	否	30000	HTTP 超时时间，单位为毫秒

能力与日志记录

变量	必需	默认值	描述
OMADA_CAPABILITY_PROFILE	否	safe-read	内置配置文件：safe-read、ops-write、admin、compatibility
OMADA_TOOL_CATEGORIES	否	配置文件默认值	显式类别覆盖；恢复操作需要 recovery:rw
OMADA_CATALOG_MODE	否	standard	使用 standard 工具或 compact 发现/分派模式
OMADA_INCLUDE_DEPRECATED	否	false	包含已弃用的别名
OMADA_ALLOW_TOOL_HEADERS	否	false	仅开放有限的 X-Request-ID / X-Correlation-ID 标头
MCP_SERVER_LOG_LEVEL	否	info	debug、info、warn、error
MCP_SERVER_LOG_FORMAT	否	plain	plain、json 或 gcp-json

能力配置

配置	适用场景
safe-read	默认的只读运维可见性
ops-write	客户端操作和维护写入，不包括恢复
admin	除恢复以外的所有已实现类别
compatibility	admin 的弃用别名；不回退到私有 API

OMADA_TOOL_CATEGORIES 会替换配置默认值。恢复工具需要显式设置 recovery:rw；admin、compatibility 和 all:rw 均不会授予恢复权限。

变更预览与恢复

写入操作默认启用 dryRun: true。检查预览后，显式传入 dryRun: false 以应用变更。submitted 表示控制器已接受请求；只有 verified 才表示读回结果匹配。有关验证限制和部分完成结果，请参阅0.19 迁移指南。

恢复工具还需要 confirmDangerous: true。这只是参数检查，并不代表已强制执行人工审批或有状态的二次调用协议。请在 MCP 宿主中配置审批，并且仅在确实需要恢复时授予 recovery:rw。

可选 HTTP 实验室模式

HTTP 不属于受支持的生产基线。

仅在同时设置以下两项时才会启动：

• MCP_SERVER_USE_HTTP=true
• MCP_UNSAFE_ENABLE_HTTP=true

仅用于本地实验室／调试场景。

变量	必需	默认值	描述
MCP_SERVER_USE_HTTP	否	false	仅限旧版实验室使用的开关
MCP_UNSAFE_ENABLE_HTTP	否	false	需要显式确认
MCP_HTTP_PORT	否	3000	HTTP 端口
MCP_HTTP_BIND_ADDR	否	127.0.0.1	仅限环回绑定地址（127.0.0.1 或 ::1）
MCP_HTTP_PATH	否	/mcp	MCP 端点路径
MCP_HTTP_ENABLE_HEALTHCHECK	否	true	启用健康检查
MCP_HTTP_HEALTHCHECK_PATH	否	/healthz	健康检查路径
MCP_HTTP_ALLOW_CORS	否	true	启用 CORS
MCP_HTTP_ALLOWED_ORIGINS	否	127.0.0.1, localhost	允许的来源
MCP_HTTP_NGROK_ENABLED	否	false	旧版占位项；在安全基线中已禁用
MCP_HTTP_NGROK_AUTH_TOKEN	否	-	旧版占位项

开发与验证

常用命令

任务	命令
运行开发服务器	npm run dev
构建	npm run build
代码检查 + 类型检查	npm run check
单元测试	npm test
覆盖率门槛检查	npm run test:coverage
符号链接完整性检查	npm run symlinks:check
README／工具同步检查	node scripts/check-readme-sync.mjs
工具／测试映射检查	node scripts/check-tool-tests.mjs

Inspector

需要交互式测试构建后的服务时，请使用 MCP Inspector：

npm run inspector
npm run inspector:build

项目说明

• 安全基线优先使用 stdio。
• HTTP 仍是旧版的、明确不安全的实验室路径。
• 仓库包含 docs/openapi/，作为 Omada 端点的实现参考。
• 下方的 README 工具表会与已注册的 MCP 工具保持同步。

工具

0.19 工作流与发现

工具	描述
getWifiHealthSummary	汇总仪表板、信道、干扰和重试证据，并附上时间戳、缺失部分和有界审查启发式。只读。
diagnoseLogs	读取近期事件、警报和审计页面，以及日志设置；区分数据不可用与结果为空，并报告历史记录不完整的情况。
diagnoseCameraConnectivity	定位摄像头客户端并读取其详情和会话证据；报告缺失数据和网络下钻信息，但不声称能够诊断 Frigate 推理。
setApRadio	预览或更新一个受支持的 AP 频段，验证公布的信道／带宽设置，保留同级设置，并进行有界回读验证。
updateSsid	预览或更新 SSID 名称、广播可见性、访客状态或共享策略，同时保留必需的安全字段。广播可见性并不等同于启用／禁用 SSID。
setSwitchPorts	预览或更新 1–32 个明确指定端口的名称、状态、PoE、配置文件或覆盖设置。检查端口是否存在，防止已知的 LAG 中断，并报告逐端口验证结果或部分完成情况。
searchOperations	仅按名称、描述或类别搜索已启用的操作。
describeOperation	返回已启用操作的准确参数架构和权限。
getServerCapabilities	报告版本、有效目录、配置文件和验证限制。
callOperation	仅限精简模式：通过现有架构和处理程序调用已启用的操作。

下方各类别默认处于折叠状态。点击展开即可查看完整工具列表，列表分为读取工具和写入工具。

---

站点与客户端

站点列表、客户端监控，以及客户端级别的运维控制（速率限制、封锁/解除封锁、重新连接）。

读取工具（14）

工具	描述
listSites	列出控制器上配置的所有站点。
getSiteCapacity	获取站点容量设置，包括设备和客户端的最大数量。
getSiteDetail	获取站点的详细信息，包括名称、区域、时区和配置。
getSiteDeviceAccount	获取站点的设备账户设置。
getSiteNtpStatus	获取站点的 NTP 服务状态和配置。
getSiteRememberSetting	获取站点的记住设备设置。
getSiteSpecification	获取站点规格，包括设备限制和功能能力。
getSiteUrl	获取与站点关联的 OpenAPI 访问 URL。
getSiteTemplateConfig	获取站点模板的配置设置。需要 siteTemplateId。
getSiteTemplateDetail	获取站点模板的详细信息。需要 siteTemplateId。
getSiteTemplateList	列出控制器上配置的所有站点模板。
listClients	列出站点上活跃的客户端设备。
getClient	[已弃用] 请改用 listClients。如果有客户端 MAC 地址，也可以使用 getClientDetail。此工具会在进程内筛选站点客户端列表。
listMostActiveClients	按流量使用量排序，获取最活跃的客户端。
listClientsActivity	获取一段时间内的客户端活动统计信息。
listClientsPastConnections	获取客户端过往的连接记录。

写入工具（5）

工具	描述
setClientRateLimit	为指定客户端设置自定义带宽限制（下载/上传）。
setClientRateLimitProfile	为指定客户端应用预定义的速率限制配置文件。
disableClientRateLimit	为指定客户端停用带宽速率限制。
blockClient	阻止客户端访问网络，并提供可审计的变更摘要。
unblockClient	恢复被封锁客户端的网络访问权限，并提供可审计的变更摘要。
reconnectClient	强制客户端重新连接，并提供可审计的变更摘要。

写入工具（设备级，2）

工具	描述
rebootDevice	重启受管理的设备，并提供可审计的变更摘要。
setDeviceLed	更改设备 LED 状态，并提供可审计的变更摘要。

---

设备

设备清单、单台设备详情（交换机、网关、AP）、固件、线缆测试和设备配置。

读取工具（62）

| 工具 | 描述 | |---|---| | `listDevices` | 列出指定站点已部署的设备。 | | `getDevice` | [已弃用] 请改用 `listDevices`，并在客户端筛选结果。此工具在进程内筛选站点设备列表；没有专用的设备详情端点。 | | `searchDevices` | 在用户有权访问的所有站点中全局搜索设备。 | | `listDevicesStats` | 分页查询并筛选全局已接入设备的统计信息。 | | `getSwitchStackDetail` | 获取交换机堆叠的详细配置和状态。 | | `getSwitchDetail` | 获取指定交换机的详细配置和状态。 | | `getGatewayDetail` | 获取指定网关的详细配置和状态。 | | `getGatewayWanStatus` | 获取指定网关的 WAN 端口状态。 | | `getGatewayLanStatus` | 获取指定网关的 LAN 端口状态。 | | `getGatewayPorts` | 获取指定网关的端口信息。 | | `getApDetail` | 获取指定接入点的详细配置和状态。 | | `getApRadios` | 获取指定接入点的无线电信息。 | | `getStackPorts` | 获取交换机堆叠的端口信息。 | | `listPendingDevices` | 列出站点中待接入的设备。 | | `getAllDeviceBySite` | 获取站点中的所有设备，包括离线和断开连接的设备。 | | `getFirmwareInfo` | 获取设备最新的可用固件信息。MAC 地址请使用 `listDevices` 获取。 | | `getGridAutoCheckUpgrade` | 获取自动检查固件升级计划列表（分页）。 | | `listSwitchNetworks` | 列出交换机的 VLAN 网络分配（分页）。需要 `switchMac`。 | | `getSwitchGeneralConfig` | 获取交换机的常规配置。需要 `switchMac`。 | | `getCableTestLogs` | 获取交换机的网线测试历史记录。需要 `switchMac`。 | | `getCableTestFullResults` | 获取交换机各端口的完整网线诊断结果。需要 `switchMac`。 | | `getOswStackLagList` | 获取交换机堆叠的链路聚合组（LAG）列表。需要 `stackId`。 | | `getStackNetworkList` | 获取交换机堆叠的 VLAN 网络列表（分页）。需要 `stackId`。 | | `getApUplinkConfig` | 获取 AP 的上行链路配置（有线／Mesh 模式）。需要 `apMac`。 | | `getRadiosConfig` | 获取 AP 各无线电的配置（信道、功率、带宽）。需要 `apMac`。 | | `getApVlanConfig` | 获取接入点的 VLAN 配置，包括管理 VLAN 和各 SSID 的 VLAN 标记设置。 | | `getMeshStatistics` | 获取 AP 的 Mesh 链路统计信息。需要 `apMac`。 | | `getRFScanResult` | 获取 AP 最近一次的 RF 扫描结果。需要 `apMac`。 | | `getSpeedTestResults` | 获取 AP 最近一次的速度测试结果。需要 `apMac`。 | | `getApSnmpConfig` | 获取 AP 的 SNMP 配置。需要 `apMac`。 | | `getApLldpConfig` | 获取 AP 的 LLDP 配置。需要 `apMac`。 | | `getApGeneralConfig` | 获取 AP 的常规配置（名称、LED、国家／地区）。需要 `apMac`。 | | `getUplinkWiredDetail` | 获取接入点的有线上行链路详情：上行交换机、端口号、链路速度和 PoE 状态。 | | `getDownlinkWiredDevices` | 获取 AP 的 LAN 端口上连接的有线下行设备。需要 `apMac`。 | | `getFirmwareUpgradePlan` | 获取控制器管理的设备的固件升级计划列表。 | | `getUpgradeLogs` | 获取固件升级日志，显示设备执行升级操作的历史记录。 | | `getDeviceTagList` | 获取站点中定义的设备标签列表。 | | `getApQosConfig` | 获取指定接入点的 QoS 配置。需要 `apMac`。 | | `getApIpv6Config` | 获取指定接入点的 IPv6 配置。需要 `apMac`。 | | `getSitesApsIpSetting` | 获取 AP 的 IP 设置。需要 `apMac`。 | | `getSitesApsChannelLimit` | 获取 AP 的信道限制配置。需要 `apMac`。 | | `getSitesApsAvailableChannel` | 获取 AP 的可用信道列表。需要 `apMac`。 | | `getSitesApsLoadBalance` | 获取 AP 的负载均衡配置。需要 `apMac`。 | | `getSitesApsOfdma` | 获取 AP 的 OFDMA 配置。需要 `apMac`。 | | `getSitesApsPowerSaving` | 获取 AP 的省电配置。需要 `apMac`。 | | `getSitesApsTrunkSetting` | 获取 AP 的 Trunk 端口设置。需要 `apMac`。 | | `getSitesApsBridge` | 获取 AP 的网桥配置。需要 `apMac`。 | | `listSitesApsPorts` | 列出 AP 的端口。需要 `apMac`。 | | `getSitesSwitchesEs` | 获取 ES 交换机详情。需要 `switchMac`。 | | `getSitesSwitchesEsGeneralConfig` | 获取 ES 交换机的常规配置。需要 `switchMac`。 | | `listSitesCableTestSwitchesPorts` | 列出交换机的网线测试端口信息。需要 `switchMac`。 | | `listSitesCableTestSwitchesIncrementResults` | 获取交换机的增量网线测试结果。需要 `switchMac`。 | | `getUpgradeOverviewCritical` | 获取可升级的关键型号数量。 | | `getUpgradeOverviewTryBeta` | 获取试用 Beta 版固件升级开关的当前状态。 | | `listUpgradeFirmwares` | 列出可用于升级的固件包（分页）。 | | `listUpgradeOverviewFirmwares` | 列出可升级设备的固件概览（分页）。 | | `listSitesStacks` | 列出站点中的交换机堆叠（分页）。 | | `getSitesDeviceWhiteList` | 获取站点的设备接入白名单（分页）。 | | `getSitesGatewaysGeneralConfig` | 获取网关的常规配置。需要 `gatewayMac`。 | | `getSitesGatewaysPin` | 获取网关的 PIN 信息。需要 `gatewayMac`。 | | `getSitesGatewaysSimCardUsed` | 获取网关的 SIM 卡使用信息。需要 `gatewayMac`。 | | `getSitesHealthGatewaysWansDetails` | 获取网关 WAN 的健康详情。需要 `gatewayMac`。 |

写入工具（4）

工具	描述
setApPowerSaving	更新 AP 省电配置，并支持检查兼容性和预览试运行。需要 apMac。
setApChannelLimit	更新 AP 信道限制配置，并支持检查兼容性和预览试运行。需要 apMac。
setApConfig	更新有文档说明的 AP 配置类别，并支持预览试运行。涵盖 AP 常规、IP、IPv6、QoS、无线电、服务、负载均衡、OFDMA、中继、桥接、WLAN 组、端口、信道、AFC 和天线设置。对于仅提供设置器的类别，如果控制器无法读取回写数据，则会返回计划载荷和明确警告。需要 apMac。
setGatewayConfig	更新有文档说明的网关配置类别，并支持预览试运行。涵盖常规、服务、高级、无线电、WLAN 和端口设置。对于仅提供设置器的类别，如果控制器无法读取回写数据，则会返回计划载荷和明确警告。需要 gatewayMac。

---

网络

WAN/LAN 配置、SSID、WLAN 组、路由、NAT、DHCP、DNS、防火墙设置、带宽控制及相关网络服务。

读取工具（55）

| 工具 | 描述 | |---|---| | `getInternetInfo` | 获取站点的互联网配置信息。 | | `getInternet` | [已弃用] 请改用 `getInternetInfo`。获取站点网关的完整 WAN/互联网配置。 | | `getInternetBasicPortInfo` | 获取站点网关的 WAN 端口摘要/基本信息。 | | `getInternetLoadBalance` | 获取 WAN 负载均衡配置（故障转移/负载均衡）。 | | `getWanPortsConfig` | 获取各端口的 WAN 配置，包括连接类型和 IP 设置。 | | `getWanLanStatus` | 获取站点的 WAN-LAN 连通状态。 | | `getGridVirtualWan` | 获取虚拟 WAN 列表（分页）。 | | `getIspBandScan` | 获取 WAN 端口的 ISP 频段扫描结果。需要 `portUuid`。 | | `getDisableNatList` | 获取已禁用 NAT 的有线网络列表（分页）。 | | `getLtePortConfig` | 获取 LTE/蜂窝 WAN 端口配置。 | | `getWanPortDetail` | [已弃用] 请改用 `getWanPortsConfig`。获取网关所有 WAN 端口的详细配置。 | | `getWanIspProfile` | 获取 WAN 端口的 ISP 扫描配置文件结果。需要 `portUuid`。 | | `getWanQosConfig` | 获取网关 WAN 端口的 QoS 配置。 | | `getWanHealthDetail` | [已弃用] WAN 健康状态工具的别名；为保持向后兼容而保留。需要 `gatewayMac`。 | | `getWanUsageStats` | [已弃用] 请改用 `getDashboardTrafficActivities`。获取站点的 WAN 流量使用统计信息。 | | `getWanNatConfig` | 获取一对一 NAT 规则（分页）。 | | `getPortForwardingStatus` | 获取端口转发状态和规则。必需：`type`（`user` 或 `upnp`）。可选分页参数：`page`（默认值为 1）、`pageSize`（默认值为 10）。 | | `getLanNetworkList` | [已弃用] 请改用 `getLanNetworkListV2`。此工具会汇总所有页面；`getLanNetworkListV2` 提供显式分页。 | | `getLanNetworkListV2` | 使用 v2 API 获取 LAN 网络列表，其中包含更丰富的 VLAN 和 DHCP 数据（分页）。 | | `getInterfaceLanNetwork` | 获取接口级 LAN 网络绑定。可选类型筛选器（0=WAN，1=LAN）。 | | `getInterfaceLanNetworkV2` | 使用 v2 API 获取接口级 LAN 网络绑定。返回更丰富的接口级 VLAN 和网络数据。 | | `getLanProfileList` | 获取站点中配置的 LAN 配置文件列表。 | | `getApLoadBalance` | [已弃用] 请改用 `getSitesApsLoadBalance`。使用相同的端点，为保持向后兼容而保留。`getSitesApsLoadBalance` 是规范的工具名称。 | | `getApOfdmaConfig` | [已弃用] 请改用 `getSitesApsOfdma`。使用相同的端点，为保持向后兼容而保留。`getSitesApsOfdma` 是规范的工具名称。 | | `getMulticastRateLimit` | 获取站点的组播速率限制设置。 | | `getWlanGroupList` | 获取站点中配置的 WLAN 组列表。 | | `getSsidList` | 获取 WLAN 组中的 SSID 列表。 | | `getSsidDetail` | 获取指定 SSID 的详细信息。必需：`wlanId` 和 `ssidId`。 | | `listAllSsids` | 列出所有 WLAN 组中的无线 SSID。 | | `getFirewallSetting` | 获取官方 Omada 防火墙端点返回的站点全局防火墙设置。 | | `getVpnSettings` | 获取站点的 VPN 设置。 | | `listSiteToSiteVpns` | 列出站点到站点 VPN 配置。 | | `listPortForwardingRules` | [已弃用] 请改用 `getPortForwardingList`。列出 NAT 端口转发规则。 | | `listOsgAcls` | 列出网关（OSG）ACL 规则。 | | `listEapAcls` | 列出接入点（EAP）ACL 规则。 | | `listStaticRoutes` | [已弃用] 请改用 `getGridStaticRouting`。此工具会汇总所有页面；`getGridStaticRouting` 返回单个分页页面。 | | `getStaticRoutingInterfaceList` | 获取静态路由的可用接口。 | | `listPolicyRoutes` | [已弃用] 请改用 `getGridPolicyRouting`。此工具会汇总所有页面；`getGridPolicyRouting` 提供分页。 | | `getGridPolicyRouting` | 获取策略路由规则（分页）。 | | `getOspfProcess` | 获取站点网关的 OSPF 进程配置。 | | `getOspfInterface` | 获取站点网关的 OSPF 接口配置。 | | `getVrrpConfig` | 获取 OSW 设备的 VRRP 配置。 | | `getOspfNeighbors` | 获取站点网关的 OSPF 邻居设备。 | | `getGridOtoNats` | 获取一对一 NAT 规则（分页）。 | | `getAlg` | 获取 ALG（应用层网关）配置。 | | `getUpnpSetting` | 获取站点网关的 UPnP 设置。 | | `getDdnsGrid` | 获取 DDNS 条目（分页）。 | | `getDhcpReservationGrid` | 获取 DHCP 保留项（分页）。 | | `getGridIpMacBinding` | 获取 IP-MAC 绑定条目（分页）。 | | `getIpMacBindingGeneralSetting` | 获取 IP-MAC 绑定全局开关设置。 | | `getBandwidthControl` | 获取全局带宽控制配置。 | | `getGridBandwidthCtrlRule` | 获取带宽控制规则（分页）。 | | `getSessionLimit` | 获取会话限制全局设置。 | | `getGridSessionLimitRule` | 获取各规则的会话限制规则（分页）。 | | `getSnmpSetting` | 获取 SNMP 配置（版本、团体字符串）。 | | `getLldpSetting` | 获取 LLDP 全局设置。 | | `getRemoteLoggingSetting` | 获取远程日志记录（syslog）配置。 | | `getDnsCacheDataList` | 获取 DNS 缓存数据列表（分页）。 | | `getIptvSetting` | 获取站点的 IPTV 服务配置。 | | `getNtpSetting` | 获取 NTP 服务器配置和同步状态。 | | `getSyslogConfig` | 已弃用；`getRemoteLoggingSetting` 的别名，用于控制器 syslog 配置。 | | `getAccessControl` | 获取控制器访问控制配置。 | | `getDnsCacheSetting` | 获取 DNS 缓存设置。 | | `getDnsProxy` | 获取 DNS 代理配置。 | | `getIgmp` | 获取 IGMP 侦听和代理设置。 | | `getSwitchVlanInterface` | 获取指定交换机的 VLAN 接口配置。需要 `switchMac`。 | | `getLanDnsRules` | 获取站点的 LAN DNS 规则（分页）。 | | `getLanProfileEsUsage` | 获取 LAN 配置文件的 EAP/交换机设备使用情况。需要 `profileId`。 | | `getLanClientCount` | 获取 LAN 网段中的客户端分布明细。 | | `listRadiusProfiles` | 列出 RADIUS 身份验证配置文件。 | | `listGroupProfiles` | 列出组配置文件（IP、MAC 或端口组）。 | | `getApplicationControlStatus` | 获取站点的应用控制状态。 | | `getSshSetting` | 获取站点的 SSH 设置。 | | `listTimeRangeProfiles` | 列出时间范围配置文件。 | | `getRateLimitProfiles` | 获取可用于带宽控制的速率限制配置文件列表。 |

写入工具（13）

工具	描述
setFirewallSetting	使用官方 Omada Open API 防火墙端点更新站点防火墙设置，并提供试运行预览。
setAclConfigTypeSetting	更新网关 ACL 模式（through profiles 或 custom），并提供试运行预览。
createGatewayAcl	使用官方 Omada Gateway ACL 架构创建网关 ACL 规则，并提供试运行预览。
updateGatewayAcl	确认 ACL 存在后更新网关 ACL 规则，并提供试运行预览。
createEapAcl	使用官方 Omada EAP ACL 架构创建 EAP ACL 规则，并提供试运行预览。
updateEapAcl	确认 ACL 存在后更新 EAP ACL 规则，并提供试运行预览。
createSwitchAcl	使用官方 Omada SwitchACLConfig 架构创建交换机（OSW）ACL 规则，并提供试运行预览。
updateSwitchAcl	确认 ACL 存在后更新交换机（OSW）ACL 规则，并提供试运行预览。
deleteAcl	确认 ACL 存在后删除 ACL 规则，并提供试运行预览。
createDhcpReservation	验证目标 LAN 和可选 IP 地址后创建 DHCP 保留。
updateDhcpReservation	验证目标 LAN 和可选 IP 地址后更新 DHCP 保留。
deleteDhcpReservation	按 MAC 地址删除 DHCP 保留，并可选择启用试运行预览。
setBandwidthControlRule	验证目标规则 ID 以及所引用的 LAN 和 WAN 标识符后，创建或更新带宽控制规则，并提供试运行预览。
deleteBandwidthControlRule	确认规则存在后删除带宽控制规则，并提供试运行预览。
setAccessControl	更新门户访问控制设置，并提供试运行预览，同时对预认证和免费认证策略条目进行架构验证。
setAppControlRule	验证创建/更新负载结构、现有规则 ID 以及所引用的应用 ID 后，创建或更新应用控制规则，并提供试运行预览。
deleteAppControlRule	确认规则存在后删除应用控制规则，并提供试运行预览。

---

防火墙与 ACL

802.1X 身份验证和 RADIUS 代理设置。

读取工具（3）

工具	描述
getDot1xConfig	获取 802.1X 交换机端口身份验证设置。getSwitchDot1xSetting 的别名。
getRadiusProxyConfig	获取全局 RADIUS 代理配置（控制器级别，不含 siteId）。
getApplicationAcl	[已弃用] 获取应用控制规则。getAppControlRules 的别名。

---

防火墙流量与 QoS

流量整形、QoS 策略、应用控制、URL 过滤和 MAC 过滤。

读取工具（11）

工具	描述
getGatewayQosClassRules	获取网关 QoS 类别规则（分页）。
getBandwidthCtrlDetail	获取站点的带宽控制详情。
getAppControlRules	获取应用控制规则（分页）。
getAppControlCategories	获取应用控制类别列表。
getUrlFilterRules	获取 URL 过滤网关规则。getGridGatewayRule 的别名。
getUrlFilterBlacklist	获取 URL 过滤 MAC 拒绝列表。getGridDenyMacFiltering 的别名。
getUrlFilterWhitelist	获取 URL 过滤 MAC 允许列表。getGridAllowMacFiltering 的别名。
getMacFilterDetail	获取 MAC 过滤常规设置。getMacFilteringGeneralSetting 的别名。
getQosPolicy	获取站点的 QoS 策略配置。
getTrafficPriority	获取站点的流量优先级规则。
getTrafficStats	[已弃用] 请改用 getDashboardTrafficActivities。获取 WAN 使用统计信息。getWanUsageStats 的别名。
getQosPolicyRule	[已弃用] getQosPolicy 的别名。
getQosMarkingRule	[已弃用] getQosPolicy 的别名。
getDscpConfig	[已弃用] getQosPolicy 的别名。

---

防火墙 IDS / IPS

入侵检测与防御系统配置。

读取工具（1）

工具	描述
getGlobalSecuritySetting	[已弃用] 请改用 getThreatList。获取全局安全／威胁管理列表。getThreatList 的别名。

---

安全与威胁管理

全局威胁情报、IPS 警报和顶级威胁摘要。

读取工具（2）

工具	描述
getThreatList	获取全局威胁管理列表。必需参数：archived（bool）。可选参数：startTime／endTime（自 epoch 起的秒数）、severity（0=严重，1=重大，2=中等／需关注，3=轻微，4=低）、page、pageSize。
getTopThreats	从全局威胁管理视图获取顶级威胁。

---

综合故障排查工具

通过单次调用并行聚合多个 Omada API 调用的工具。当你需要快速了解概况或开始故障排查时，请使用这些工具，而不要逐个调用单项工具。

读取工具（4）

工具	描述
getNetworkHealthSummary	综合工具：将仪表板概览（设备／客户端数量）、互联网／WAN 状态、客户端分布和近期活跃威胁整合到单个响应中。适用于任何故障排查会话的首次调用。
getGatewayHealth	综合工具：自动发现网关，然后在一次调用中获取其详情（CPU、内存、固件）、WAN 端口状态、LAN 接口状态和端口列表。用于互联网／WAN 诊断。
diagnoseClient	综合工具：提供客户端 MAC、IP 或主机名后，在一次调用中获取当前连接状态、客户端详情（VLAN、信号、策略）和近期连接历史记录。
getSecurityOverview	综合工具：将活跃威胁列表（最多 20 条，按时间从新到旧）和防火墙设置整合到一个响应中。用于检查安全状况或调查警报。

---

仪表板 / 监控

站点仪表板小组件：WiFi 和交换机摘要、PoE 用量、CPU / 内存使用率 Top N、流量活动、VPN 隧道统计信息和 RF 分析。

读取工具（16）

工具	描述
getDashboardWifiSummary	获取站点仪表板中的 WiFi 摘要。
getDashboardSwitchSummary	获取站点仪表板中的交换机摘要。
getDashboardTrafficActivities	获取站点仪表板中的流量活动数据。
getDashboardPoEUsage	获取站点仪表板中的 PoE 用量数据。
getDashboardTopCpuUsage	获取站点仪表板中的 CPU 使用率最高数据。
getDashboardTopMemoryUsage	获取站点仪表板中的内存使用率最高数据。
getDashboardMostActiveSwitches	获取站点仪表板中活动最频繁的交换机。
getDashboardMostActiveEaps	获取站点仪表板中活动最频繁的接入点。
getDashboardOverview	获取站点概览：设备数量、客户端数量、连接图和整体健康状态。
getTrafficDistribution	获取某个时间范围内按协议 / 应用类型划分的流量分布。需要提供 start 和 end 时间戳（秒）。
getRetryAndDroppedRate	获取某个时间范围内的无线重试率和丢包率。需要提供 start 和 end 时间戳（秒）。
getIspLoad	获取某个时间范围内各 WAN ISP 链路的负载。需要提供 start 和 end 时间戳（秒）。
getChannels	获取所有 AP 的信道分布和利用率。
getInterference	获取 AP 检测到的 RF 干扰源（按影响程度排序）。
getGridDashboardTunnelStats	获取 VPN 隧道统计信息。必需参数：type（0 = 服务端，1 = 客户端）。
getGridDashboardIpsecTunnelStats	获取 IPsec 隧道统计信息。
getGridDashboardOpenVpnTunnelStats	按类型获取 OpenVPN 隧道统计信息。需要提供 type 参数。

---

洞察

站点级安全洞察：威胁事件、WIDS、恶意 AP 检测和 VPN 隧道统计信息。

读取工具（4）

工具	描述
listSiteThreatManagement	列出站点级威胁管理事件。
getWids	获取站点的 WIDS（无线入侵检测）信息。
getRogueAps	获取站点检测到的恶意接入点。
getVpnTunnelStats	获取站点的 VPN 隧道统计信息。

---

VPN

站点到站点和客户端到站点 VPN 配置、隧道详情及用户管理。

读取工具（6）

工具	描述
getIpsecTunnelList	列出所有站点到站点 VPN（IPsec）隧道。listSiteToSiteVpns 的别名。
getIpsecTunnelDetail	按 ID 获取特定 IPsec 隧道的详细配置。getSiteToSiteVpnInfo 的别名。
getAdvancedVpnSetting	获取站点的高级 VPN 配置设置。getVpnSettings 的别名。
getVpnUserList	获取站点的 VPN 用户（分页）。
getVpnUserDetail	获取特定客户端到站点 VPN 服务端的用户。
getVpnClientStatus	获取客户端到站点 VPN 客户端的状态。listClientToSiteVpnClients 的别名。
getVpnRouteConfig	[已弃用] 请改用 getGridPolicyRouting。此工具会汇总所有页面；getGridPolicyRouting 使用分页。

---

配置文件

RADIUS、PPSK、服务、QoS、计划、组策略、VLAN、用户角色和门户配置文件。

读取工具（14）

工具	描述
getGoogleLdapProfile	获取站点的 Google LDAP 配置文件配置。
getBuiltinRadiusUsers	获取内置 RADIUS 服务用户列表（分页）。
getRadiusUserDetail	[已弃用] getBuiltinRadiusUsers 的别名。
getPpskNetworkProfile	按类型列出站点的 PPSK 网络配置文件。
getPpskUserGroup	获取特定配置文件的 PPSK 用户组详情。
getPpskUserList	[已弃用] getPpskUserGroup 的别名。
getServiceProfile	获取服务类型配置文件（分页）。listServiceType 的别名。
getQosProfile	获取速率限制配置文件。getRateLimitProfiles 的别名。
getScheduleProfile	获取时间范围配置文件。listTimeRangeProfiles 的别名。
getGroupPolicyDetail	按组类型筛选并获取组策略配置文件。
getIpGroupProfile	[已弃用] 获取 IP 组配置文件。getGroupPolicyDetail 且 groupType="0" 时的别名。
getUrlGroupProfile	[已弃用] 获取 URL/端口组配置文件。getGroupPolicyDetail 且 groupType="1" 时的别名。
getAppGroupProfile	[已弃用] 获取 MAC 组配置文件。getGroupPolicyDetail 且 groupType="2" 时的别名。
getVlanProfile	获取 LAN/VLAN 配置文件。getLanProfileList 的别名。
getUserRoleProfile	从控制器获取用户角色配置文件（全局，无 siteId）。
getPortalProfile	获取站点的强制门户配置文件。

---

日志

站点级和全局事件、告警及审计日志。

读取工具（5）

工具	描述
listSiteEvents	列出站点事件日志。
listSiteAlerts	列出站点告警日志。
listSiteAuditLogs	列出站点审计日志。
listGlobalEvents	列出所有站点的全局事件日志。
listGlobalAlerts	列出所有站点的全局告警日志。

---

控制器

控制器级设置：证书、端口、数据保留、遥测和全局仪表板。

读取工具（7）

工具	描述
getCertificate	获取控制器的 SSL/TLS 证书配置。
getClientHistoryDataEnable	获取客户端历史数据收集启用设置。
getControllerPort	获取用于设备接入的控制器端口配置。
getDataRetention	获取控制器的数据保留设置。
getExperienceImprovement	获取体验改进计划设置（遥测）。
getGlobalDashboardOverview	获取不含客户端数据的全局控制器仪表板概览。
getPortalPort	获取控制器 Web 界面的门户端口配置。

---

维护

控制器和站点的备份、还原，以及 Rogue AP 导出。

读取工具（5）

工具	描述
getBackupFileList	列出可用的控制器备份文件。
getBackupResult	获取最近一次控制器备份操作的结果。
getRestoreResult	获取最近一次控制器还原操作的结果。
getSiteBackupFileList	列出站点可用的备份文件。
getSiteBackupResult	获取站点的备份结果。
getRogueApExport	以 CSV 或 Excel 格式导出站点的 Rogue AP 扫描结果。

写入工具（8）

工具	描述
backupController	触发控制器配置备份，将备份保存到自有／云端服务。
backupControllerToFileServer	触发控制器配置备份，将备份保存到外部文件服务（FTP/SFTP）。
restoreController	从自有／云端服务上的备份文件还原控制器配置。
restoreControllerFromFileServer	从外部文件服务上的备份文件还原控制器配置。
backupSites	触发多站点配置备份，将备份保存到自有／云端服务（最多 300 个站点）。
backupSitesToFileServer	触发多站点配置备份，将备份保存到外部文件服务（最多 300 个站点）。
restoreSites	从自有／云端服务上的备份文件还原多个站点配置。
restoreSitesFromFileServer	从外部文件服务上的备份文件还原多个站点配置。

---

账户用户

控制器的用户和角色管理。

读取工具（6）

工具	描述
getAllCloudUsers	列出控制器上的所有云用户，不包括 root 账户。
getAllLocalUsers	列出控制器上的所有本地用户，不包括 root 账户。
getAllRoles	[已弃用] 请改用 getUserRoleProfile。列出控制器上配置的所有用户角色。
getAllUsersApp	以网格视图列出所有用户（云端和本地）。
getAvailableRoles	列出可供分配给用户的角色。
getRoleDetail	获取特定角色的详细信息。需要 roleId。

---

账户云端

云端访问、MFA 和远程绑定状态。

读取工具（4）

工具	描述
getCloudAccessStatus	获取控制器的云端访问状态。
getCloudUserInfo	获取云用户账户信息。
getMfaStatus	获取全局 MFA（多因素身份验证）状态。
getRemoteBindingStatus	获取控制器与云端之间的远程绑定状态。

---

计划任务

PoE、端口、重启和固件升级计划任务。

读取工具（5）

工具	描述
getPoeScheduleList	列出站点的 PoE 计划任务。
getPortScheduleList	列出站点的端口计划任务。
getPortSchedulePorts	列出站点中已分配端口计划任务的端口。
getRebootScheduleList	列出站点模板的设备重启计划任务。需要 siteTemplateId。
getUpgradeScheduleList	列出站点的固件升级计划任务。

---

支持的 Omada API 操作 — 将 Omada API 操作 ID 映射到 MCP 工具名称的兼容性表

| 操作 ID | 描述 | 工具 | | ----------------------------------- | --------------------------------------------------------- | ----------------------------- | | `getSiteList` | 列出控制器站点。 | `listSites` | | `getDeviceList` | 列出分配到某个站点的设备。 | `listDevices`、~~`getDevice`~~ [DEPRECATED] | | `searchGlobalDevice` | 搜索所有可访问站点中的设备。 | `searchDevices` | | `getGridAdoptedDevicesStatByGlobal` | 查询全局已接管设备的统计数据。 | `listDevicesStats` | | `getOswStackDetail` | 获取交换机堆叠的详细信息。 | `getSwitchStackDetail` | | `getSwitch` | 获取指定交换机的详细信息。 | `getSwitchDetail` | | `getGateway` | 获取指定网关的详细信息。 | `getGatewayDetail` | | `getGatewayWanPortStatus` | 获取指定网关的 WAN 端口状态。 | `getGatewayWanStatus` | | `getGatewayLanPortStatus` | 获取指定网关的 LAN 端口状态。 | `getGatewayLanStatus` | | `getGatewayPorts` | 获取指定网关的端口信息。 | `getGatewayPorts` | | `getAp` | 获取指定接入点的详细信息。 | `getApDetail` | | `getApRadios` | 获取指定接入点的无线电信息。 | `getApRadios` | | `getStackPorts` | 获取交换机堆叠的端口信息。 | `getStackPorts` | | `getGridPendingDevices` | 列出站点中待接管的设备。 | `listPendingDevices` | | `getGridActiveClients` | 列出连接到站点的活动客户端。 | `listClients`、~~`getClient`~~ [DEPRECATED] | | `getMostActiveClients` | 按流量排序，获取最活跃的客户端。 | `listMostActiveClients` | | `getClientActivity` | 获取一段时间内的客户端活动统计数据。 | `listClientsActivity` | | `getGridPastConnections` | 获取客户端的历史连接记录。 | `listClientsPastConnections` | | `updateClientRateLimitSetting` | 设置客户端的速率限制。 | `setClientRateLimit`、`setClientRateLimitProfile`、`disableClientRateLimit` | | `getRateLimitProfileList` | 获取速率限制配置文件列表。 | `getRateLimitProfiles` | | `getGlobalThreatList` | 获取全局视图的威胁管理列表。 | `getThreatList` | | `getTopThreatList` | 获取全局威胁管理中的主要威胁。 | `getTopThreats` | | `getInternet` | [DEPRECATED] 请改用 `getInternetInfo`。获取站点的互联网配置信息。 | `getInternetInfo` | | `getPortForwardStatus` | 按类型获取端口转发状态。 | `getPortForwardingStatus` | | `getLanProfileList` | 获取 LAN 配置文件列表。 | `getLanProfileList` | | `getWlanGroupList` | 获取 WLAN 组列表。 | `getWlanGroupList` | | `getSsidList` | 获取 WLAN 组的 SSID 列表。 | `getSsidList` | | `getSsidDetail` | 获取 SSID 的详细配置。 | `getSsidDetail` | | `getSsidListAll` | 列出所有 WLAN 组中的 SSID。 | `listAllSsids` | | `getFirewallSetting` | 获取官方 Omada 防火墙端点返回的站点全局防火墙设置。 | `getFirewallSetting` | | `modifyFirewallSetting` | 更新站点防火墙设置，支持试运行。 | `setFirewallSetting` | | `getVpn` | 获取站点的 VPN 设置。 | `getVpnSettings` | | `getSiteToSiteVpnList` | 列出站点到站点 VPN 配置。 | `listSiteToSiteVpns` | | `getPortForwardingList` | 列出 NAT 端口转发规则。 | `getPortForwardingList`（优先使用）；~~`listPortForwardingRules`~~ [DEPRECATED] | | `getOsgAclList` | 列出网关 ACL 规则。 | `listOsgAcls` | | `getAclConfigTypeSetting` | 获取站点网关的网关 ACL 配置模式。 | `getAclConfigTypeSetting` | | `modifyAclConfigTypeSetting` | 更新网关 ACL 配置模式，支持试运行。 | `setAclConfigTypeSetting` | | `createOsgAcl` | 创建网关 ACL，支持试运行。 | `createGatewayAcl` | | `modifyOsgAcl` | 更新网关 ACL，支持试运行。 | `updateGatewayAcl` | | `getEapAclList` | 列出接入点 ACL 规则。 | `listEapAcls` | | `createEapAcl` | 创建 EAP ACL，支持试运行。 | `createEapAcl` | | `modifyEapAcl` | 更新 EAP ACL，支持试运行。 | `updateEapAcl` | | `getOswAclList` | 列出交换机 ACL 规则。 | `getOswAclList` | | `createOswAcl` | 创建交换机 ACL，支持试运行。 | `createSwitchAcl` | | `modifyOswAcl` | 更新交换机 ACL，支持试运行。 | `updateSwitchAcl` | | `deleteAcl` | 删除 ACL 规则，支持试运行。 | `deleteAcl` | | `getStaticRoutingList` | 列出静态路由规则。 | `getGridStaticRouting`（优先使用）；~~`listStaticRoutes`~~ [DEPRECATED] | | `getRadiusProfileList` | 列出 RADIUS 身份验证配置文件。 | `listRadiusProfiles` | | `getGroupProfileList` | 列出组配置文件（IP、MAC、端口组）。 | `listGroupProfiles` | | `getApplicationControlStatus` | 获取站点的应用控制状态。 | `getApplicationControlStatus` | | `addRule` | 创建应用控制规则，支持试运行。 | `setAppControlRule` | | `editRule` | 更新应用控制规则，支持试运行。 | `setAppControlRule` | | `deleteRules` | 删除应用控制规则，支持试运行。 | `deleteAppControlRule` | | `getSshSetting` | 获取站点的 SSH 设置。 | `getSshSetting` | | `getTimeRangeProfileList` | 列出时间范围配置文件。 | `listTimeRangeProfiles` | | `getWanLanStatus` | 获取站点的 WAN-LAN 连接状态。 | `getWanLanStatus` | | `getSiteThreatManagementList` | 列出站点级威胁管理事件。 | `listSiteThreatManagement` | | `getWids` | 获取站点的 WIDS 信息。 | `getWids` | | `getRogueAps` | 获取站点检测到的恶意接入点。 | `getRogueAps` | | `getVpnTunnelStats` | 获取站点的 VPN 隧道统计数据。 | `getVpnTunnelStats` | | `getSiteEvents` | 列出站点事件日志。 | `listSiteEvents` | | `getSiteAlerts` | 列出站点警报日志。 | `listSiteAlerts` | | `getSiteAuditLogs` | 列出站点审计日志。 | `listSiteAuditLogs` | | `getEvents` | 列出所有站点的全局事件日志。 | `listGlobalEvents` | | `getAlerts` | 列出所有站点的全局警报日志。 | `listGlobalAlerts` | | `disableClientRateLimit` | 禁用指定客户端的速率限制，并移除所有带宽.... | `disableClientRateLimit` | | `getAccessControl` | 获取控制器访问控制配置。 | `getAccessControl` | | `modifyAccessControl` | 更新门户访问控制配置，支持试运行。 | `setAccessControl` | | `getAlg` | 获取站点网关的 ALG（应用层网关）配置。 | `getAlg` | | `getAllDeviceBySite` | 获取站点中的所有设备，包括离线和断开连接的设备。 | `getAllDeviceBySite` | | `getApDetail` | 获取指定接入点的完整配置和状态：mo.... | `getApDetail` | | `getApGeneralConfig` | 获取接入点的常规配置。 | `getApGeneralConfig` | | `getApLldpConfig` | 获取接入点的 LLDP（链路层发现协议）配置.... | `getApLldpConfig` | | `getApRadios` | 获取指定接入点的无线电状态：2.4GHz 和 5GHz 频段 .... | `getApRadios` | | `getApSnmpConfig` | 获取接入点的 SNMP 配置。 | `getApSnmpConfig` | | `getApUplinkConfig` | 获取接入点的上行链路配置。 | `getApUplinkConfig` | | `getBandwidthControl` | 获取站点的全局带宽控制配置。 | `getBandwidthControl` | | `getCableTestLogs` | 获取交换机的网线测试日志。 | `getCableTestLogs` | | `getChannels` | 获取所有 AP 的信道分布和利用率。 | `getChannels` | | `getClient` | [DEPRECATED] 请改用 `listClients`。如果已知客户端 MAC 地址，也可以使用 `getClientDetail`。此工具在进程内筛选站点客户端列表。 | `getClient` | | `getDashboardPoEUsage` | 获取站点的 PoE（以太网供电）使用统计数据，显示 .... | `getDashboardPoEUsage` | | `getDashboardSwitchSummary` | 获取站点仪表板的交换机摘要：交换机总数、总 .... | `getDashboardSwitchSummary` | | `getDashboardTopCpuUsage` | 获取站点 CPU 使用率最高的设备，便于识别.... | `getDashboardTopCpuUsage` | | `getDashboardWifiSummary` | 获取站点仪表板的 WiFi 摘要：AP 总数、已连接 AP 数 .... | `getDashboardWifiSummary` | | `getDdnsGrid` | 获取站点网关的 DDNS（动态 DNS）条目。 | `getDdnsGrid` | | `getDevice` | [DEPRECATED] 请改用 `listDevices`。此别名在进程内筛选设备列表以返回单台设备；没有单独的设备详情 API。 | `getDevice` | | `getDhcpReservationGrid` | 获取站点的 DHCP 保留项。 | `getDhcpReservationGrid` | | `createDhcpReservation` | 完成 LAN/IP 验证和重复 IP 预检后，为站点创建 DHCP 保留项。 | `createDhcpReservation` | | `updateSitesSettingServiceDhcp` | 更新站点现有的 DHCP 保留项。 | `updateDhcpReservation` | | `deleteSitesSettingServiceDhcp` | 删除站点现有的 DHCP 保留项。 | `deleteDhcpReservation` | | `getDnsCacheSetting` | 获取站点网关的 DNS 缓存设置。 | `getDnsCacheSetting` | | `getDnsProxy` | 获取站点网关的 DNS 代理配置。 | `getDnsProxy` | | `getFirewallSetting` | 获取官方 Omada 防火墙端点返回的站点全局防火墙设置。 | `getFirewallSetting` | | `modifyFirewallSetting` | 更新站点防火墙设置，支持试运行。 | `setFirewallSetting` | | `getFirmwareInfo` | 获取设备最新可用的固件信息。 | `getFirmwareInfo` | | `getGatewayDetail` | 获取指定网关的完整配置和状态：型号、.... | `getGatewayDetail` | | `getGatewayLanStatus` | 获取指定网关的 LAN 端口状态：端口链路状态、速度、.... | `getGatewayLanStatus` | | `getGatewayPorts` | 获取指定网关的所有 WAN 和 LAN 端口详情：链路状态.... | `getGatewayPorts` | | `getGatewayWanStatus` | 获取指定网关的 WAN 端口状态和连接信息.... | `getGatewayWanStatus` | | `getGridBandwidthCtrlRule` | 获取站点网关的带宽控制规则。 | `getGridBandwidthCtrlRule` | | `createBandwidthCtrlRule` | 创建带宽控制规则，支持试运行。 | `setBandwidthControlRule` | | `modifyBandwidthCtrlRule` | 更新带宽控制规则，支持试运行。 | `setBandwidthControlRule` | | `deleteBandwidthCtrlRule` | 删除带宽控制规则，支持试运行。 | `deleteBandwidthControlRule` | | `getGridIpMacBinding` | 获取站点的 IP-MAC 绑定条目。 | `getGridIpMacBinding` | | `getGridOtoNats` | 获取站点网关的 1:1 NAT 规则。 | `getGridOtoNats` | | `getGridPolicyRouting` | 获取站点网关的策略路由规则。 | `getGridPolicyRouting` | | `getGridSessionLimitRule` | 获取站点网关的逐规则会话限制规则。 | `getGridSessionLimitRule` | | `getGridVirtualWan` | 获取站点网关的虚拟 WAN 列表。 | `getGridVirtualWan` | | `getIgmp` | 获取站点的 IGMP（互联网组管理协议）设置。 | `getIgmp` | | `getInterfaceLanNetwork` | 获取接口级 LAN 网络绑定。 | `getInterfaceLanNetwork` | | `getInterference` | 获取 AP 检测到的主要 RF 干扰源。 | `getInterference` | | `getInternet` | [DEPRECATED] 请改用 `getInternetInfo`。获取站点网关的完整 WAN/互联网配置。 | `getInternet` | | `getInternetBasicPortInfo` | 获取站点网关的 WAN 端口摘要/基本信息。 | `getInternetBasicPortInfo` | | `getInternetInfo` | 获取站点的互联网配置信息，包括 WAN se.... | `getInternetInfo` | | `getInternetLoadBalance` | 获取站点网关的 WAN 负载均衡配置。 | `getInternetLoadBalance` | | `getIspBandScan` | 获取 WAN 端口的 ISP 频段扫描结果。需要 `portUuid`。 | `getIspBandScan` | | `getIspLoad` | 获取一段时间内各 WAN 的 ISP 链路负载。 | `getIspLoad` | | `getLanClientCount` | 获取各 LAN 网段的客户端分布情况（有线、无线、访客）。 | `getLanClientCount` | | `getLanDnsRules` | 获取站点配置的 LAN DNS 规则（分页）。 | `getLanDnsRules` | | `getLanNetworkList` | [DEPRECATED] 请改用 `getLanNetworkListV2`。此工具汇总所有页面；`getLanNetworkListV2` 明确采用分页方式。 | `getLanNetworkList` | | `getLanProfileEsUsage` | 获取指定 LAN 配置文件的 EAP/交换机设备使用情况。需要 `profileId`。 | `getLanProfileEsUsage` | | `getLanProfileList` | 获取站点配置的 LAN 配置文件列表。 | `getLanProfileList` | | `getLtePortConfig` | 获取站点网关的 LTE/蜂窝 WAN 端口配置。 | `getLtePortConfig` | | `getLldpSetting` | 获取站点的全局 LLDP（链路层发现协议）设置。 | `getLldpSetting` | | `getMeshStatistics` | 获取接入点的网状网络链路统计数据。 | `getMeshStatistics` | | `getOswStackLagList` | 获取交换机堆叠的链路聚合组（LAG）列表。 | `getOswStackLagList` | | `getPortForwardingList` | 获取站点网关 NAT 端口转发规则的分页页面。 | `getPortForwardingListPage` | | `getPortForwardingStatus` | 获取站点的端口转发状态和规则。 | `getPortForwardingStatus` | | `getRFScanResult` | [DEPRECATED] 获取接入点最近一次 RF 扫描结果。 | `getRFScanResult` | | `getRadiosConfig` | 获取接入点各无线电的配置。 | `getRadiosConfig` | | `getRateLimitProfiles` | 获取站点可用的速率限制配置文件列表。 | `getRateLimitProfiles` | | `getRemoteLoggingSetting` | 获取站点的远程日志记录（syslog）配置。 | `getRemoteLoggingSetting` | | `getDnsCacheDataList` | 获取站点的 DNS 缓存数据列表（分页）。 | `getDnsCacheDataList` | | `getDisableNatList` | 获取已禁用 NAT 的有线网络列表（分页）。 | `getDisableNatList` | | `getIptvSetting` | 获取站点的 IPTV 服务配置。 | `getIptvSetting` | | `getNtpSetting` | 获取站点的 NTP 服务器配置和同步状态。 | `getNtpSetting` | | `getOspfInterface` | 获取站点网关的 OSPF 接口配置。 | `getOspfInterface` | | `getOspfNeighbors` | 获取站点网关的 OSPF 邻居设备。 | `getOspfNeighbors` | | `getOspfProcess` | 获取站点网关的 OSPF 进程配置。 | `getOspfProcess` | | `getSwitchVlanInterface` | 获取指定交换机的 VLAN 接口配置。需要 `switchMac`。 | `getSwitchVlanInterface` | | `getSyslogConfig` | [DEPRECATED] 控制器 syslog 配置的 `getRemoteLogging` 别名。 | `getSyslogConfig` | | `getVrrpConfig` | 获取站点 OSW 设备的 VRRP 配置。 | `getVrrpConfig` | | `getWanHealthDetail` | [DEPRECATED] WAN 健康状况工具的别名；为向后兼容而保留。需要 `gatewayMac`。 | `getWanHealthDetail` | | `getWanIspProfile` | 获取 WAN 端口的 ISP 扫描配置文件结果。需要 `portUuid`。 | `getWanIspProfile` | | `getWanNatConfig` | 获取站点网关的一对一 NAT 配置（WAN NAT 规则，分页）。 | `getWanNatConfig` | | `getWanPortDetail` | [DEPRECATED] 请改用 `getWanPortsConfig`。获取站点上网关所有 WAN 端口的详细配置。 | `getWanPortDetail` | | `getWanQosConfig` | 获取站点网关 WAN 端口的 QoS 配置。 | `getWanQosConfig` | | `getWanUsageStats` | [DEPRECATED] 请改用 `getDashboardTrafficActivities`。获取站点的 WAN 流量使用统计数据和活动数据。 | `getWanUsageStats` | | `getRetryAndDroppedRate` | 获取一段时间内的无线重试率和丢包率。 | `getRetryAndDroppedRate` | | `getRogueAps` | 获取 WIDS 检测到的恶意（未授权）接入点列表.... | `getRogueAps` | | `getSessionLimit` | 获取站点网关的全局会话限制设置。 | `getSessionLimit` | | `getSnmpSetting` | 获取站点的 SNMP 配置。 | `getSnmpSetting` | | `getSpeedTestResults` | 获取接入点最近一次测速结果。 | `getSpeedTestResults` | | `getSitesApsChannelLimit` | 获取 AP 信道限制配置。 | `getSitesApsChannelLimit` | | `updateSitesApsChannelLimit` | 更新 AP 信道限制配置，支持试运行。 | `setApChannelLimit` | | `modifyGeneralConfig_2` | 更新 AP 常规配置，支持试运行。 | `setApConfig` | | `modifyIpSettingConfig` | 更新 AP IP 设置，支持试运行。 | `setApConfig` | | `modifyIpv6SettingConfig` | 更新 AP IPv6 设置，支持试运行。 | `setApConfig` | | `modifyApQosConfig` | 更新 AP QoS 设置，支持试运行。 | `setApConfig` | | `modifyRadiosConfig` | 更新 AP 无线电设置，支持试运行。 | `setApConfig` | | `modifyApServicesConfig` | 更新 AP 服务设置，支持试运行。 | `setApConfig` | | `modifyApLoadBalanceConfig` | 更新 AP 负载均衡设置，支持试运行。 | `setApConfig` | | `modifyApOfdmaConfig` | 更新 AP OFDMA 设置，支持试运行。 | `setApConfig` | | `getSitesApsPowerSaving` | 获取 AP 省电配置。 | `getSitesApsPowerSaving` | | `updateSitesApsPowerSaving` | 更新 AP 省电配置，支持试运行。 | `setApPowerSaving` | | `modifyApTrunkSettingConfig` | 更新 AP 中继设置，支持试运行。 | `setApConfig` | | `modifyApBridgeInfo` | 更新 AP 网桥设置，支持试运行。 | `setApConfig` | | `modifyApPort` | 更新 AP 端口设置，支持试运行。 | `setApConfig` | | `modifyApChannelConfig` | 更新 AP 信道配置，支持试运行。 | `setApConfig` | | `modifyAfcConfig` | 更新 AP AFC 配置，支持试运行。 | `setApConfig` | | `modifyAntennaGainConfig` | 更新 AP 天线增益设置，支持试运行。 | `setApConfig` | | `updateWlanGroupConfig` | 更新 AP WLAN 组分配，支持试运行。 | `setApConfig` | | `modifyGeneralConfig_1` | 更新网关常规配置，支持试运行。 | `setGatewayConfig` | | `modifyConfigGeneral` | 更新网关配置/常规设置，支持试运行。 | `setGatewayConfig` | | `modifyConfigServices` | 更新网关服务配置，支持试运行。 | `setGatewayConfig` | | `modifyConfigAdvanced` | 更新网关高级设置，支持试运行。 | `setGatewayConfig` | | `modifyConfigRadios` | 更新网关无线电配置，支持试运行。 | `setGatewayConfig` | | `modifyConfigWlans` | 更新网关 WLAN 配置，支持试运行。 | `setGatewayConfig` | | `modifyPortConfig` | 更新网关端口配置，支持试运行。 | `setGatewayConfig` | | `batchModifyPortConfig` | 更新多个网关端口，支持试运行。 | `setGatewayConfig` | | `getSshSetting` | 获取站点的 SSH 访问设置。 | `getSshSetting` | | `getSsidDetail` | 获取指定 SSID（无线网络）的详细信息，包.... | `getSsidDetail` | | `getSsidList` | 获取 WLAN 组中配置的 SSID（无线网络）列表。 | `getSsidList` | | `getStackNetworkList` | 获取交换机堆叠的 VLAN 网络列表。 | `getStackNetworkList` | | `getStackPorts` | 获取交换机堆叠的所有端口信息。 | `getStackPorts` | | `getSwitchDetail` | 获取指定交换机的完整配置和状态：型号、f.... | `getSwitchDetail` | | `getSwitchStackDetail` | 获取指定交换机堆叠的详细信息。 | `getSwitchStackDetail` | | `getThreatList` | 获取全局视图的威胁管理列表。 | `getThreatList` | | `getTopThreats` | 获取全局威胁管理视图中的主要威胁，涵盖 a.... | `getTopThreats` | | `getTrafficDistribution` | 获取一段时间内按协议和应用类型划分的流量分布.... | `getTrafficDistribution` | | `getUpnpSetting` | 获取站点的 UPnP（通用即插即用）设置。 | `getUpnpSetting` | | `getVpnSettings` | 获取站点的 VPN 配置设置。 | `getVpnSettings` | | `getVpnTunnelStats` | 获取站点的 VPN 隧道统计数据（分页），包括活动 .... | `getVpnTunnelStats` | | `getWanLanStatus` | 获取站点的 WAN 和 LAN 连接状态。 | `getWanLanStatus` | | `getWanPortsConfig` | 获取站点网关的 WAN 端口设置。 | `getWanPortsConfig` | | `getWids` | 获取站点的无线入侵检测系统（WIDS）信息.... | `getWids` | | `getWlanGroupList` | 获取站点配置的 WLAN 组列表。 | `getWlanGroupList` | | `listAllSsids` | 列出站点所有 WLAN 组中的无线 SSID：SSID 名称.... | `listAllSsids` | | `listClients` | 列出连接到站点的所有网络客户端（有线和无线）。 | `listClients` | | `listClientsActivity` | 从仪表板获取一段时间内的客户端活动统计数据。 | `listClientsActivity` | | `listClientsPastConnections` | 获取客户端历史连接列表及历史连接数据。 | `listClientsPastConnections` | | `listDevices` | 列出站点中所有已配置（已接管）的网络设备：网关、.... | `listDevices` | | `listEapAcls` | 列出站点的 EAP（接入点）ACL 规则：无线客户端访问.... | `listEapAcls` | | `listGlobalAlerts` | 列出控制器所有站点的警报日志：超出阈值.... | `listGlobalAlerts` | | `listGlobalEvents` | 列出控制器所有站点的系统事件日志。 | `listGlobalEvents` | | `listGroupProfiles` | 列出站点配置的组配置文件（IP 组、MAC 组、端口组）.... | `listGroupProfiles` | | `listMostActiveClients` | 获取站点中最活跃的客户端，按总流量排序。 | `listMostActiveClients` | | `listOsgAcls` | 列出站点的网关（OSG）ACL 规则：用于控制.... | `listOsgAcls` | | `listPendingDevices` | 列出网络中发现但尚未接管到此....的设备 | `listPendingDevices` | | `listPolicyRoutes` | [DEPRECATED] 请改用 `getGridPolicyRouting`。此工具汇总所有页面；`getGridPolicyRouting` 使用分页。 | `listPolicyRoutes` | | `listPortForwardingRules` | [DEPRECATED] 请改用 `getPortForwardingList`。列出站点的所有 NAT 端口转发规则：外部端口、内部.... | `listPortForwardingRules` | | `listRadiusProfiles` | 列出站点配置的 RADIUS 身份验证配置文件：服务器 I.... | `listRadiusProfiles` | | `listSiteAlerts` | 列出站点警报日志：超出阈值、设备故障、se.... | `listSiteAlerts` | | `listSiteAuditLogs` | 列出站点管理员审计日志：谁进行了哪些配置更改.... | `listSiteAuditLogs` | | `listSiteEvents` | 列出站点系统事件日志：设备上线/离线、客户端 co.... | `listSiteEvents` | | `listSiteThreatManagement` | 列出 IPS 检测到的站点级威胁管理事件，可选.... | `listSiteThreatManagement` | | `listSiteToSiteVpns` | 列出站点到站点 VPN 配置：隧道名称、远程 IP、状态.... | `listSiteToSiteVpns` | | `listSites` | 列出 Omada 控制器上配置的所有站点。 | `listSites` | | `listStaticRoutes` | [DEPRECATED] 请改用 `getGridStaticRouting`。此工具汇总所有页面；`getGridStaticRouting` 返回单个分页页面。 | `listStaticRoutes` | | `listSwitchNetworks` | 列出交换机的 VLAN 网络分配。 | `listSwitchNetworks` | | `listTimeRangeProfiles` | 列出站点配置的时间范围配置文件。 | `listTimeRangeProfiles` | | `searchDevices` | 搜索用户有权访问的所有站点中的设备。 | `searchDevices` | | `setClientRateLimit` | 为指定客户端设置自定义速率限制（带宽控制）。 | `setClientRateLimit` | | `getAclConfigTypeSetting` | 获取站点网关的 ACL 配置类型设置（L2 或.... | `getAclConfigTypeSetting` | | `getAttackDefenseSetting` | 获取 DDoS 和攻击防御配置，包括洪水攻击防护.... | `getAttackDefenseSetting` | | `getAuditLogSettingForGlobal` | 获取控制器的全局审计日志通知设置。 | `getAuditLogSettingForGlobal` | | `getAuditLogSettingForSite` | 获取站点级审计日志通知设置，包括审计事件.... | `getAuditLogSettingForSite` | | `getAuditLogsForGlobal` | 获取全局审计日志（分页）。 | `getAuditLogsForGlobal` | | `getBandSteeringSetting` | 获取频段引导配置。 | `getBandSteeringSetting` | | `getBandwidthCtrl` | [DEPRECATED] 请改用 `getBandwidthControl`。获取站点的全局带宽控制配置。 | `getBandwidthControl` | | `getBeaconControlSetting` | 获取信标控制设置，用于管理 802.11 信标传输.... | `getBeaconControlSetting` | | `getChannelLimitSetting` | [DEPRECATED] 获取信道限制设置，用于限制可用信道.... | `getChannelLimitSetting` | | `getClientActiveTimeout` | 获取客户端非活动超时设置。 | `getClientActiveTimeout` | | `getClientDetail` | 按 MAC 地址获取指定客户端的完整详细信息，包括连接.... | `getClientDetail` | | `getClientToSiteVpnServerInfo` | 获取指定客户端到站点 VPN 服务器的详细配置.... | `getClientToSiteVpnServerInfo` | | `getClientsDistribution` | 按连接类型和频段获取客户端数量分布（有线、2.... | `getClientsDistribution` | | `getControllerStatus` | 获取 Omada 控制器的运行状况和状态，包括运行状态.... | `getControllerStatus` | | `getDeviceAccessManagement` | 获取设备访问管理设置，用于控制哪些设备.... | `getDeviceAccessManagement` | | `getEapDot1xSetting` | 获取接入点的 802.1X EAP 设置，用于控制基于端口的.... | `—` | | `getGeneralSettings` | 获取 Omada 控制器的全局常规设置，包括.... | `getGeneralSettings` | | `getGridAllowList` | 获取 IPS 允许列表（分页）。 | `getGridAllowList` | | `getGridAllowMacFiltering` | 获取 MAC 地址允许列表条目（分页）。 | `getGridAllowMacFiltering` | | `getGridBlockList` | 获取 IPS 阻止列表（分页）。 | `getGridBlockList` | | `getGridClientHistory` | 获取逐客户端连接历史记录（分页）。 | `getGridClientHistory` | | `getGridDenyMacFiltering` | 获取 MAC 地址拒绝列表条目（分页）。 | `getGridDenyMacFiltering` | | `getGridEapRule` | 获取 URL 过滤器 AP 规则（分页）。 | `getGridEapRule` | | `getGridGatewayRule` | 获取 URL 过滤器网关规则（分页）。 | `getGridGatewayRule` | | `getGridIpsecFailover` | 获取 IPsec 故障转移配置（分页）。 | `getGridIpsecFailover` | | `getGridKnownClients` | 获取历史已知客户端列表（分页）。 | `getGridKnownClients` | | `getGridSignature` | 获取 IPS 特征码列表（分页）。 | `getGridSignature` | | `getGridStaticRouting` | 获取站点网关的静态路由规则，支持显式分页。 | `getGridStaticRouting` | | `getGroupProfilesByType` | 按类型筛选获取组配置文件（例如 | `getGroupProfilesByType` | | `getIpsConfig` | 获取 IPS（入侵防御系统）全局配置，包括.... | `getIpsConfig` | | `getIpsecVpnStats` | 获取站点的 IPsec VPN 隧道统计数据（分页），包括 a.... | `getIpsecVpnStats` | | `getLdapProfileList` | 列出站点配置的所有 LDAP 身份验证配置文件。 | `getLdapProfileList` | | `getLogSettingForGlobal` | 获取全局日志通知设置（v1），包括全局警报收件人.... | `getLogSettingForGlobal` | | `getLogSettingForGlobalV2` | 获取全局日志通知设置（v2），包含扩展通知.... | `—` | | `getLogSettingForSite` | 获取站点级日志通知设置（v1），包括警报收件人.... | `getLogSettingForSite` | | `getLogSettingForSiteV2` | 获取站点级日志通知设置（v2），包含扩展通知.... | `—` | | `getLogging` | 获取控制器日志记录配置，包括日志级别和.... | `getLogging` | | `getMacAuthSetting` | 获取 MAC 身份验证全局设置。 | `getMacAuthSetting` | | `getMacAuthSsids` | 获取各 SSID 的 MAC 身份验证设置，显示哪些 SSID 启用了 M.... | `getMacAuthSsids` | | `getMacFilteringGeneralSetting` | 获取 MAC 过滤全局设置。 | `getMacFilteringGeneralSetting` | | `getMailServerStatus` | 获取控制器的邮件服务器连接状态。 | `getMailServerStatus` | | `getMeshSetting` | 获取网状网络配置，包括网状拓扑模式 .... | `getMeshSetting` | | `getOsgCustomAclList` | 获取自定义网关 ACL 规则列表（分页）。 | `getOsgCustomAclList` | | `getOswAclList` | 获取交换机 ACL 列表（分页）。 | `getOswAclList` | | `getOuiProfileList` | 获取基于 OUI 的设备配置文件列表（分页）。 | `getOuiProfileList` | | `getPPSKProfiles` | 按类型列出站点的 Private PSK（PPSK）配置文件。 | `getPPSKProfiles` | | `getPastClientNum` | 获取一段时间内的历史客户端数量趋势。 | `getPastClientNum` | | `getRadioFrequencyPlanningConfig` | 获取站点的 RF 规划配置，包括频率.... | `getRadioFrequencyPlanningConfig` | | `getRadioFrequencyPlanningResult` | 获取站点的 RF 规划结果。 | `getRadioFrequencyPlanningResult` | | `getRadiusServer` | 获取控制器的全局 RADIUS 服务器配置。 | `getRadiusServer` | | `getRadiusUserList` | 列出本地 RADIUS 服务器用户（分页）。 | `getRadiusUserList` | | `getRemoteLogging` | 获取全局 syslog/远程日志记录配置，包括 syslo.... | `getRemoteLogging` | | `getRetention` | 获取控制器的数据保留配置，包括 .... | `getRetention` | | `getRoamingSetting` | 获取客户端漫游配置，包括 802.11r/k/v 设置.... | `getRoamingSetting` | | `getRoutingTable` | 按类型筛选获取站点的实时路由表。 | `getRoutingTable` | | `getServiceTypeSummary` | 获取站点服务类型配置文件摘要，包括 pred.... | `getServiceTypeSummary` | | `getSiteToSiteVpnInfo` | 按 ID 获取指定站点到站点 VPN 的详细信息，包.... | `getSiteToSiteVpnInfo` | | `getSsidsBySite` | 按设备类型筛选，获取扁平化的 SSID 列表。 | `getSsidsBySite` | | `getSslVpnServerSetting` | 获取 SSL VPN 服务器配置，包括端口、协议和.... | `getSslVpnServerSetting` | | `getSwitchDot1xSetting` | 获取 802.1X 交换机端口身份验证设置。 | `—` | | `getThreatCount` | 按严重级别（严重、高....）分组，获取全局威胁数量 | `getThreatSeverity` | | `getThreatDetail` | 按 ID 获取指定 IPS 威胁事件的详细信息。 | `getThreatDetail` | | `getUiInterface` | 获取控制器的 UI 界面设置，包括超时.... | `getUiInterface` | | `getUrlFilterGeneral` | 获取 URL 过滤器全局设置，包括是否启用 URL 过滤.... | `getUrlFilterGeneral` | | `getWebhookForGlobal` | 获取全局 webhook 通知设置，包括 webhook URL.... | `getWebhookForGlobal` | | `getWebhookLogsForGlobal` | 获取 webhook 调度日志（分页）。 | `getWebhookLogsForGlobal` | | `getWidsBlacklist` | 获取 WIPS（无线入侵防御系统）恶意 AP 黑名单.... | `getWidsBlacklist` | | `getWireguardSummary` | 获取站点 WireGuard VPN 配置摘要，包括.... | `getWireguardSummary` | | `listClientToSiteVpnClients` | 列出站点上的所有客户端到站点 VPN 客户端配置。 | `listClientToSiteVpnClients` | | `listClientToSiteVpnServers` | 列出站点上的所有客户端到站点 VPN 服务器配置，包.... | `listClientToSiteVpnServers` | | `listDevicesStats` | 分页并筛选查询全局已接管设备的统计数据.... | `listDevicesStats` | | `listMdnsProfile` | 列出站点配置的所有 Bonjour/mDNS 服务配置文件，用于 c.... | `listMdnsProfile` | | `listServiceType` | 列出服务类型配置文件（分页）。 | `listServiceType` | | `listWireguard` | 列出 WireGuard VPN 隧道（分页）。 | `listWireguard` | | `listWireguardPeers` | 列出 WireGuard 对等节点（分页）。 | `listWireguardPeers` | | `getDashboardMostActiveEaps` | 按流量从站点仪表板获取最活跃的接入点。 | `getDashboardMostActiveEaps` | | `getDashboardTopMemoryUsage` | 从站点仪表板获取设备内存使用量最高的数据。 | `getDashboardTopMemoryUsage` | | `getDashboardTrafficActivities` | 从站点仪表板获取流量活动数据和吞吐量摘要。 | `getDashboardTrafficActivities` | | `getGridDashboardTunnelStats` | 获取网格仪表板视图的 VPN 隧道统计数据。 | `getGridDashboardTunnelStats` | | `setClientRateLimitProfile` | 为指定客户端应用预定义的速率限制配置文件。 | `setClientRateLimitProfile` | | `getGatewayQosClassRules` | 获取网关 QoS 类规则（分页）。 | `getGatewayQosClassRules` | | `getBandwidthCtrlDetail` | 获取站点的带宽控制详情。 | `getBandwidthCtrlDetail` | | `getAppControlRules` | 获取应用控制规则（分页）。 | `getAppControlRules` | | `getAppControlCategories` | 获取应用控制类别列表。 | `getAppControlCategories` | | `getQosPolicy` | 获取站点的 QoS 策略配置。 | `getQosPolicy` | | `getTrafficPriority` | 获取站点的流量优先级规则。 | `getTrafficPriority` | | `getVpnUserList` | 获取站点的 VPN 用户列表（分页）。 | `getVpnUserList` | | `getVpnUserDetail` | 按 ID 获取指定客户端到站点 VPN 服务器的用户。 | `getVpnUserDetail` | | `getGoogleLdapProfile` | 获取站点的 Google LDAP 配置文件配置。 | `getGoogleLdapProfile` | | `getPpskUserGroup` | 获取指定配置文件 ID 的 PPSK 用户组详情。 | `getPpskUserGroup` | | `getPortalProfile` | 获取站点的强制门户配置文件。 | `getPortalProfile` | | `getUserRoleProfile` | 获取控制器的用户角色配置文件（全局）。 | `getUserRoleProfile` | | `getRadiusProxyConfig` | 获取全局 RADIUS 代理配置（控制器级）。 | `getRadiusProxyConfig` | | `getSiteEntity` | 获取站点详情。 | `getSiteDetail` | | `getSiteUrlByOpenApi` | 获取站点 URL。 | `getSiteUrl` | | `getNtpServerStatus` | 获取站点的 NTP 服务器状态。 | `getSiteNtpStatus` | | `getSiteSpecification` | 获取站点规格。 | `getSiteSpecification` | | `getSiteRememberSettingByOpenApi` | 获取站点记住设备设置。 | `getSiteRememberSetting` | | `getSiteDeviceAccountSetting` | 获取站点设备账户设置。 | `getSiteDeviceAccount` | | `getSiteSettingCap` | 获取站点容量设置。 | `getSiteCapacity` | | `getSiteTemplateList` | 列出站点模板。 | `getSiteTemplateList` | | `getSiteTemplateEntity` | 获取站点模板详情。 | `getSiteTemplateDetail` | | `getSiteTemplateConfiguration` | 获取站点模板配置。 | `getSiteTemplateConfig` | | `getDataRetention` | 获取数据保留设置。 | `getDataRetention` | | `getControllerPort` | 获取控制器端口设置。 | `getControllerPort` | | `getPortalPort` | 获取门户端口设置。 | `getPortalPort` | | `getCertificate` | 获取证书配置。 | `getCertificate` | | `getExpImprove` | 获取体验改进设置。 | `getExperienceImprovement` | | `getGernalSettings_1` | 获取不含客户端数据的全局仪表板概览。 | `getGlobalDashboardOverview` | | `getClientHistoryDataEnable` | 获取客户端历史数据启用设置。 | `getClientHistoryDataEnable` | | `getSelfServerFileList` | 列出控制器备份文件。 | `getBackupFileList` | | `getBackupResult` | 获取控制器备份结果。 | `getBackupResult` | | `getRestoreResult` | 获取控制器恢复结果。 | `getRestoreResult` | | `getSiteBackupResult` | 获取站点备份结果。 | `getSiteBackupResult` | | `getSelfServerSiteFileList` | 列出站点备份文件。 | `getSiteBackupFileList` | | `getAllCloudUsersExcludeRoot` | 列出除 root 外的所有云用户。 | `getAllCloudUsers` | | `getAllLocalUsersExcludeRoot` | 列出除 root 外的所有本地用户。 | `getAllLocalUsers` | | `getAllRoles` | [DEPRECATED] 请改用 `getUserRoleProfile`。列出所有角色。 | `getAllRoles` | | `getRole` | 获取角色详情。 | `getRoleDetail` | | `getAvailableRole` | 列出可用角色。 | `getAvailableRoles` | | `getAppGridUsers` | 列出应用网格视图中的所有用户。 | `getAllUsersApp` | | `getCloudAccessStatus` | 获取云访问状态。 | `getCloudAccessStatus` | | `getCloudUserInfo` | 获取云用户信息。 | `getCloudUserInfo` | | `getGlobalMFAStatus` | 获取全局 MFA 状态。 | `getMfaStatus` | | `getRemoteBindingStatus` | 获取远程绑定状态。 | `getRemoteBindingStatus` | | `getUpgradeScheduleList` | 列出站点的升级计划。 | `getUpgradeScheduleList` | | `getRebootScheduleList_1` | 列出站点模板的重启计划。 | `getRebootScheduleList` | | `getPoeScheduleList` | 列出站点的 PoE 计划。 | `getPoeScheduleList` | | `getPortScheduleList` | 列出站点的端口计划。 | `getPortScheduleList` | | `getPortSchedulePorts` | 列出配置了端口计划的端口。 | `getPortSchedulePorts` | | `getMulticastRateLimitByOpenApi` | 获取组播速率限制设置。 | `getMulticastRateLimit` | | `getApLoadBalanceConfig` | 获取 AP 负载均衡配置。 | `getApLoadBalance` | | `getApOfdmaConfig` | [DEPRECATED] 请改用 `getSitesApsOfdma`。使用相同端点，为向后兼容而保留。`getSitesApsOfdma` 是规范工具名称。 | `getApOfdmaConfig` |

Devcontainer 支持

此代码库提供开箱即用的 devcontainer 配置，并配备专用的 Omada controller sidecar，用于本地开发和测试。详情请参阅 .devcontainer/README.md。

许可证

本项目采用 MIT License 授权。