Konvertieren von vEdge vom vManage-Modus in den CLI-Modus über vManage API
Inhalt
Einleitung
In diesem Dokument wird beschrieben, wie vEdge über die vManage-API vom vManage-Modus in den CLI-Modus konvertiert wird.
Voraussetzungen
Anforderungen
Cisco empfiehlt, dass Sie über Kenntnisse in folgenden Bereichen verfügen:
- Cisco Software-defined Wide Area Network (SD-WAN)
- Postbote
Verwendete Komponenten
Die Informationen in diesem Dokument basierend auf folgenden Software- und Hardware-Versionen:
- Cisco vManager Version 20.9.4
- Cisco vEdge Version 20.9.4
- Postman-Version 11.63.0
Die Informationen in diesem Dokument beziehen sich auf Geräte in einer speziell eingerichteten Testumgebung. Alle Geräte, die in diesem Dokument benutzt wurden, begannen mit einer gelöschten (Nichterfüllungs) Konfiguration. Wenn Ihr Netzwerk in Betrieb ist, stellen Sie sicher, dass Sie die möglichen Auswirkungen aller Befehle kennen.
Hintergrundinformationen
- Die Cisco SD-WAN vManage API ist eine REST API-Schnittstelle zur Steuerung, Konfiguration und Überwachung der Cisco Geräte in einem Overlay-Netzwerk.
- Die REST-Architektur verwendet ein Stateless Client-Server-Kommunikationsprotokoll, auf das gecacht werden kann.
- REpresentational State Transfer (REST) ist ein Architekturstil für das Design von Webdienstanwendungen.
- Test-API-Aufrufe können über die Swagger-Benutzeroberfläche ausprobiert werden.
- Manchmal ist es unmöglich, den Verwaltungsmodus von vedge über die GUI-Schnittstelle zu ändern. In solchen Fällen ist es auch machbar, den Verwaltungsmodus über die API zu ändern.
- Auf die vManage-API-Dokumentation kann unter https://<vmanage_ip>:<port>/apidocs zugegriffen werden, um auf verfügbare API-Aufrufe zuzugreifen.
URL-Strukturkomponenten
https://<vmanage_ip>:<port>/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode
|
Befehlseigenschaften |
Befehlssyntax |
Beschreibung |
|
Protokolle |
http:// oder https:// |
Protokoll, über das Daten zwischen Client und Server gesendet werden |
|
Server oder Host |
<vmanage-ip:port> |
Löst sich auf die IP-Adresse und den Port auf, mit dem eine Verbindung hergestellt werden soll |
|
Ressource |
/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode |
Der Speicherort der Daten oder des Objekts von Interesse |
Zugriff auf integrierte API-Dokumentation
Die Dokumentation zur integrierten vManage API finden Sie unter der URL https://<vmanage_ip>:<port:>/apidocs. In dieser Dokumentation werden die für die aktuelle Softwareversion verfügbaren APIs angezeigt.
Dies erfordert die Anmeldung mit gültigen vManage-Anmeldeinformationen. Während mehrere Berechtigungsebenen Dokumentation anzeigen können, kann nur ein netadmin-Benutzer alle ausführen.
Anmerkung: Die API-Dokumentationsseite steht Tenants in einer Multi-Tenant-Umgebung zur Verfügung. Bestimmte Befehle sind jedoch auf den Anbieter beschränkt.
vManage zeigt dann eine Liste mit Kategorien verfügbarer APIs an. Klicken Sie auf die gewünschte Kategorie, gefolgt vom API-Aufruf selbst. Daraufhin werden folgende Felder angezeigt:
|
Beschreibung/Implementierungshinweise |
Beschreibung des ausgeführten Vorgangs. |
|
Parameter |
Erforderliche Parameter, die für den API-Aufruf angegeben werden müssen. |
|
Request Body (POST/PUT/DELETE) |
Format des Anforderungstexts. |
|
Antworten |
Mögliche Antworten, die vManage an die API sendet. Dazu gehören HTTP-Statuscode, Grund und der mögliche Antworttext. |
|
Erweiterungen |
Gültige Durchwahlen für den Anruf. |
Anmerkung: Ab der Version 20.6 führt das System die folgenden Ratenlimitierungen ein: Bulk-API: 48 Anfragen/Minute Alle anderen API: 100 Anfragen/Sekunde.
Warnung: APIs zur Echtzeitüberwachung sind CPU-intensiv und dürfen nur zur Fehlerbehebung und nicht zur kontinuierlichen Überwachung verwendet werden.
Test-APIs aus dem Dokumentationstool
Schritt 1:Melden Sie sich bei der grafischen Benutzeroberfläche von vManage an, um sicherzustellen, dass der Verwaltungsmodus von vEdge vManage ist.
Schritt 2:Ändern der AnmeldeCisco SD-WAN vManage API
Anmelden https://10.124.x.x/apidocs/
Schritt 3: Navigieren Sie zu Konfiguration - Vorlagenkonfiguration in der Cisco SD-WAN vManage API.
Schritt 4:ClickTry it out-Schaltfläche
Schritt 5: Ändern der Geräte-ID und Geräte-IP
- deviceId == uuid
- deviceIP == local-system-ip
Schritt 6:Klicken Sie auf Ausführen Schaltfläche
Schritt 7: Überprüfen des vEdge-Modus in der vManage-GUI
Der vEdge-Verwaltungsmodus wurde vom Status "vManage" auf "CLI" umgeschaltet.
Test-APIs aus dem Postman-Tool
Schritt 1: Melden Sie sich bei vManage an, und rufen Sie das Sitzungscookie auf.
Anforderungsmethode: POST
URL: https://<vmanage-ip>/j_security_check
Postman-Konfiguration
Header: Inhaltstyp:Anwendung/x-www-form-urlencoded
Body-Typ: x-ww-form-urlencodiert
Körperinhalt:
- j_username=admin
- j_password=xxx
Nach erfolgreicher Anmeldung gibt vManage das Cookie JSESSIONID zurück; Cookies werden automatisch gespeichert.
Phase 2: Abrufen des CSRF-Tokens
Anforderungsmethode: HOLEN
URL: https://<vmanage-ip>/dataservice/client/token
Postman-Konfiguration
Header: Inhaltstyp:Anwendung/x-www-form-urlencoded
Body-Typ: x-ww-form-urlencodiert
Körperinhalt:
- j_username=admin
- j_password=xxx
Schritt 3:Rufen Sie die UUID und IP des Geräts ab
Anforderungsmethode: HOLEN
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/vmanage?type=vedge
Postman-Konfiguration
Header:
- Inhaltstyp:Anwendung/json
- X-XSRF-TOKEN: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD28A
Body-Typ: x-ww-form-urlencodiert
Körperinhalt:
- j_username=admin
- j_password=xxx
Schritt 4: Aufhebung der Bindung der Konfigurationsvorlage von vEdge
Anforderungsmethode: POST
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/cli
Postman-Konfiguration
Header:
- Annehmen:Anwendung/Json
- Inhaltstyp:Anwendung/json
- X-XSRF-TOKEN: E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD 23 A68 A
Body-Typ: raw (JSON)
Körperinhalt:
{"deviceType":"vedge","devices":[{"deviceId":"cfca8af1-8f4d-faba-xxx","deviceIP":"xxx"}]}
Zugehörige Informationen
Revisionsverlauf
| Überarbeitung | Veröffentlichungsdatum | Kommentare |
|---|---|---|
1.0 |
26-Sep-2025
|
Erstveröffentlichung |
FeedbackCisco kontaktieren
- Eine Supportanfrage öffnen
- (Erfordert einen Cisco Servicevertrag)