TP-Link Omada MCP服务器
> ## 🤖 人工智能开发库
>
> 自从 2026年3月2日,此存储库不包含人工编写的代码。
>
> 所有的规划、开发和代码审查都是由AI代理执行的。人类仍然处于方向、决策和最终批准的循环中——但每一行代码、每一次测试、每一个提交和每一个PR都是人工智能的工作。
>
> 这不是一个实验。这就是它现在的工作方式。 了解更多
一个用TypeScript实现的模型上下文协议(MCP)服务器,它将TP-Link Omada控制器API暴露给AI副驾驶和自动化工作流。服务器根据控制器进行身份验证,列出站点、设备和连接的客户端,并提供通用工具来调用任意Omada API端点。
> 兼容性: 使用Omada控制器5.x和6.x版本进行测试
快速开始
与克劳德桌面(stdio)一起使用
- 拉取Docker镜像 (或在本地构建
npm run docker:build):```bash
docker pull jmtvms/tplink-omada-mcp:latest
1. **将MCP服务器添加到Claude Desktop配置中**.编辑您的Claude Desktop配置文件:
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **视窗**: `%APPDATA%\Claude\claude_desktop_config.json`
1. **添加以下配置**:```json
{
"mcpServers": {
"tplink-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=false",
"jmtvms/tplink-omada-mcp:latest"
]
}
}
}
将环境变量值替换为实际的Omada控制器凭据。
-
重新启动克劳德桌面 加载新的MCP服务器配置。
-
验证连接 请Claude列出您的Omada网站或设备。
使用Docker容器
CLI/stdio容器```bash
docker run -it --rm \
--env-file .env \
jmtvms/tplink-omada-mcp:latest
#### HTTP服务器容器```bash
docker run -d \
--env-file .env \
-e MCP_SERVER_USE_HTTP=true \
-e MCP_HTTP_BIND_ADDR=0.0.0.0 \
-p 3000:3000 \
jmtvms/tplink-omada-mcp:latest
HTTP服务器将在 http://localhost:3000/mcp.
特性
- OAuth客户端凭据身份验证,带有自动令牌刷新功能
- 用于检索站点、网络设备和连接客户端的工具
- 用于高级自动化场景的通用Omada API调用程序
- 环境驱动配置
- 存储在下的每个标签的Omada OpenAPI引用
docs/openapi - 即用型devcontainer,附带Omada控制器服务
入门
先决条件
- Docker(用于运行预构建的容器)或Node.js 24+(用于本地开发)
- 访问TP-Link Omada控制器(例如使用
mbentley/omada-controllerDocker镜像)
配置
MCP服务器从环境变量中读取其配置。看 .env.example 以获取完整的参考。
工具类别筛选
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
OMADA_TOOL_CATEGORIES |
没有 | dashboard:r,client-insights:r,clients:r,devices-all:r |
启动时启用逗号分隔的类别 |
每个令牌都是 [:].权限后缀:
| 后缀 | 效果 |
|---|---|
:r |
仅读取工具 |
:w |
仅写入工具 |
:rw |
读写工具 |
| (无) | 与 :rw |
类别参考
标记为的类别 * 为即将到来的阶段保留,目前还没有工具实现。指定它们将产生启动警告,并将跳过它们。写入工具目前仅限于 clients 类别。
| 组 | 类别 |
|---|---|
| 仪表板和见解 | dashboard, client-insights, insights* |
| 客户 | clients |
| 设备 | devices-general, devices-ap, devices-switch, devices-gateway |
| 无线 | wireless-ssid, wireless-radio, wireless-auth |
| 网络 | network-wan, network-sim-lte*, network-lan, network-routing, network-nat, network-services |
| 防火墙和安全 | firewall-acl, firewall-traffic, firewall-ids, security-threat, security-wids |
| VPN | vpn |
| 简介和时间表 | profiles, schedules, auth-profiles |
| 日志 | logs |
| 控制器和组织 | controller, sites, maintenance, account-users, account-sso*, account-cloud |
| 热点 | hotspot-portal, hotspot-vouchers, hotspot-users* |
| 利基市场 | site-templates, voip, olt, msp |
组别名扩展到其组中的所有类别:
| Alias | 扩展为 |
|---|---|
all |
每个类别 |
devices-all |
devices-general, devices-ap, devices-switch, devices-gateway |
wireless-all |
wireless-ssid, wireless-radio, wireless-auth |
network-all |
network-wan, network-lan, network-routing, network-nat, network-services |
firewall-all |
firewall-acl, firewall-traffic, firewall-ids |
security-all |
security-threat, security-wids |
示例:```bash
Read-only access to everything
OMADA_TOOL_CATEGORIES=all:r
Default safe subset (read only)
OMADA_TOOL_CATEGORIES=dashboard:r,client-insights:r,clients:r,devices-all:r
Full access including write operations
OMADA_TOOL_CATEGORIES=all:rw
Network read + client write operations
OMADA_TOOL_CATEGORIES=network-all:r,clients:rw
#### Omada客户端配置
|变量|必填|默认|描述|
| --------------------- | -------- | ------- | --------------------------------------------------------------------------- |
| `OMADA_BASE_URL` |是|-|Omada控制器的基本URL(例如。, `https://omada-controller.local`) |
| `OMADA_CLIENT_ID` |是|-|Omada平台集成下生成的OAuth客户端ID|
| `OMADA_CLIENT_SECRET` |是|-|与客户端ID关联的OAuth客户端密钥|
| `OMADA_OMADAC_ID` |是|-|Omada控制器ID(omadacId)到目标|
| `OMADA_SITE_ID` |否|-|可选默认站点ID;如果省略,则每个MCP调用都必须传递一个siteId|
| `OMADA_STRICT_SSL` |没有| `true` |强制执行严格的SSL证书验证(设置为 `false` 自签名)|
| `OMADA_TIMEOUT` |没有| `30000` |HTTP请求超时(毫秒)|
#### MCP通用服务器配置
|变量|必填|默认|描述|
| ------------------------ | -------- | ------- | --------------------------------------------------------------------------- |
| `MCP_SERVER_LOG_LEVEL` |没有| `info` |记录冗长(`debug`, `info`, `warn`, `error`, `silent`) |
| `MCP_SERVER_LOG_FORMAT` |没有| `plain` |日志输出格式(`plain`, `json`,或 `gcp-json`) |
| `MCP_SERVER_USE_HTTP` |没有| `false` |启动HTTP服务器而不是stdio|
> **会话ID和身份验证:** 当 `OMADA_CLIENT_ID`, `OMADA_CLIENT_SECRET`,以及 `OMADA_OMADAC_ID` 如果提供了(默认客户端凭据模式),服务器将无状态运行并处理 `Mcp-Session-Id` 标题为可选。未来基于OAuth的用户身份验证模式将再次需要此标头。
#### MCP服务器HTTP配置
这些变量仅在以下情况下使用 `MCP_SERVER_USE_HTTP=true`:
|变量|必填|默认|描述|
| ------------------------------ | -------- | ------------------------------- | --------------------------------------------------------------------------- |
| `MCP_HTTP_PORT` |没有| `3000` |HTTP服务器的端口|
| `MCP_HTTP_BIND_ADDR` |没有| `127.0.0.1` |绑定地址(IPv4/IPv6)。使用更高的IP地址向网络公开|
| `MCP_HTTP_PATH` |没有| `/mcp` |MCP端点的基本路径|
| `MCP_HTTP_ENABLE_HEALTHCHECK` |没有| `true` |启用健康检查端点|
| `MCP_HTTP_HEALTHCHECK_PATH` |没有| `/healthz` |健康检查端点的路径|
| `MCP_HTTP_ALLOW_CORS` |没有| `true` |为HTTP服务器启用CORS|
| `MCP_HTTP_ALLOWED_ORIGINS` |没有| `127.0.0.1, localhost` |以逗号分隔的允许来源列表。使用 `*` 允许所有(仅限开发人员)|
| `MCP_HTTP_NGROK_ENABLED` |没有| `false` |使用ngrok公开HTTP服务器|
| `MCP_HTTP_NGROK_AUTH_TOKEN` |无|-|Ngrok身份验证令牌(如果是必需的 `MCP_HTTP_NGROK_ENABLED=true`) |
创建一个 `.env` 文件(被git忽略)或在启动服务器之前导出变量。
### 发展```bash
npm run dev
开发模式通过实时重新加载支持来保持TypeScript服务器运行 tsx.
建筑```bash
npm run build
### 代码检查```bash
npm run check
测试
单元测试```bash
npm test # run all unit tests
npm run test:watch # watch mode
npm run test:coverage # with coverage report
覆盖阈值:
|级别|度量|阈值|
|-------|--------|-----------|
|每个文件|行、语句、函数|90%|
|全球|分支机构|70%|
#### 集成测试(Docker)
> 尚未实施——本节记录了 **计划的** 跟踪集成测试策略 **#57** 和 **#58**.
集成测试将在Docker容器中针对真实的Omada软件控制器运行。他们是 **不** 计划在每个PR上运行——它们是一个里程碑式的发布门户,也是编写工具的测试工具。
规划布局:
- `test/docker/` (组合+快照/种子工具)
- `tests/integration/`
- `npm run test:integration`
> ⚠️ **第二阶段的写工具必须只针对Docker控制器进行测试,而不能针对生产控制器进行测试。**
### 运行MCP服务器```bash
npm start
MCP服务器通过标准输入和输出进行通信。通过参考以下内容将其与MCP兼容客户端集成 npm start 命令并提供所需的环境变量。
Docker镜像
提供容器映像以运行MCP服务器:```bash
npm run docker:build # Build the Docker image (tag: jmtvms/tplink-omada-mcp:latest)
npm run docker:run # Launch the container with your .env file
npm run docker:push # Push the image to Docker Hub
你也可以直接从Docker Hub中提取预构建的镜像:```bash
docker pull jmtvms/tplink-omada-mcp:latest
同一映像支持stdio和HTTP传输-使用环境变量(例如set)配置所需的模式 MCP_SERVER_USE_HTTP=true 用于HTTP模式)。
使用MCP检查器进行调试
使用MCP检查器在不离开浏览器的情况下交互式测试工具、资源和提示。检查器会自动适应您的 .env 配置:
-
npm run inspector--根据您的.env设置: -
如果
MCP_SERVER_USE_HTTP=false(或未设置):在stdio模式下运行服务器tsx src/index.ts用于实时重新加载调试 -
如果
MCP_SERVER_USE_HTTP=true:在配置的端口/传输上连接到已运行的HTTP服务器(首先使用以下命令启动服务器npm run dev) -
npm run inspector:build--首先编译项目,然后对生产构建启动检查器(dist/index.js)以验证释放奇偶性。还基于以下内容适应stdio或HTTP模式.env.
要求: 检查员要求 .env 存储库根目录下的文件。它将同时加载 .env 和 .env.local (如果存在)以确定服务器模式、端口、传输和路径。
MCP Inspector工具会自动绑定到localhost并生成用于身份验证的会话令牌(打印到控制台并自动填写在浏览器URL中)。
传输协议
MCP服务器使用 可流式传输的HTTP 运输,实现 MCP协议版本2025-03-26.```bash
export MCP_SERVER_USE_HTTP=true
npm run dev
特征:
- 所有操作(GET、POST、DELETE)的单一端点
- 服务器发送流式响应事件
- 使用加密会话ID的内置会话管理(服务器在使用客户端凭据时当前无状态运行)
端点默认为 `/mcp` 手柄:
- `GET /mcp` -建立SSE流并初始化会话
- `POST /mcp` -发送JSON-RPC消息
- `DELETE /mcp` -终止会话
#### 安全注意事项
默认情况下启用DNS重新绑定保护:
- **原产地验证**:服务器验证 `Origin` 所有传入连接上的标头。配置允许的来源 `MCP_HTTP_ALLOWED_ORIGINS` (默认值: `127.0.0.1, localhost`).使用 `*` 允许所有来源(仅用于开发,不建议用于生产)。
- **网络绑定**:服务器绑定到 `127.0.0.1` 默认情况下,仅限制对localhost的访问。集 `MCP_HTTP_BIND_ADDR=0.0.0.0` 将服务器暴露到您的网络中(不建议在没有额外安全措施的情况下用于生产)。
有关MCP协议和传输的更多信息,请参阅 模型上下文协议文档.
### HTTP传输使用情况
使用以下命令启动HTTP传输:```bash
# Start with HTTP enabled
export MCP_SERVER_USE_HTTP=true
npm run dev # live reload during development
npm run start # run the compiled output
默认情况下,服务器会监听 127.0.0.1:3000 并在以下位置暴露MCP端点 /mcp 进行健康检查 /healthz.使用可选配置绑定地址、端口和路径 MCP_HTTP_* 环境变量记录在 .env.exampleThe npm run docker:run:http helper包装HTTP映像并自动发布端口。
使用ngrok
要与远程工具共享本地服务器,可以使用ngrok公开HTTP服务器。
选项1:内置ngrok支持(推荐)
设置以下环境变量:```bash
export MCP_HTTP_NGROK_ENABLED=true
export MCP_HTTP_NGROK_AUTH_TOKEN=your-ngrok-auth-token
npm run dev
服务器将自动建立ngrok隧道并记录公共URL。
##### 选项2:手动ngrok设置
启动服务器后,在单独的终端中运行ngrok:```bash
ngrok http 3000
这会将公共HTTPS URL转发到 http://localhost:3000 并在控制台中打印隧道地址。
在客户端凭据模式下,服务器已经处理 Mcp-Session-Id 可选;如果在传输过程中删除了标头,请求仍然会成功。
工具
现场和客户
| 工具 | 说明 |
|---|---|
listSites |
列出控制器上配置的所有站点。 |
getSiteCapacity |
获取站点容量设置,包括最大设备和客户端数量。 |
getSiteDetail |
获取有关站点的详细信息,包括名称、地区、时区和配置。 |
getSiteDeviceAccount |
获取站点的设备帐户设置。 |
getSiteNtpStatus |
获取站点的NTP服务器状态和配置。 |
getSiteRememberSetting |
获取站点的记住设备设置。 |
getSiteSpecification |
获取站点规范,包括设备限制和功能。 |
getSiteUrl |
获取与OpenAPI访问站点关联的URL。 |
getSiteTemplateConfig |
获取站点模板的配置设置。需要 siteTemplateId. |
getSiteTemplateDetail |
获取有关网站模板的详细信息。需要 siteTemplateId. |
getSiteTemplateList |
列出控制器上配置的所有站点模板。 |
listClients |
列出站点的活动客户端设备。 |
getClient |
[失望]使用 listClients 相反。当你有一个客户端MAC时, getClientDetail 也可用。此工具在进程中过滤站点客户端列表。 |
listMostActiveClients |
获取按流量使用情况排序的最活跃客户端。 |
listClientsActivity |
获取随时间变化的客户端活动统计信息。 |
listClientsPastConnections |
获取客户端的过去连接历史记录。 |
setClientRateLimit |
为特定客户端设置自定义带宽限制(下载/上传)。 |
setClientRateLimitProfile |
将预定义的速率限制配置文件应用于特定客户端。 |
disableClientRateLimit |
禁用特定客户端的带宽速率限制。 |
设备
| 工具 | 说明 |
|---|---|
listDevices |
列出给定站点的已配置设备。 |
getDevice |
[失望]使用 listDevices 而是在客户端过滤结果。此工具在进程中过滤站点设备列表;没有专用的设备详细信息端点。 |
searchDevices |
在用户有权访问的所有站点上全局搜索设备 |
listDevicesStats |
通过分页和过滤查询全球采用的设备的统计数据 |
getSwitchStackDetail |
检索交换机堆栈的详细配置和状态。 |
getSwitchDetail |
获取特定交换机的详细配置和状态。 |
getGatewayDetail |
获取特定网关的详细配置和状态。 |
getGatewayWanStatus |
获取特定网关的WAN端口状态。 |
getGatewayLanStatus |
获取特定网关的LAN端口状态。 |
getGatewayPorts |
获取特定网关的端口信息。 |
getApDetail |
获取特定接入点的详细配置和状态。 |
getApRadios |
获取特定接入点的无线电信息。 |
getStackPorts |
获取交换机堆栈的端口信息。 |
listPendingDevices |
列出站点中待采用的设备。 |
getAllDeviceBySite |
获取站点中的所有设备,包括脱机和断开连接的设备。 |
getFirmwareInfo |
获取设备的最新可用固件信息。使用 listDevices 对于MAC。 |
getGridAutoCheckUpgrade |
获取自动检查固件升级计划列表(分页)。 |
listSwitchNetworks |
列出交换机的VLAN网络分配(分页)。需要 switchMac. |
getSwitchGeneralConfig |
获取交换机的常规配置。需要 switchMac. |
getCableTestLogs |
获取交换机的电缆测试历史记录。需要 switchMac. |
getCableTestFullResults |
获取交换机的完整每端口电缆诊断。需要 switchMac. |
getOswStackLagList |
获取交换机堆栈的链路聚合组(LAG)列表。需要 stackId. |
getStackNetworkList |
获取交换机堆栈的VLAN网络列表(分页)。需要 stackId. |
getApUplinkConfig |
获取AP的上行链路配置(有线/网状模式)。需要 apMac. |
getRadiosConfig |
获取AP的每个无线电配置(信道、功率、宽度)。需要 apMac. |
getApVlanConfig |
获取接入点的VLAN配置,包括管理VLAN和每个SSID的VLAN标记设置。 |
getMeshStatistics |
获取AP的网格链接统计信息。需要 apMac. |
getRFScanResult |
获取AP的上次射频扫描结果。需要 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的中继端口设置。需要 apMac. |
getSitesApsBridge |
获取AP的网桥配置。需要 apMac. |
listSitesApsPorts |
列出AP的端口。需要 apMac. |
getSitesSwitchesEs |
获取ES开关的详细信息。需要 switchMac. |
getSitesSwitchesEsGeneralConfig |
获取ES交换机的常规配置。需要 switchMac. |
listSitesCableTestSwitchesPorts |
列出交换机的电缆测试端口信息。需要 switchMac. |
listSitesCableTestSwitchesIncrementResults |
获取交换机的增量电缆测试结果。需要 switchMac. |
getUpgradeOverviewCritical |
获取可用于升级的关键型号的数量。 |
getUpgradeOverviewTryBeta |
获取试用版固件升级开关的当前状态。 |
listUpgradeFirmwares |
列出可用于升级的固件包(分页)。 |
listUpgradeOverviewFirmwares |
列出可升级设备的固件概述(分页)。 |
listSitesStacks |
列出站点中的开关堆栈(分页)。 |
getSitesDeviceWhiteList |
获取站点的设备采用白名单(分页)。 |
getSitesGatewaysGeneralConfig |
获取网关的常规配置。需要 gatewayMac. |
getSitesGatewaysPin |
获取网关的PIN信息。需要 gatewayMac. |
getSitesGatewaysSimCardUsed |
获取网关的SIM卡使用信息。需要 gatewayMac. |
getSitesHealthGatewaysWansDetails |
获取网关广域网健康详细信息。需要 gatewayMac. |
网络
| 工具 | 说明 |
|---|---|
getInternetInfo |
获取站点的internet配置信息。 |
getInternet |
[失望]使用 getInternetInfo 相反。获取站点网关的完整WAN/Internet配置。 |
getInternetBasicPortInfo |
获取站点网关的WAN端口摘要/基本信息。 |
getInternetLoadBalance |
获取WAN负载平衡配置(故障转移/负载平衡)。 |
getWanPortsConfig |
获取每个端口的WAN配置,包括连接类型和IP设置。 |
getWanLanStatus |
获取站点的WAN-LAN连接状态。 |
getGridVirtualWan |
获取虚拟广域网列表(分页)。 |
getIspBandScan |
获取WAN端口的ISP频带扫描结果。需要 portUuid. |
getDisableNatList |
获取禁用NAT的有线网络列表(分页)。 |
getLtePortConfig |
获取LTE/蜂窝广域网端口配置。 |
getWanPortDetail |
[失望]使用 getWanPortsConfig 相反。获取所有网关WAN端口的详细WAN端口配置。 |
getWanIspProfile |
获取WAN端口的ISP扫描配置文件结果。需要 portUuid. |
getWanQosConfig |
获取网关WAN端口的QoS配置。 |
getWanHealthDetail |
[失望]广域网健康工具的别名;保持向后兼容性。需要 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 |
获取接口级LAN网络绑定(v2 API)。返回更丰富的每个接口的VLAN和网络数据。 |
getLanProfileList |
获取站点中配置的LAN配置文件列表。 |
getApLoadBalance |
[失望]使用 getSitesApsLoadBalance 相反。相同的端点,保留以实现向后兼容性。getSitesApsLoadBalance是规范的工具名称。 |
getApOfdmaConfig |
[失望]使用 getSitesApsOfdma 相反。相同的端点,保留以实现向后兼容性。getSitesApsOfdma是规范工具名称。 |
getMulticastRateLimit |
获取站点的多播速率限制设置。 |
getWlanGroupList |
获取站点中配置的WLAN组的列表。 |
getSsidList |
获取WLAN组中的SSID列表。 |
getSsidDetail |
获取特定SSID的详细信息。必修的: wlanId 和 ssidId. |
listAllSsids |
列出所有WLAN组中的无线SSID。 |
getFirewallSetting |
获取站点的防火墙配置和规则。 |
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 |
获取1:1 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 |
获取局域网配置文件的EAP/交换机设备使用情况。需要 profileId. |
getLanClientCount |
获取跨LAN段的客户端分布明细。 |
listRadiusProfiles |
列出RADIUS身份验证配置文件。 |
listGroupProfiles |
列出组配置文件(IP、MAC或端口组)。 |
getApplicationControlStatus |
获取站点的应用程序控件状态。 |
getSshSetting |
获取站点的SSH设置。 |
listTimeRangeProfiles |
列出时间范围配置文件。 |
getRateLimitProfiles |
获取带宽控制的可用速率限制配置文件的列表。 |
防火墙和ACL
| 工具 | 说明 |
|---|---|
getDot1xConfig |
获取802.1X交换机端口身份验证设置。别名为 getSwitchDot1xSetting. |
getRadiusProxyConfig |
获取全局RADIUS代理配置(控制器级别,无siteId)。 |
getApplicationAcl |
[失望]获取应用程序控制规则。别名为 getAppControlRules. |
防火墙流量和QoS
| 工具 | 说明 |
|---|---|
getGatewayQosClassRules |
获取网关QoS类规则(分页)。 |
getBandwidthCtrlDetail |
获取站点的带宽控制详细信息。 |
getAppControlRules |
获取应用程序控制规则(分页)。 |
getAppControlCategories |
获取应用程序控制类别列表。 |
getUrlFilterRules |
获取URL筛选器网关规则。别名为 getGridGatewayRule. |
getUrlFilterBlacklist |
获取URL筛选器MAC拒绝列表。别名为 getGridDenyMacFiltering. |
getUrlFilterWhitelist |
获取URL筛选器MAC允许列表。别名为 getGridAllowMacFiltering. |
getMacFilterDetail |
获取MAC过滤器常规设置。别名为 getMacFilteringGeneralSetting. |
getQosPolicy |
获取站点的QoS策略配置。 |
getTrafficPriority |
获取站点的流量优先级规则。 |
getTrafficStats |
[失望]使用 getDashboardTrafficActivities 相反。获取广域网使用统计数据。别名为 getWanUsageStats. |
getQosPolicyRule |
[失望]别名 getQosPolicy. |
getQosMarkingRule |
[失望]别名 getQosPolicy. |
getDscpConfig |
[失望]别名 getQosPolicy. |
防火墙IDS/IPS
| 工具 | 说明 |
|---|---|
getGlobalSecuritySetting |
[失望]使用 getThreatList 相反。获取全球安全/威胁管理列表。别名为 getThreatList. |
安全与威胁管理
| 工具 | 说明 |
|---|---|
getThreatList |
获取全局威胁管理列表。必修的: archived (bool)。可选: startTime/endTime (自纪元以来的秒数), severity (0=严重,1=严重,2=中等/一般,3=轻微,4=低), page, pageSize. |
getTopThreats |
从全局威胁管理视图获取顶级威胁。 |
仪表板/监视器
| 工具 | 说明 |
|---|---|
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检测到的顶级射频干扰源。 |
getGridDashboardTunnelStats |
获取VPN隧道统计信息。必修的: type (0=服务器,1=客户端)。 |
getGridDashboardIpsecTunnelStats |
获取IPsec隧道统计信息。 |
getGridDashboardOpenVpnTunnelStats |
按类型获取OpenVPN隧道统计信息。需要 type 参数。 |
洞察
| 工具 | 说明 |
|---|---|
listSiteThreatManagement |
列出站点级威胁管理事件。 |
getWids |
获取站点的WIDS(无线入侵检测)信息。 |
getRogueAps |
获取在站点中检测到的恶意访问点。 |
getVpnTunnelStats |
获取站点的VPN隧道统计信息。 |
虚拟专用网络
| 工具 | 说明 |
|---|---|
getIpsecTunnelList |
列出所有站点到站点VPN(IPsec)隧道。别名为 listSiteToSiteVpns. |
getIpsecTunnelDetail |
按ID获取特定IPsec隧道的详细配置。别名 getSiteToSiteVpnInfo. |
getAdvancedVpnSetting |
获取站点的高级VPN配置设置。别名为 getVpnSettings. |
getVpnUserList |
获取网站的VPN用户(分页)。 |
getVpnUserDetail |
获取特定客户端到站点VPN服务器的用户。 |
getVpnClientStatus |
获取客户端到站点VPN客户端的状态。别名为 listClientToSiteVpnClients. |
getVpnRouteConfig |
[失望]使用 getGridPolicyRouting 相反。此工具聚合所有页面;getGridPolicyRouting已分页。 |
档案
| 工具 | 说明 |
|---|---|
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 |
获取网站的专属门户配置文件。 |
日志
| 工具 | 说明 |
|---|---|
listSiteEvents |
列出站点事件日志。 |
listSiteAlerts |
列出站点警报日志。 |
listSiteAuditLogs |
列出站点审核日志。 |
listGlobalEvents |
列出所有站点的全局事件日志。 |
listGlobalAlerts |
列出所有站点的全局警报日志。 |
控制器
| 工具 | 说明 |
|---|---|
getCertificate |
获取控制器的SSL/TLS证书配置。 |
getClientHistoryDataEnable |
获取客户端历史数据收集启用设置。 |
getControllerPort |
获取设备采用的控制器端口配置。 |
getDataRetention |
获取控制器的数据保留设置。 |
getExperienceImprovement |
获取体验改善程序设置(遥测)。 |
getGlobalDashboardOverview |
获取全局控制器仪表板概览,无需客户端数据。 |
getPortalPort |
获取控制器web界面的入口端口配置。 |
维护
| 工具 | 说明 |
|---|---|
getBackupFileList |
列出可用的控制器备份文件。 |
getBackupResult |
获取最近一次控制器备份操作的结果。 |
getRestoreResult |
获取最近一次控制器还原操作的结果。 |
getSiteBackupFileList |
列出站点的可用备份文件。 |
getSiteBackupResult |
获取站点的备份结果。 |
帐户用户
| 工具 | 说明 |
|---|---|
getAllCloudUsers |
列出控制器上的所有云用户,不包括root帐户。 |
getAllLocalUsers |
列出控制器上的所有本地用户,不包括root帐户。 |
getAllRoles |
[失望]使用 getUserRoleProfile 相反。列出控制器上配置的所有用户角色。 |
getAllUsersApp |
在网格视图中列出所有用户(云和本地)。 |
getAvailableRoles |
列出可供用户分配的角色。 |
getRoleDetail |
获取特定角色的详细信息。需要 roleId. |
账户云
| 工具 | 说明 |
|---|---|
getCloudAccessStatus |
获取控制器的云访问状态。 |
getCloudUserInfo |
获取云用户帐户信息。 |
getMfaStatus |
获取全局MFA(多因素身份验证)状态。 |
getRemoteBindingStatus |
获取控制器和云之间的远程绑定状态。 |
日程表
| 工具 | 说明 |
|---|---|
getPoeScheduleList |
列出站点的PoE时间表。 |
getPortScheduleList |
列出站点的端口计划。 |
getPortSchedulePorts |
列出具有站点端口计划分配的端口。 |
getRebootScheduleList |
列出站点模板的设备重新启动计划。需要 siteTemplateId. |
getUpgradeScheduleList |
列出站点的固件升级计划。 |
支持的Omada API操作
| 操作ID | 描述 | 工具 |
|---|---|---|
getSiteList |
列出控制器站点。 | listSites |
getDeviceList |
列出分配给站点的设备。 | listDevices, ~~getDevice~~[已弃用] |
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~~[已弃用] |
getMostActiveClients |
按流量对最活跃的客户端进行排序。 | listMostActiveClients |
getClientActivity |
获取一段时间内的客户活动统计数据。 | listClientsActivity |
getGridPastConnections |
获取客户端过去的连接历史记录。 | listClientsPastConnections |
updateClientRateLimitSetting |
为客户端设置速率限制设置。 | setClientRateLimit, setClientRateLimitProfile, disableClientRateLimit |
getRateLimitProfileList |
获取速率限制配置文件列表。 | getRateLimitProfiles |
getGlobalThreatList |
获取全局视图威胁管理列表。 | getThreatList |
getTopThreatList |
从全球威胁管理中获取最大威胁。 | getTopThreats |
getInternet |
[失望]使用 getInternetInfo 相反。获取站点的internet配置信息。 |
getInternetInfo |
getPortForwardStatus |
按类型获取端口转发状态。 | getPortForwardingStatus |
getLanProfileList |
获取局域网配置文件列表。 | getLanProfileList |
getWlanGroupList |
获取WLAN组列表。 | getWlanGroupList |
getSsidList |
获取WLAN组的SSID列表。 | getSsidList |
getSsidDetail |
获取详细的SSID配置。 | getSsidDetail |
getSsidListAll |
列出所有WLAN组中的SSID。 | listAllSsids |
getFirewallSetting |
获取站点的防火墙配置。 | getFirewallSetting |
getVpn |
获取网站的VPN设置。 | getVpnSettings |
getSiteToSiteVpnList |
列出站点到站点的VPN配置。 | listSiteToSiteVpns |
getPortForwardingList |
列出NAT端口转发规则。 | getPortForwardingList (首选); ~~listPortForwardingRules~~[已弃用] |
getOsgAclList |
列出网关ACL规则。 | listOsgAcls |
getEapAclList |
列出访问点ACL规则。 | listEapAcls |
getStaticRoutingList |
列出静态路由规则。 | getGridStaticRouting (首选); ~~listStaticRoutes~~[已弃用] |
getRadiusProfileList |
列出RADIUS身份验证配置文件。 | listRadiusProfiles |
getGroupProfileList |
列出组配置文件(IP、MAC、端口组)。 | listGroupProfiles |
getApplicationControlStatus |
获取站点的应用程序控制状态。 | getApplicationControlStatus |
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 |
getAlg |
获取站点网关的ALG(应用层网关)配置。 | getAlg |
getAllDeviceBySite |
获取站点中的所有设备,包括脱机和断开连接的设备。 | getAllDeviceBySite |
getApDetail |
获取特定接入点的完整配置和状态:mo | getApDetail |
…(正文过长,页面只展示前面部分,完整内容见仓库)
