Converter vEdge do modo vManage para o modo CLI pela API do vManage
Contents
Introdução
Este documento descreve como converter o vEdge do modo vManage para o modo CLI pela API do vManage.
Pré-requisitos
Requisitos
A Cisco recomenda que você tenha conhecimento destes tópicos:
- Rede de longa distância definida por software da Cisco (SD-WAN)
- POSTMAN
Componentes Utilizados
As informações neste documento são baseadas nestas versões de software e hardware:
- Cisco vManager versão 20.9.4
- Cisco vEdge versão 20.9.4
- Postman versão 11.63.0
As informações neste documento foram criadas a partir de dispositivos em um ambiente de laboratório específico. Todos os dispositivos utilizados neste documento foram iniciados com uma configuração (padrão) inicial. Se a rede estiver ativa, certifique-se de que você entenda o impacto potencial de qualquer comando.
Informações de Apoio
- O Cisco SD-WAN vManage API é uma interface de API REST para controlar, configurar e monitorar os dispositivos Cisco em uma rede de sobreposição.
- A arquitetura REST usa um protocolo de comunicação sem estado, cliente-servidor, armazenável em cache.
- REpresentational State Transfer (REST) é um estilo de arquitetura para projetar aplicativos de serviços da Web.
- As chamadas de API de teste podem ser tentadas a partir da interface do usuário swagger.
- Às vezes, é impossível modificar o modo de gerenciamento de vedge através da interface GUI. Nesses casos, optar por modificar o modo de gerenciamento por meio da API é outra abordagem viável.
- A documentação da API do vManage pode ser acessada via https://<vmanage_ip>:<port>/apidocs para referência em chamadas de API disponíveis.
Componentes da estrutura de URL
https://<vmanage_ip>:<port>/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode
|
Propriedades do comando |
Sintaxe do comando |
Descrição |
|
Protocolo |
http:// ou https:// |
Protocolo sobre o qual os dados são enviados entre cliente e servidor |
|
Servidor ou Host |
<vmanage-ip:port> |
Resolve para o IP e a porta à qual se conectar |
|
Recurso |
/apidocs/#/Configuração%20-%20Modelo%20Configuração/updateDeviceToCLIMode |
O local dos dados ou objeto de interesse |
Acesse a documentação da API integrada
A documentação da API integrada do vManage está no URL https://<vmanage_ip>:<port:>/apidocs. Esta documentação exibe as APIs disponíveis na versão de software atual.
Isso requer login com credenciais vManage válidas. Embora vários níveis de privilégio possam exibir a documentação, apenas um usuário netadmin pode executar todos eles.
Note: A página de documentação da API está disponível para usuários em um ambiente multilocatário, no entanto, determinados comandos são restritos apenas ao provedor.
O vManage exibe uma lista de categorias de APIs disponíveis. Clique na categoria desejada, seguida da chamada API propriamente dita, que exibe estes campos:
|
Descrição/Notas de implementação |
Descrição da operação executada. |
|
Parâmetros |
Parâmetros necessários a serem especificados para a chamada à API. |
|
Corpo da solicitação (POST/PUT/DELETE) |
Formato do corpo da solicitação. |
|
Respostas |
Possíveis respostas que o vManage envia à API. Isso inclui o código de status HTTP, o motivo e o possível corpo da resposta. |
|
Extensões |
Ramais válidos para a chamada. |
Note: A partir da versão 20.6, o sistema introduz estes limites de taxa: API em massa: 48 solicitações/minuto Todas as outras API: 100 solicitações/segundo.
aviso: As APIs de monitoramento em tempo real exigem muito da CPU e devem ser usadas somente para solução de problemas, não para monitoramento contínuo.
Testar APIs da Ferramenta de Documentação
Etapa 1: Faça login na GUI do vManage para verificar se o modo de gerenciamento do vEdge é vManage
Etapa 2:Modificar a URL para LoginAPI Cisco SD-WAN vManage
Login https://10.124.x.x/apidocs/
Etapa 3: Navegue até Configuração - Modelo Configuração na API do Cisco SD-WAN vManage
Etapa 4: botão ClickTry it out
Etapa 5:Alterar DeviceId e DeviceIP
- deviceId == uuid
- deviceIP == local-system-ip
Etapa 6:Clique no botão Executar
Etapa 7:Verificar o modo vEdge na GUI do vManage
O modo de gerenciamento de borda foi alterado do status vManage para o status CLI.
APIs de teste da ferramenta Postman
Passo 1: Faça login no vManage e obtenha o cookie de sessão
Método de solicitação: POST
URL: https://<vmanage-ip>/j_security_check
Configuração do Postman
Cabeçalhos: Tipo de conteúdo:aplicativo/x-www-form-urlencoded
Tipo de corpo: x-ww-form-urlencoded
Conteúdo do corpo:
- j_username=admin
- j_password=xxx
Após um login bem-sucedido, o vManage retorna o Cookie de JSESSIONID; os Cookies são salvos automaticamente.
Passo 2: Obtenha o token CSRF
Método de solicitação: GET
URL: https://<vmanage-ip>/dataservice/client/token
Configuração do Postman
Cabeçalhos: Tipo de conteúdo:aplicativo/x-www-form-urlencoded
Tipo de corpo: x-ww-form-urlencoded
Conteúdo do corpo:
- j_username=admin
- j_password=xxx
Etapa 3:Obter o UUID e o IP do dispositivo
Método de solicitação: GET
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/vmanage?type=vedge
Configuração do Postman
Cabeçalhos:
- Tipo de conteúdo:aplicativo/json
- TOKEN X-XSRF: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Tipo de corpo: x-ww-form-urlencoded
Conteúdo do corpo:
- j_username=admin
- j_password=xxx
Passo 4: Desassociar o modelo de configuração do vEdge
Método de solicitação: POST
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/cli
Configuração do Postman
Cabeçalhos:
- aceitar:aplicativo/json
- Tipo de conteúdo:aplicativo/json
- TOKEN X-XSRF: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Tipo de corpo: bruto (JSON)
Conteúdo do corpo:
{"deviceType":"vedge","devices":[{"deviceId":"cfca8af1-8f4d-faba-xxx","deviceIP":"xxx"}]}
Informações Relacionadas
Histórico de revisões
| Revisão | Data de publicação | Comentários |
|---|---|---|
1.0 |
26-Sep-2025
|
Versão inicial |
FeedbackContate a Cisco
- Abrir um caso de suporte
- (É necessário um Contrato de Serviço da Cisco)