通过vManage API将vEdge从vManage模式转换为CLI模式
目录
简介
本文档介绍如何通过vManage API将vEdge从vManage模式转换为CLI模式。
先决条件
要求
Cisco 建议您了解以下主题：
- 思科软件定义的广域网(SD-WAN)
- POSTMAN
使用的组件
本文档中的信息基于以下软件和硬件版本：
- 思科vManager版本20.9.4
- 思科vEdge版本20.9.4
- Postman 版本11.63.0
本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始（默认）配置。如果您的网络处于活动状态，请确保您了解所有命令的潜在影响。
背景信息
- Cisco SD-WAN vManage API是用于控制、配置和监控重叠网络中的Cisco设备的REST API接口。
- REST架构使用无状态、客户端 — 服务器和可缓存的通信协议。
- 演示状态传输(REST)是一种用于设计Web服务应用的架构样式。
- 测试API调用可以从swagger UI中尝试。
- 有时，无法通过GUI界面修改浏览器的管理模式。在这种情况下，选择通过API修改管理模式是另一种可行的方法。
- vManage API文档可通过https://<vmanage_ip>:<port>/apidocs访问，以备有关可用API调用的参考。
URL结构组件
https://<vmanage_ip>:<port>/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode
|
命令属性 |
命令语法 |
描述 |
|
协议 |
http:// 或 https:// |
在客户端和服务器之间发送数据时所依据的协议 |
|
服务器或主机 |
<vmanage-ip:port> |
解析为要连接的IP和端口 |
|
资源 |
/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode |
感兴趣的数据或对象的位置 |
访问板载API文档
vManage onboard API文档位于URL https://<vmanage_ip>:<port:>/apidocs。 本文档显示当前软件版本上可用的API。
这要求使用有效的vManage凭证登录。 虽然多个权限级别可以查看文档，但只有netadmin用户能够执行所有权限级别。
注意：API文档页面可供多租户环境中的租户使用，但某些命令仅限提供商使用。
vManage然后显示可用API类别的列表。 点击所需的类别，然后点击API调用本身，将显示以下字段：
|
说明/实施说明 |
所执行操作的说明。 |
|
参数 |
为API调用指定所需的参数。 |
|
请求正文(POST/PUT/DELETE) |
请求正文的格式。 |
|
响应 |
vManage发送到API的可能响应。 其中包括HTTP状态代码、原因和可能的响应正文。 |
|
分机 |
呼叫的有效分机。 |
注意：从20.6版本开始，系统引入以下速率限制：批量API:每分钟48个请求所有其他API:每秒100个请求。
警告：实时监控API占用了CPU资源，只能用于故障排除，而不能用于持续监控。
从文档工具测试API
第1步：登录到vManage GUI以检查vEdge的管理模式是否为vManage
第2步：将URL修改为LoginCisco SD-WAN vManage API
第3步：导航到Cisco SD-WAN vManage API中的配置 — 模板配置
第4步：单击试用按钮
第5步：更改设备ID和DeviceIP
- deviceId == uuid
- deviceIP == local-system-ip
第6步：点击执行按钮
第7步：检查vManage GUI中的vEdge模式
版本管理模式已从vManage状态切换到CLI状态。
从Postman工具测试API
步骤 1：登录到vManage并获取会话Cookie
请求方法:POST
URL:https://<vmanage-ip>/j_security_check
Postman配置
标头：Content-Type:application/x-www-form-urlencoded
正文类型：x-ww-form-urlencoded
正文内容：
- j_username=admin
- j_password=xxx
成功登录后，vManage返回JSESSIONID的Cookie;Cookie将自动保存。
步骤 2：获取CSRF令牌
请求方法:GET
URL:https://<vmanage-ip>/dataservice/client/token
Postman配置
标头：Content-Type:application/x-www-form-urlencoded
正文类型：x-ww-form-urlencoded
正文内容：
- j_username=admin
- j_password=xxx
第3步：获取设备UUID和IP
请求方法:GET
URL:https://<vmanage-ip>/dataservice/template/config/device/mode/vmanage?type=vedge
Postman配置
标头：
- 内容类型：application/json
- X-XSRF-TOKEN:E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
正文类型：x-ww-form-urlencoded
正文内容：
- j_username=admin
- j_password=xxx
步骤 4：解除vEdge的配置模板的绑定
请求方法:POST
URL:https://<vmanage-ip>/dataservice/template/config/device/mode/cli
Postman配置
标头：
- accept:application/json
- 内容类型：application/json
- X-XSRF-TOKEN:E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
正文类型：raw(JSON)
正文内容：
{"deviceType":"vedge","devices":[{"deviceId":"cfca8af1-8f4d-faba-xxx","deviceIP":"xxx"}]}
相关信息
修订历史记录
| 版本 | 发布日期 | 备注 |
|---|---|---|
1.0 |
26-Sep-2025
|
初始版本 |
反馈