具有 Wired Assurance 的 API
与 Wired Assurance 相关的主要有三个主要 URI 端点:
-
网络模板
-
网站设置
-
交换机设置
网络模板
文档位于此处的 RF 模板下方: https://api.mist.com/api/v1/docs/Org#rf-template
-
创建网络模板
-
帖子: https://api.mist.com/api/v1/orgs/:org_id/networktemplates
-
有效负载:JSON 格式的有效负载
-
必填:名称
-
-
获取网络模板列表
-
GET: /api/v1/orgs/:org_id/networktemplates
-
有效负载:无
-
过滤器:id、名称
-
-
获取网络模板
-
更新网络模板
- 放置: /api/v1/orgs/:org_id/networktemplates/:networktemplate_id
- 有效负载:JSON 格式的有效负载(仅需要更改/添加)
-
删除网络模板
网站设置
文档位于此处: https://api.mist.com/api/v1/docs/Site#site-setting
-
获取网站设置
*包括开关和非开关相关设置*
- GET: /api/v1/sites/:site_id/setting
- 有效负载:无
- 更新站点设置:
- PUT: /api/v1/sites/:site_id/setting
- 有效负载:JSON 格式的有效负载(仅需要更改/添加)
- 要将此站点链接到模板,请添加“networktemplate_id”键以及要应用的网络模板的 ID 值。
- 注意:站点设置没有开机自检或删除功能。创建网站设置的唯一方法是创建新网站,而删除这些设置的唯一当前方法是删除网站。
交换机设置
交换机设置
文档位于此处: https://api.mist.com/api/v1/docs/Site#device
- 获取交换机设置:
- GET: /api/v1/sites/:site_id/devices/:d evice_id
- 有效负载:无
- 更新交换机设置:
- PUT: /api/v1/sites/:site_id/devices/:d evice_id
- 有效负载:JSON 格式的有效负载(仅需要更改/添加)
- 重置交换机设置:
- POST: /api/v1/sites/:site_id/devices/:d evice_id
- 有效负载:无或 JSON
- 这有效地删除了在交换机设置中定义的配置,并将其替换为任何内容或有效负载中传递的任何内容。如果您搞砸了并且需要在重新配置之前重置设置,则非常有用。
- 注意:API 文档中目前缺少此功能。我们目前正在努力重新添加它。你可以在 django API 浏览器中找到它。
-
获取交换机配置命令:
这将返回 Mist 将推送到交换机的配置集命令。请注意,这不包括基本连接(棕地配置代码段或绿地配置),仅包括通过 Mist 中的模板/站点/交换机配置推送的设置。
- GET: /api/v1/sites/:site_id/devices/:d evice_id/config_cmd
- 有效负载:无
- 在棕地部署以及在 Mist 中学习和测试 EX 中非常有用。
API 用例
事实来源
随着网络运维的不断发展,真实信息源 (SoT) 正变得越来越重要。这些 SoT 使我们能够描述如何在外部软件应用程序中配置网络,并让该 SoT 直接与 Mist 通信进行配置。
事实来源可以像一组 YAML 或 JSON 数据文件一样简单,也可以像专用应用程序(如 Netbox 或 NSOT)一样复杂。通过 API 基于 SoT 中的数据配置站点和交换机可提供一定程度的控制,并可在站点和设备之间保持一致配置。
面向服务的配置
变更管理是网络运维的重要组成部分。手动更改容易出错且耗时。将变更管理集成到 ServiceNow 等 ITSM 平台中,通过让变更流经适当的变更管理流程,以及减少进行更改的人为错误,有助于简化常见的变更管理请求。有线保证 API 支持 ITSM 平台和有线网络配置之间的这些集成。
继续努力
虽然 API 为我们提供了一些以编程方式配置 EX 交换的直接机会,但其他功能的工作已经在进行中。例如,自动迁移 Cisco IOS 配置,以及使用现有软件库和开源工具将现有瞻博网络 EX 配置自动迁移到 Mist 平台。