Convertir vEdge du mode vManage au mode CLI par l'API vManage
Table des matières
Introduction
Ce document décrit comment convertir vEdge du mode vManage au mode CLI par l'API vManage.
Conditions préalables
Exigences
Cisco vous recommande de prendre connaissance des rubriques suivantes :
- Réseau étendu défini par logiciel (SD-WAN) de Cisco
- POSTMAN
Composants utilisés
Les informations contenues dans ce document sont basées sur les versions de matériel et de logiciel suivantes :
- Cisco vManager version 20.9.4
- Cisco vEdge version 20.9.4
- Postman version 11.63.0
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. Si votre réseau est en ligne, assurez-vous de bien comprendre l’incidence possible des commandes.
Informations générales
- L'API Cisco SD-WAN vManage est une interface API REST permettant de contrôler, de configurer et de surveiller les périphériques Cisco dans un réseau superposé.
- L'architecture REST utilise un protocole de communication client-serveur sans état et pouvant être mis en cache.
- REpresentational State Transfer (REST) est un style d'architecture pour la conception d'applications de services Web.
- Les appels d'API de test peuvent être testés à partir de l'interface utilisateur swagger.
- Il est parfois impossible de modifier le mode de gestion de vedge via l'interface graphique utilisateur. Dans de tels cas, choisir de modifier le mode de gestion via l'API est une autre approche possible.
- La documentation de l'API vManage est accessible via https://<vmanage_ip>:<port>/apidocs pour référence sur les appels d'API disponibles.
Composants de structure URL
https://<vmanage_ip>:<port>/apidocs/#/Configuration%20-%20Template%20Configuration/updateDeviceToCLIMode
|
Propriétés de commande |
Syntaxe de commande |
Description |
|
Protocol |
http:// ou https:// |
Protocole sur lequel les données sont envoyées entre le client et le serveur |
|
Serveur ou hôte |
<vmanage-ip:port> |
Résolution sur l'adresse IP et le port auxquels se connecter |
|
Ressource |
/apidocs/#/Configuration%20-%20Modèle%20Configuration/updateDeviceToCLIMode |
Emplacement des données ou de l'objet d'intérêt |
Accéder à la documentation API intégrée
La documentation de l'API intégrée vManage se trouve à l'adresse URL https://<vmanage_ip>:<port:>/apidocs. Cette documentation affiche les API disponibles sur la version actuelle du logiciel.
Cela nécessite une connexion avec des informations d'identification vManage valides. Bien que plusieurs niveaux de privilèges puissent afficher la documentation, seul un utilisateur netadmin est en mesure de les exécuter tous.
Remarque : La page de documentation de l'API est disponible pour les locataires dans un environnement multilocataire. Toutefois, certaines commandes sont réservées au fournisseur.
vManage affiche ensuite la liste des catégories d'API disponibles. Cliquez sur la catégorie souhaitée, puis sur l'appel d'API proprement dit, qui affiche les champs suivants :
|
Description/Notes de mise en oeuvre |
Description de l'opération effectuée. |
|
Paramètres |
Paramètres requis à spécifier pour l'appel d'API. |
|
Corps de la demande (POST/PUT/DELETE) |
Format du corps de la demande. |
|
Réponses |
Réponses possibles que vManage envoie à l'API. Cela inclut le code d'état HTTP, la raison et le corps de réponse possible. |
|
Extensions |
Postes valides pour l'appel. |
Remarque : À partir de la version 20.6, le système introduit ces limites de débit : API en masse : 48 requêtes/minute Toutes les autres API : 100 requêtes/seconde.
Avertissement : Les API de surveillance en temps réel sollicitent énormément le processeur et ne doivent être utilisées que pour le dépannage et non pour la surveillance continue.
Tester les API à partir de l'outil de documentation
Étape 1 : Connectez-vous à l'interface utilisateur graphique vManage pour vérifier que le mode de gestion de vEdge est vManage
Étape 2 : Modifiez l'URL pour vous connecterAPI Cisco SD-WAN vManage
Connexion https://10.124.x.x/apidocs/
Étape 3 : Accédez à Configuration - Template Configuration dans l'API Cisco SD-WAN vManage
Étape 4 : Bouton ClickTry it out
Étape 5 :Changez DeviceId et DeviceIP
- deviceId == uuid
- deviceIP == ip-système-local
Étape 6 :Cliquez sur le bouton Execute
Étape 7 :Vérifiez le mode vEdge dans l'interface graphique utilisateur vManage
Le mode de gestion de périphérie est passé de l'état vManage à l'état CLI.
Tester les API à partir de l'outil Postman
Étape 1 : Se connecter à vManage et obtenir le cookie de session
Méthode de demande : POST
URL: https://<ip_vmanage>/j_security_check
configuration Postman
Header (En-tête) : Content-Type:application/x-www-form-urlencoded
Type de corps : x-ww-form-urlencoded
Contenu du corps :
- j_username=admin
- j_password=xxx
Après une connexion réussie, vManage renvoie le cookie de JSESSIONID ; les cookies sont enregistrés automatiquement.
Étape 2 : Obtenir le jeton CSRF
Méthode de demande : GET
URL: https://<vmanage-ip>/dataservice/client/token
configuration Postman
Header (En-tête) : Content-Type:application/x-www-form-urlencoded
Type de corps : x-ww-form-urlencoded
Contenu du corps :
- j_username=admin
- j_password=xxx
Étape 3 :Obtenez l’UUID et l’IP du périphérique
Méthode de demande : GET
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/vmanage?type=vedge
configuration Postman
Header (En-tête) :
- Content-Type:application/json
- X-XSRF-TOKEN : E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Type de corps : x-ww-form-urlencoded
Contenu du corps :
- j_username=admin
- j_password=xxx
Étape 4 : Dissocier le modèle de configuration de vEdge
Méthode de demande : POST
URL: https://<vmanage-ip>/dataservice/template/config/device/mode/cli
configuration Postman
Header (En-tête) :
- accepter:application/json
- Content-Type:application/json
- JETON X-XSRF : E9C81862C46DA9F8C9A650272E8D577C415999496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD23A68A
Type de corps : brut (JSON)
Contenu du corps :
{"deviceType":"vedge","devices":[{"deviceId":"cfca8af1-8f4d-faba-xxx","deviceIP":"xxx"}]}
Informations connexes
Historique de révision
| Révision | Date de publication | Commentaires |
|---|---|---|
1.0 |
26-Sep-2025
|
Première publication |
CommentairesContacter Cisco
- Ouvrir un dossier d’assistance
- (Un contrat de service de Cisco est requis)