vEdge converteren van vManage-modus naar CLI-modus met vManage API
Inhoud
Inleiding
In dit document wordt beschreven hoe vEdge van vManage-modus naar CLI-modus kan worden geconverteerd via vManage API.
Voorwaarden
Vereisten
Cisco raadt kennis van de volgende onderwerpen aan:
- Cisco Software-defined Wide Area Network (SD-WAN)
- postbode
Gebruikte componenten
De informatie in dit document is gebaseerd op de volgende software- en hardware-versies:
- Cisco vManager versie 20.9.4
- Cisco vEdge versie 20.9.4
- Postman versie 11.63.0
De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.
Achtergrondinformatie
- Cisco SD-WAN vManage API is een REST API-interface voor het beheren, configureren en bewaken van Cisco-apparaten in een overlay-netwerk.
- REST-architectuur maakt gebruik van een stateless, client-server, cacheable communicatieprotocol.
- REpresentational State Transfer (REST) is een architectuurstijl voor het ontwerpen van webservicetoepassingen.
- Test API-oproepen kunnen worden uitgeprobeerd vanuit swagger UI.
- Soms is het onmogelijk om de beheermodus van vedge via de GUI-interface aan te passen. In dergelijke gevallen is het kiezen van de beheermodus via de API een andere haalbare aanpak.
- De documentatie van de vManage API is toegankelijk via https://<vmanage_ip>:<port>/apidocs voor referentie over beschikbare API-oproepen.
URL-structuurcomponenten
https://<vmanage_ip>:<port>/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode
|
Opdrachteigenschappen |
opdrachtsyntaxis |
Beschrijving |
|
Protocol |
http:// of https:// |
Protocol over welke gegevens tussen client en server worden verzonden |
|
Server of host |
<vManage-IP:Port> |
Lost de IP en poort op waarop verbinding moet worden gemaakt |
|
Bron |
/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode |
De locatie van de gegevens of het object van belang |
Toegang tot on-board API-documentatie
vManage on-board API-documentatie bevindt zich op de URL https://<vmanage_ip>:<port:>/apidocs. In deze documentatie worden API's weergegeven die beschikbaar zijn in de huidige softwareversie.
Hiervoor moet u zich aanmelden met geldige vManage-referenties. Hoewel meerdere privilege levels documentatie kunnen bekijken, kan alleen een netadmin gebruiker ze allemaal uitvoeren.
Opmerking: de API-documentatiepagina is beschikbaar voor huurders in een multitenant-omgeving, maar bepaalde opdrachten zijn beperkt tot de provider.
vManage geeft vervolgens een lijst weer met categorieën van beschikbare API's. Klik op de gewenste categorie, gevolgd door de API-aanroep zelf, die de volgende velden weergeeft:
|
Beschrijving/Implementatienota's |
Beschrijving van de uitgevoerde operatie. |
|
parameters |
Vereiste parameters die moeten worden opgegeven voor de API-aanroep. |
|
Aanvraaginstantie (POST/PUT/DELETE) |
Formaat van het verzoekorgaan. |
|
Reacties |
Mogelijke antwoorden die vManage naar de API stuurt. Dit omvat HTTP-statuscode, reden en de mogelijke responsbody. |
|
Extensies |
Geldige extensies voor de oproep. |
Opmerking: Vanaf de 20.6-release introduceert het systeem deze tarieflimieten: Bulk API: 48 verzoeken / minuut Alle andere API: 100 verzoeken / seconde.
Waarschuwing: Real-time monitoring API's zijn CPU-intensief en mogen alleen worden gebruikt voor het oplossen van problemen, niet voor continue monitoring.
API's testen met de Documentation Tool
Stap 1: Meld u aan bij de vManage GUI om te controleren of vEdge in de beheermodus vManage is
Stap 2: Wijzig de URL naar LoginCisco SD-WAN vManage API
Aanmelden op https://10.124.x.x/apidocs/
Stap 3: Navigeer naar Configuratie - Sjabloonconfiguratie in de Cisco SD-WAN vManage API
Stap 4:Klik op de knop Uitproberen
Stap 5: DeviceId en DeviceIP wijzigen
- deviceId == uuid
- deviceIP == local-system-ip
Stap 6: Klik op de knop Execute
Stap 7: vEdge-modus controleren in vManage GUI
De vedge-beheermodus is overgeschakeld van vManage naar CLI-status.
API's testen met de Postman Tool
Stap 1: Meld u aan bij vManage en ontvang de sessiecookie
Aanvraagmethode: POST
URL: https://<vmanage-ip>/j_security_check
Postman-configuratie
headers: Content-Type: application/x-www-form-urlencoded
Lichaamstype: x-ww-form-urlencoded
Lichaamsinhoud:
- j_gebruikersnaam=admin
- J_Password=XXX
Na een succesvolle aanmelding retourneert vManage de Cookie van JSESSIONID; Cookies worden automatisch opgeslagen.
Stap 2: Het CSRF-token verkrijgen
Aanvraagmethode: GET
URL: https://<vmanage-ip>/dataservice/client/token
Postman-configuratie
headers: Content-Type: application/x-www-form-urlencoded
Lichaamstype: x-ww-form-urlencoded
Lichaamsinhoud:
- j_gebruikersnaam=admin
- J_Password=XXX
Stap 3: Krijg het apparaat UUID en IP
Aanvraagmethode: GET
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/vmanage?type=vedge
Postman-configuratie
Koppen:
- Content-Type:applicatie/json
- X-XSRF-TOKEN: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Lichaamstype: x-ww-form-urlencoded
Lichaamsinhoud:
- j_gebruikersnaam=admin
- J_Password=XXX
Stap 4: Maak de configuratiesjabloon van vEdge los
Aanvraagmethode: POST
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/cli
Postman-configuratie
Koppen:
- Accepteren: aanvraag/json
- Content-Type:applicatie/json
- XSRF-TOKEN: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Lichaamstype: rauw (JSON)
Lichaamsinhoud:
{"deviceType":"vedge","devices":[{"deviceId":"cfca8af1-8f4d-faba-xxx","deviceIP":"xxx"}}
Gerelateerde informatie
Revisiegeschiedenis
| Revisie | Publicatiedatum | Opmerkingen |
|---|---|---|
1.0 |
26-Sep-2025
|
Eerste vrijgave |
FeedbackContact Cisco
- Een ondersteuningscase openen
- (Vereist een Cisco-servicecontract)