SUR CETTE PAGE
Comment spécifier le format des données de configuration à charger
Comment charger des données de configuration sous forme de chaînes
Comment charger des données de configuration à partir d’un fichier local ou distant
Comment charger des données de configuration à l’aide d’un modèle Jinja2
Comment ignorer les avertissements lors de la configuration d’appareils
Exemple : Utiliser Ansible pour configurer des équipements Junos
Utiliser Ansible pour configurer les équipements Junos
Utilisez les modules Ansible de Juniper Networks pour gérer la configuration sur les équipements Junos.
Juniper Networks fournit un module Ansible qui vous permet de configurer les équipements Junos. Le tableau 1 présente les modules disponibles. Le compte d’utilisateur utilisé pour apporter des modifications à la configuration doit disposer des autorisations nécessaires pour modifier les parties pertinentes de la configuration sur chaque appareil.
Ensemble de contenu |
Nom du module |
---|---|
|
Les sections suivantes expliquent comment utiliser le module pour modifier et valider la configuration sur les équipements Junos.
Vue d’ensemble du module
Le juniper.device.config
module vous permet d’effectuer les opérations suivantes sur les équipements Junos :
-
Charger les données de configuration
-
Valider la configuration
-
Restaurer la configuration
-
Charger la configuration de sauvetage
Pour modifier la configuration, la liste d’arguments du module doit inclure soit le paramètre pour charger les load
nouvelles données de configuration, soit le rollback
paramètre pour revenir à la configuration de secours ou à une configuration précédemment validée. Le processus de base pour apporter des modifications de configuration consiste à verrouiller la configuration, à charger les modifications de configuration, à valider la configuration pour qu’elle soit active, puis à déverrouiller la configuration.
Par défaut, le config
module apporte des modifications à la base de données de configuration candidate à l’aide configure exclusive
du mode, qui verrouille et déverrouille automatiquement la configuration globale candidate. Vous pouvez également spécifier un autre mode de configuration. Par exemple, vous pouvez apporter des modifications à une copie privée de la configuration candidate ou à la base de données de configuration éphémère. Pour plus d’informations sur la spécification du mode de configuration, reportez-vous à la section Comment spécifier le mode de configuration.
Lors du chargement de nouvelles données de configuration, en plus de spécifier le mode de configuration, vous pouvez également spécifier l’opération de chargement ainsi que la source et le format des modifications.
-
Opération de chargement : l’opération de chargement détermine la manière dont les données de configuration sont chargées dans la base de données de configuration sélectionnée. La fonction prend en charge un grand nombre des opérations de chargement disponibles dans l’interface de ligne de commande de Junos OS. Pour plus d’informations, reportez-vous à la rubrique Spécification de l’action de chargement.
-
Format : vous pouvez configurer les équipements Junos à l’aide de l’un des formats standard pris en charge. Vous pouvez fournir des données de configuration ou des modèles Jinja2 sous forme de texte, d’éléments XML Junos, de commandes Junos OS
set
ou de JSON. Pour plus d’informations sur la spécification du format des données de configuration, reportez-vous à la section Comment spécifier le format des données de configuration à charger. -
Source de données de configuration : vous pouvez charger des données de configuration à partir d’une liste de chaînes, d’un fichier sur le nœud de contrôle Ansible local, d’un modèle Jinja2 ou d’une URL accessible à partir de l’appareil client en incluant respectivement le
lines
paramètre ,src
,template
ouurl
. Pour plus d’informations sur la spécification de la source des données de configuration, consultez les sections suivantes :
Le config
module vous permet également de charger et de valider la configuration de sauvetage ou de restaurer la configuration à une configuration précédemment validée. Pour charger la configuration de secours ou une configuration précédemment validée, vous devez inclure l’argument rollback
module. Pour plus d’informations, consultez les sections suivantes :
Après avoir modifié la configuration, vous devez valider la configuration pour en faire la configuration active sur l’appareil. Par défaut, le config
module valide les modifications apportées à la configuration. Pour modifier ce comportement ou fournir des options de validation supplémentaires, reportez-vous à la section Comment valider la configuration.
Par défaut, lorsque le config
module inclut les load
arguments or rollback
pour modifier la configuration, le module renvoie automatiquement les modifications de configuration au format diff ou patch dans la réponse du module. Les différences sont renvoyées dans les diff
variables and diff_lines
. Pour empêcher le module de calculer et de renvoyer les différences, définissez l’argument diff
module sur false
.
Comment spécifier le mode de configuration
Vous pouvez spécifier le mode de configuration à utiliser lors de la modification de la configuration de l’appareil. Pour spécifier le mode de configuration dans votre tâche, incluez le config
paramètre du config_mode
module. Les modes de configuration pris en charge sont les suivants :
-
batch
-
dynamic
-
ephemeral
-
exclusive
-
private
Par défaut, le juniper.device.config
module apporte des modifications à la base de données de configuration candidate à l’aide du configure exclusive
mode. Le mode Configurer exclusif verrouille la configuration globale candidate (également appelée base de données de configuration partagée) aussi longtemps que le module a besoin d’apporter les modifications demandées à la configuration. Le verrouillage de la base de données empêche les autres utilisateurs de modifier la base de données ou d’y apporter des modifications jusqu’à ce que le verrou soit levé.
Les exemples suivants montrent comment configurer une copie privée de la configuration candidate et comment configurer la base de données éphémère.
Exemple : config_mode : « privé »
Le playbook suivant utilise private
le mode de configuration pour modifier une copie privée de la configuration candidate :
--- - name: "Configure Device" hosts: dc1 connection: local gather_facts: no tasks: - name: "Configure op script" juniper.device.config: config_mode: "private" load: "set" lines: - "set system scripts op file bgp.slax" register: response - name: "Print the config changes" ansible.builtin.debug: var: response.diff_lines
user@ansible-cn:~/ansible$ ansible-playbook configure-script.yaml PLAY [Configure Device] ******************************************************* TASK [Configure op script] **************************************************** changed: [dc1a.example.net] TASK [Print the config changes] *********************************************** ok: [dc1a.example.net] => { "response.diff_lines": [ "", "[edit system scripts op]", "+ file bgp.slax;" ] } PLAY RECAP ******************************************************************** dc1a.example.net : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
Configurer la base de données éphémère
Vous pouvez utiliser le juniper.device.config
module pour mettre à jour la base de données de configuration éphémère sur les appareils qui prennent en charge cette base de données. La base de données éphémère est une base de données de configuration alternative qui fournit une interface de programmation rapide pour effectuer des mises à jour de configuration sur les équipements Junos.
Pour ouvrir et configurer l’instance par défaut de la base de données de configuration éphémère, incluez l’argument config_mode: "ephemeral"
. Par exemple:
--- - name: "Configure ephemeral database" hosts: dc1a connection: local gather_facts: no tasks: - name: "Configure the default ephemeral database" juniper.device.config: config_mode: "ephemeral" load: "set" lines: - "set protocols mpls label-switched-path to-hastings to 192.0.2.1"
Pour ouvrir et configurer une instance existante définie par l’utilisateur de la base de données de configuration éphémère, incluez l’argument config_mode: "ephemeral"
et définissez-le ephemeral_instance
sur le nom de l’instance.
tasks: - name: "Configure a user-defined ephemeral instance" juniper.device.config: config_mode: "ephemeral" ephemeral_instance: "eph1" load: "set" lines: - "set protocols mpls label-switched-path to-hastings to 192.0.2.2"
Comment spécifier l’action de chargement
Le juniper.device.config
module prend en charge le chargement des modifications de configuration à l’aide d’un grand nombre des mêmes opérations de chargement que celles prises en charge dans l’interface de ligne de commande de Junos OS. Vous spécifiez l’opération de chargement en incluant le paramètre dans la load
liste des arguments du module et en le définissant sur la valeur de l’opération de chargement correspondante. Le tableau 2 récapitule les réglages des paramètres requis pour chaque type d’opération de chargement.
Opération de chargement |
Argument load |
Description |
---|---|---|
|
|
Fusionnez la configuration chargée avec la configuration existante. |
|
|
Remplacez l’ensemble de la configuration par la configuration chargée. |
|
|
Chargez les données de configuration à partir d’un fichier de correctif. |
|
|
Fusionnez la configuration chargée avec la configuration existante, mais remplacez les instructions de la configuration existante par celles qui spécifient la |
|
|
Chargez les données de configuration au |
|
|
Comparez la configuration chargée complète à la configuration existante. Chaque élément de configuration différent dans la configuration chargée remplace son élément correspondant dans la configuration existante. Lors de l’opération de validation, seuls les processus système affectés par les éléments de configuration modifiés analysent la nouvelle configuration. |
Comment spécifier le format des données de configuration à charger
Le juniper.device.config
module vous permet de configurer les équipements Junos à l’aide de l’un des formats standard pris en charge. Vous pouvez fournir des données de configuration sous forme de chaînes ou de fichiers. Les fichiers peuvent contenir des données de configuration ou des modèles Jinja2. Lorsque vous fournissez des données de configuration dans une chaîne, un fichier ou un modèle Jinja2, les formats pris en charge pour les données sont le texte, les éléments XML Junos, les commandes Junos OS set
et JSON.
Le config
module tente de détecter automatiquement le format des données de configuration que vous fournissez sous forme de chaînes dans l’argument lines
. Toutefois, vous pouvez spécifier explicitement le format des chaînes en incluant l’argument format
. Lorsque vous fournissez des données de configuration dans un fichier ou un modèle Jinja2, vous devez spécifier le format des données soit en ajoutant l’extension appropriée au fichier, soit en incluant l’argument format
.
Le Tableau 3 récapitule les formats pris en charge pour les données de configuration et la valeur correspondante pour l’extension de fichier et format
le paramètre. Si vous incluez l’argument format
, il remplace à la fois le format de détection automatique des chaînes et le format indiqué par une extension de fichier.
Format des données de configuration |
Extension de fichier |
format Paramètre |
---|---|---|
Instructions de configuration de l’interface de ligne de commande (texte) |
.Conf |
« |
Notation d’objet JavaScript (JSON) |
.json |
« |
|
.poser |
« |
Éléments XML Junos |
.xml |
« |
Lorsque vous définissez l’argument du load
module sur 'override'
ou 'update'
, vous ne pouvez pas utiliser le format de commande Junos OS set
.
Comment charger des données de configuration sous forme de chaînes
Le juniper.device.config
module vous permet de charger des données de configuration à partir d’une liste de chaînes. Pour charger des données de configuration sous forme de chaînes, incluez l’argument approprié load
et l’argument lines
. L’argument lines
prend une liste de chaînes contenant les données de configuration à charger.
Le module tente de détecter automatiquement le format des données de lines
configuration. Toutefois, vous pouvez spécifier explicitement le format en incluant l’argument format
. Pour plus d’informations sur la spécification du format, reportez-vous à la section Comment spécifier le format des données de configuration à charger. Si vous incluez l’argument format
, il remplace le format détecté automatiquement.
Le playbook suivant configure et valide deux scripts d’opération. Dans ce cas, l’argument load
a la valeur 'set'
, car les données de configuration utilisent lines
le format d’instruction Junos OS set
.
--- - name: "Load and commit configuration" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load configuration data using strings and commit" juniper.device.config: load: "set" lines: - "set system scripts op file bgp.slax" - "set system scripts op file bgp-neighbor.slax" register: response - name: "Print the response" ansible.builtin.debug: var: response
Le playbook suivant configure les mêmes instructions en utilisant lines
des données de configuration au format texte. Dans ce cas, load: "merge"
est utilisé.
--- - name: "Load and commit configuration" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load configuration data using strings and commit" juniper.device.config: load: "merge" lines: - | system { scripts { op { file bgp.slax; file bgp-neighbor.slax; } } } register: response - name: "Print the response" ansible.builtin.debug: var: response
Comment charger des données de configuration à partir d’un fichier local ou distant
Le juniper.device.config
module vous permet de charger des données de configuration à partir d’un fichier. Le fichier peut résider dans l’un des emplacements suivants :
-
nœud de contrôle Ansible
-
Appareil client
-
URL accessible à partir de l’appareil client
Lorsque vous chargez des données de configuration à partir d’un fichier, vous devez indiquer l’emplacement du fichier et le format des données de configuration dans le fichier. Les formats de données de configuration pris en charge sont le texte, les éléments XML Junos, les commandes Junos OS set
et JSON. Pour plus d’informations sur le chargement de fichiers contenant des modèles Jinja2, consultez Comment charger des données de configuration à l’aide d’un modèle Jinja2.
Vous pouvez spécifier le format des données de configuration soit en incluant explicitement le format
paramètre dans la liste d’arguments du module, soit en ajoutant l’extension appropriée au fichier de données de configuration. Si vous spécifiez le format
paramètre, il remplace le format indiqué par l’extension du fichier. Pour plus d’informations sur la spécification du format, reportez-vous à la section Comment spécifier le format des données de configuration à charger. Lorsque les données de configuration utilisent le format XML Junos, vous devez placer les données dans la balise de niveau <configuration>
supérieur.
Vous n’avez pas besoin d’inclure des données de configuration au format texte ASCII, des commandes Junos OS set
ou JSON dans <configuration-text>
, <configuration-set>
ou <configuration-json>
des balises comme requis lors de la configuration du périphérique directement dans une session NETCONF.
Le Tableau 4 présente les paramètres de module que vous pouvez inclure pour spécifier l’emplacement du fichier.
Paramètre du module |
Description |
---|---|
|
Chemin d’accès absolu ou relatif à un fichier sur le nœud de contrôle Ansible. Le répertoire par défaut est le répertoire playbook. |
|
Chemin absolu ou relatif vers un fichier sur l’équipement client, un emplacement FTP ou une URL HTTP. Le répertoire par défaut sur l’appareil client est le répertoire de travail courant, qui est par défaut le répertoire personnel de l’utilisateur. |
Pour charger des données de configuration à partir d’un fichier local sur le nœud de contrôle Ansible, définissez l’argument src
sur le chemin absolu ou relatif du fichier contenant les données de configuration. Par exemple:
--- - name: "Load and commit configuration" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load configuration from a local file and commit" juniper.device.config: load: "merge" src: "build_conf/{{ inventory_hostname }}/junos.conf" register: response - name: "Print the response" ansible.builtin.debug: var: response
Pour charger des données de configuration à partir d’un fichier sur l’équipement Junos ou d’une URL FTP ou HTTP, utilisez le url
paramètre et spécifiez le chemin d’accès du fichier contenant les données de configuration à charger. Par exemple:
--- - name: "Load and commit configuration" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load configuration from a remote file and commit" juniper.device.config: load: "merge" url: "/var/tmp/junos.conf" register: response - name: "Print the response" ansible.builtin.debug: var: response
La valeur de peut url
être un chemin d’accès de fichier local absolu ou relatif, un emplacement FTP ou une URL HTTP.
-
Le chemin d’accès à un fichier local sur l’équipement cible se présente sous l’une des formes suivantes :
-
/path/filename : fichier sur un système de fichiers monté, soit sur le disque flash local, soit sur le disque dur.
-
un:filename ou a :path/filename—Fichier sur le lecteur local. Le chemin par défaut est / (le répertoire de niveau racine). Le support amovible peut être au format MS-DOS ou UNIX (UFS).
-
-
Le chemin d’accès à un fichier sur un serveur FTP se présente sous la forme suivante :
ftp://username:password@hostname/path/filename
-
Le chemin d’accès à un fichier sur un serveur HTTP se présente sous la forme suivante :
http://username:password@hostname/path/filename
Dans chaque cas, la valeur par défaut de la path variable est le répertoire personnel de l’utilisateur. Pour spécifier un chemin absolu, l’application commence le chemin par les caractères %2F ; par exemple, ftp://username :password@hostname/%2Fpath/filename.
Comment charger des données de configuration à l’aide d’un modèle Jinja2
Le juniper.device.config
module vous permet d’afficher les données de configuration à partir d’un fichier modèle Jinja2 sur le nœud de contrôle Ansible, puis de charger et valider la configuration sur un équipement Junos. Jinja est un moteur de modèles pour Python qui vous permet de générer des documents à partir de modèles prédéfinis. Les modèles, qui sont des fichiers texte dans la langue souhaitée, offrent une grande flexibilité grâce à l’utilisation d’expressions et de variables. Vous pouvez créer des données de configuration Junos OS à l’aide de modèles Jinja2 dans l’un des formats de configuration pris en charge, notamment le texte ASCII, les éléments XML Junos, les commandes Junos OS set
et JSON. Le module Ansible utilise le modèle Jinja2 et un dictionnaire de variables fourni pour restituer les données de configuration.
Pour charger et valider les données de configuration à l’aide d’un modèle Jinja2, incluez les template
paramètres et vars
dans la liste des arguments du module.
-
template
—Chemin d’accès au fichier de modèle Jinja2 -
vars
: dictionnaire des clés et des valeurs requises pour le rendu du modèle Jinja2
Vous devez également inclure le format
paramètre lorsque l’extension de fichier du modèle n’indique pas le format des données. Pour plus d’informations sur la spécification du format, reportez-vous à la section Comment spécifier le format des données de configuration à charger.
Par exemple, le fichier interfaces-mpls.j2 contient le modèle Jinja2 suivant :
interfaces { {% for item in interfaces %} {{ item }} { description "{{ description }}"; unit 0 { family {{ family }}; } } {% endfor %} } protocols { mpls { {% for item in interfaces %} interface {{ item }}; {% endfor %} } rsvp { {% for item in interfaces %} interface {{ item }}; {% endfor %} } }
Pour utiliser le juniper.device.config
module afin de charger le modèle Jinja2, définissez l’argument template
sur le chemin du fichier de modèle et définissez les variables requises par le modèle dans le vars
dictionnaire. Le playbook suivant utilise le modèle Jinja2 et les variables définies dans vars
pour afficher les données de configuration, les charger et les valider sur l’hôte cible. Le format
paramètre indique le format des données de configuration dans le fichier modèle.
--- - name: "Load and commit configuration" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load a configuration from a Jinja2 template and commit" juniper.device.config: load: "merge" template: "build_conf/templates/interfaces-mpls.j2" format: "text" vars: interfaces: ["ge-1/0/1", "ge-1/0/2", "ge-1/0/3"] description: "MPLS interface" family: "mpls" register: response - name: "Print the response" ansible.builtin.debug: var: response
Le module génère les données de configuration suivantes, qui sont chargées dans la configuration candidate sur l’équipement et validées :
interfaces { ge-1/0/1 { description "MPLS interface"; unit 0 { family mpls; } } ge-1/0/2 { description "MPLS interface"; unit 0 { family mpls; } } ge-1/0/3 { description "MPLS interface"; unit 0 { family mpls; } } } protocols { mpls { interface ge-1/0/1; interface ge-1/0/2; interface ge-1/0/3; } rsvp { interface ge-1/0/1; interface ge-1/0/2; interface ge-1/0/3; } }
Comment charger la configuration de sauvetage
Une configuration de secours vous permet de définir une configuration de travail connue ou une configuration dont l’état est connu que vous pouvez restaurer à tout moment. Vous pouvez utiliser la configuration de secours lorsque vous devez revenir à une configuration connue ou, en dernier recours, si la configuration de l’appareil et les fichiers de configuration de sauvegarde sont irréparables. Lorsque vous créez une configuration de secours, l’appareil enregistre la configuration la plus récemment validée en tant que configuration de secours.
Le juniper.device.config
module vous permet de revenir à une configuration de sauvetage existante sur les équipements Junos. Pour charger et valider la configuration de sauvetage sur un périphérique, incluez l’argument du rollback: "rescue"
module. Par exemple:
--- - name: "Revert to rescue configuration" hosts: dc1a connection: local gather_facts: no tasks: - name: "Load and commit rescue configuration" juniper.device.config: rollback: "rescue" register: response - name: "Print response" ansible.builtin.debug: var: response
Comment restaurer la configuration
Les équipements Junos stockent une copie de la dernière configuration validée et jusqu’à 49 configurations précédentes, en fonction de la plate-forme. Vous pouvez revenir à n’importe laquelle des configurations stockées. Ceci est utile lorsque des modifications de configuration entraînent des résultats indésirables et que vous souhaitez revenir à une configuration de travail connue. La restauration de la configuration est similaire au processus de modification de la configuration sur l’appareil, mais au lieu de charger les données de configuration, vous effectuez une restauration, qui remplace l’intégralité de la configuration candidate par une configuration précédemment validée.
Le juniper.device.config
module vous permet de revenir à une configuration précédemment validée sur les équipements Junos. Pour restaurer la configuration et la valider, incluez l’argument du rollback
module et spécifiez l’ID de la configuration de restauration. Les valeurs d’ID valides sont égales à 0 (zéro, pour la configuration validée la plus récente) à une unité de moins que le nombre de configurations précédentes stockées (le maximum est de 49).
Le playbook suivant demande l’ID de restauration de la configuration à restaurer, annule la configuration et la valide, puis imprime les modifications de configuration en sortie standard :
--- - name: "Roll back the configuration" hosts: dc1a connection: local gather_facts: no vars_prompt: - name: "ROLLBACK" prompt: "Rollback ID of the configuration to restore" private: no tasks: - name: "Roll back the configuration and commit" juniper.device.config: rollback: "{{ ROLLBACK }}" register: response - name: "Print the configuration changes" ansible.builtin.debug: var: response.diff_lines
user@ansible-cn:~/ansible$ ansible-playbook configuration-rollback.yaml Rollback ID of the configuration to restore: 1 PLAY [Roll back the configuration] ******************************************** TASK [Roll back the configuration and commit] ********************************* changed: [dc1a.example.net] TASK [Print the configuration changes] *************************************** ok: [dc1a.example.net] => { "response.diff_lines": [ "", "[edit interfaces]", "- ge-0/0/0 {", "- unit 0 {", "- family mpls;", "- }", "- }" ] } PLAY RECAP ******************************************************************** dc1a.example.net : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
Comment valider la configuration
Par défaut, lorsque vous utilisez le juniper.device.config
module pour modifier la configuration à l’aide de l’argument load
ou de l’argument rollback
, le module effectue automatiquement une vérification de validation et valide les modifications. Pour empêcher le module d’effectuer une vérification de validation ou de valider les modifications, définissez l’argument check
ou commit
sur false
, respectivement.
Vous pouvez également personnaliser l’opération de validation à l’aide d’un grand nombre des options disponibles dans l’interface de ligne de commande de Junos OS. Le Tableau 5 présente les arguments de module que vous pouvez utiliser pour spécifier différentes options de validation.
Module Argument |
Description |
Valeur par défaut pour |
---|---|---|
|
Effectuez une vérification de validation ou confirmez une opération de validation confirmée précédente. |
|
|
Attendez le nombre de secondes spécifié entre la vérification de validation et l’opération de validation. |
– |
|
Consignez un commentaire pour cette opération de validation dans le fichier journal système et dans l’historique des validations de l’appareil. |
– |
|
Validez les modifications de configuration ou confirmez une opération de validation confirmée précédente. |
|
|
Validez les modifications de configuration même s’il n’y a aucune différence entre la configuration candidate et la configuration validée. |
|
|
Synchronisez et validez la configuration sur tous les moteurs de routage, même s’il existe des sessions de configuration ouvertes ou des modifications de configuration non validées sur l’autre moteur de routage. |
|
|
Synchronisez et validez la configuration sur tous les moteurs de routage. |
|
|
Exigez qu’une opération de validation soit confirmée dans un laps de temps spécifié après la validation initiale. Si la validation n’est pas confirmée dans le délai spécifié, rétablissez la configuration précédemment validée. L’option |
– |
|
Attendez la fin de l’opération en utilisant la valeur spécifiée comme délai d’attente. |
30 secondes |
Valider le commentaire
Lorsque vous validez la configuration, vous pouvez inclure un bref commentaire décrivant l’objectif des modifications validées. Pour consigner un commentaire décrivant les modifications, incluez l’argument comment: "comment string"
avec la chaîne de message.
Vérification de la validation
Par défaut, le module exécute à la config
fois une vérification de validation et une opération de validation. L’argument check_commit_wait
définit le nombre de secondes à attendre entre la vérification de validation et les opérations de validation. Incluez cet argument lorsque vous devez prévoir suffisamment de temps pour que l’appareil termine l’opération de vérification de validation et libère le verrou de configuration avant de lancer l’opération de validation. Si vous omettez l’argument check_commit_wait
, il peut y avoir certaines circonstances dans lesquelles un périphérique lance l’opération de validation avant que l’opération de vérification de validation ne libère son verrou sur la configuration, ce qui entraîne un échec de l’opération de CommitError
validation.
Valider les modifications vides
Par défaut, s’il n’y a pas de différence entre la configuration candidate et la configuration validée, le module ne valide pas les modifications. Pour forcer une opération de commit même s’il n’y a pas de différences, incluez l’argument commit_empty_changes: true
.
Valider Synchroniser
Si l’appareil dispose de deux moteurs de routage, vous pouvez synchroniser et valider la configuration sur les deux moteurs de routage en incluant l’argument commit_sync: true
. Pour forcer la réussite de l’opération commit synchronize
même s’il existe des sessions de configuration ouvertes ou des modifications de configuration non validées sur l’autre moteur de routage, utilisez l’argument commit_force_sync: true
. Lorsque vous incluez cette commit_force_sync: true
option, l’appareil met fin à toutes les sessions de configuration sur l’autre moteur de routage avant de synchroniser et de valider la configuration.
Valider Confirmer
Pour exiger qu’une opération de validation soit confirmée dans un laps de temps spécifié après la validation initiale, incluez l’argument confirmed: minutes
. Si la validation n’est pas confirmée dans le délai imparti, la configuration revient automatiquement à la configuration précédemment validée. La plage autorisée est de 1 à 65 535 minutes. L’opération de validation confirmée est utile pour vérifier qu’une modification de configuration fonctionne correctement et n’empêche pas la gestion d’accéder à l’appareil. Si la modification empêche l’accès ou provoque d’autres erreurs, la restauration automatique de la configuration précédente permet d’accéder à l’appareil après la date limite de restauration. Pour confirmer l’opération de validation, appelez le module avec l’argument config
check: true
or commit: true
.
Dans le playbook suivant, la première tâche modifie la configuration, attend 10 secondes entre la vérification de validation et l’opération de validation et exige que l’opération de validation soit confirmée dans les 5 minutes. Il enregistre également un commentaire pour le commit. La deuxième tâche émet une commit check
opération pour confirmer la validation. Dans un scénario réel, vous pouvez effectuer des tâches de validation après la validation initiale et n’exécuter la confirmation de validation que si les tâches répondent à certains critères de validation.
--- - name: "Load configuration and confirm within 5 minutes" hosts: dc1 connection: local gather_facts: no tasks: - name: "Load configuration. Wait 10 seconds between check and commit. Confirm within 5 min." juniper.device.config: load: "merge" format: "text" src: "build_conf/{{ inventory_hostname }}/junos.conf" check_commit_wait: 10 confirmed: 5 comment: "updated using Ansible" register: response - name: "Print the response" ansible.builtin.debug: var: response - name: "Confirm the commit with a commit check" juniper.device.config: check: true diff: false commit: false register: response - name: "Print the response" ansible.builtin.debug: var: response
Comment ignorer les avertissements lors de la configuration d’appareils
Le juniper.device.config
module vous permet de modifier et de valider la configuration sur les équipements Junos. Dans certains cas, la réponse RPC peut contenir <rpc-error>
des éléments avec un niveau de gravité d’avertissement ou supérieur qui amènent le module à lever une RpcError
exception. Une RpcError
exception peut entraîner l’échec de l’opération de chargement ou de validation.
Dans certains cas, il peut être nécessaire ou souhaitable de supprimer les RpcError
exceptions levées en réponse aux avertissements concernant les opérations de chargement et de validation. Vous pouvez demander au module de supprimer RpcError
les config
exceptions levées pour les avertissements en incluant le paramètre dans la ignore_warning
liste des arguments du module. L’argument ignore_warning
prend un booléen, une chaîne ou une liste de chaînes.
Pour demander au module d’ignorer tous les avertissements concernant les opérations de chargement et de validation effectuées par le module, incluez l’argument ignore_warning: true
. L’exemple suivant ignore tous les avertissements relatifs aux opérations de chargement et de validation.
--- - name: Configure Device hosts: dc1 connection: local gather_facts: no tasks: - name: Configure op script juniper.device.config: config_mode: "private" load: "set" lines: - "set system scripts op file bgp.slax" ignore_warning: true register: response - name: Print the response ansible.builtin.debug: var: response
Si vous incluez ignore_warning: true
et que tous les <rpc-error>
éléments ont un niveau de gravité d’avertissement, l’application ignore tous les avertissements et ne lève pas d’exception RpcError
. Toutefois, tous les <rpc-error>
éléments présentant des niveaux de gravité plus élevés lèveront toujours des exceptions.
Pour demander au module d’ignorer des avertissements spécifiques, définissez l’argument ignore_warning
sur une chaîne ou une liste de chaînes contenant les avertissements à ignorer. L’exemple suivant ignore deux avertissements spécifiques :
--- - name: Configure Device hosts: dc1 connection: local gather_facts: no tasks: - name: Configure Junos device and ignore warnings juniper.device.config: config_mode: "private" load: "merge" src: "build_conf/{{ inventory_hostname }}/junos.conf" ignore_warning: - "Advertisement-interval is less than four times" - "Chassis configuration for network services has been changed." register: response - name: Print the response ansible.builtin.debug: var: response
Le module supprime les RpcError
exceptions si tous les <rpc-error>
éléments ont un niveau de gravité d’avertissement et que chaque avertissement de la réponse correspond à une ou plusieurs des chaînes spécifiées.
Exemple : Utiliser Ansible pour configurer des équipements Junos
Le juniper.device.config
module vous permet de gérer la configuration sur les équipements Junos. Cet exemple utilise le config
module pour apporter des modifications de configuration sur un équipement Junos via NETCONF via SSH.
- Exigences
- Aperçu
- Configuration
- Exécuter le playbook
- Vérification
- Résoudre les erreurs dans le playbook
Exigences
Cet exemple utilise les composants matériels et logiciels suivants :
-
Serveur de gestion de la configuration exécutant Ansible 2.17 ou version ultérieure avec la
juniper.device
collection installée -
Équipement Junos sur lequel NETCONF est activé et compte d’utilisateur configuré avec les autorisations appropriées
-
Paire de clés publique/privée SSH configurée pour l’utilisateur approprié sur le contrôleur Ansible et l’équipement Junos
-
Fichier d’inventaire Ansible existant avec les hôtes requis définis
Aperçu
Cet exemple présente un playbook Ansible qui utilise le juniper.device.config
module pour activer un nouveau script op dans la configuration des équipements Junos cibles. Le fichier de données de configuration, junos-config.conf, contient les données de configuration correspondantes au format texte.
Le playbook inclut la Check NETCONF connectivity
tâche, qui utilise le ansible.builtin.wait_for
module Ansible pour tenter d’établir une session NETCONF avec l’équipement cible à l’aide du port NETCONF par défaut (830). Si le nœud de contrôle ne parvient pas à établir une session NETCONF avec un équipement cible pendant l’exécution du playbook, il ignore les tâches restantes dans le jeu pour ce périphérique.
Le playbook utilise le juniper.device.file_copy
module pour copier le nouveau script op du nœud de contrôle Ansible vers l’équipement Junos. Les arguments du module spécifient le répertoire et le nom de fichier du script sur le périphérique local et le répertoire de destination sur le périphérique distant.
La tâche de configuration de l’appareil exécute le juniper.device.config
module à condition que la vérification NETCONF ait réussi. L’argument load: "merge"
charge les nouvelles données de configuration dans la configuration candidate à l’aide d’une load merge
opération. Par défaut, le module valide les config
données de configuration sur un équipement pour load
et rollback
opérations. Les arguments du module incluent l’argument comment
, qui enregistre un commentaire de validation dans le fichier journal système et l’historique de validation de l’appareil.
Configuration
Créer le fichier de données de configuration
Procédure étape par étape
Pour créer le fichier de données de configuration utilisé par le module :
Créez un nouveau fichier avec l’extension appropriée en fonction du format des données de configuration, qui dans cet exemple est du texte.
Incluez les modifications de configuration souhaitées dans le fichier.
user@ansible-cn:~/ansible$ cat build_conf/dc1a.example.net/junos-config.conf system { scripts { op { file bgp.slax; } } }
Créer le playbook Ansible
Procédure étape par étape
Pour créer un playbook qui utilise le config
module pour apporter des modifications de configuration sur un équipement Junos :
Incluez le playbook boilerplate, qui exécute les modules localement.
--- - name: Load and commit configuration data on a Junos device hosts: dc1 connection: local gather_facts: no
(Facultatif) Créez une tâche pour vérifier la connectivité NETCONF.
tasks: - name: Check NETCONF connectivity ansible.builtin.wait_for: host: "{{ inventory_hostname }}" port: 830 timeout: 5
Créez une tâche pour copier le nouveau script op sur l’appareil.
- name: Copy the op script to the device juniper.device.file_copy: action: put file: bgp.slax local_dir: scripts remote_dir: /var/db/scripts/op
Créez la tâche pour charger la configuration sur l’appareil et validez-la.
- name: Merge configuration data from a file and commit juniper.device.config: load: "merge" src: "build_conf/{{ inventory_hostname }}/junos-config.conf" comment: "Configuring op script with Ansible" register: response
(Facultatif) Créez une tâche pour imprimer la réponse, qui inclut les modifications de configuration au format diff .
- name: Print the response ansible.builtin.debug: var: response
Résultats
Sur le nœud de contrôle Ansible, passez en revue le playbook terminé. Si le playbook n’affiche pas le code voulu, répétez les instructions de cet exemple pour corriger le playbook.
--- - name: Load and commit configuration data on a Junos device hosts: dc1 connection: local gather_facts: no tasks: - name: Check NETCONF connectivity ansible.builtin.wait_for: host: "{{ inventory_hostname }}" port: 830 timeout: 5 - name: Copy the op script to the device juniper.device.file_copy: action: put file: bgp.slax local_dir: scripts remote_dir: /var/db/scripts/op - name: Merge configuration data from a file and commit juniper.device.config: load: "merge" src: "build_conf/{{ inventory_hostname }}/junos-config.conf" comment: "Configuring op script with Ansible" register: response - name: Print the response ansible.builtin.debug: var: response
Exécuter le playbook
Pour exécuter le playbook :
-
Émettez la
ansible-playbook
commande sur le nœud de contrôle et indiquez le chemin d’accès au playbook ainsi que les options souhaitées.user@ansible-cn:~/ansible$ ansible-playbook ansible-pb-junos-config.yaml PLAY [Load and commit configuration data on a Junos device] *************** TASK [Check NETCONF connectivity] ***************************************** ok: [dc1a.example.net] TASK [Copy the op script to the device] *********************************** changed: [dc1a.example.net] TASK [Merge configuration data from a file and commit] ******************** changed: [dc1a.example.net] TASK [Print the response] ************************************************* ok: [dc1a.example.net] => { "response": { "changed": true, "diff": { "prepared": "\n[edit system scripts op]\n+ file bgp.slax;\n" }, "diff_lines": [ "", "[edit system scripts op]", "+ file bgp.slax;" ], "failed": false, "file": "build_conf/dc1a.example.net/junos-config.conf", "msg": "Configuration has been: opened, loaded, checked, diffed, committed, closed." } } PLAY RECAP **************************************************************** dc1a.example.net : ok=4 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
Vérification
Vérification de la configuration
But
Vérifiez que la configuration a été correctement mise à jour sur l’équipement Junos.
Action
Consultez la sortie du playbook Ansible pour voir si la tâche de configuration a réussi ou échoué. Vous pouvez également vous connecter au périphérique Junos et afficher la configuration, l’historique des validations et les fichiers journaux pour vérifier la configuration et la validation, par exemple :
user@dc1a> show configuration system scripts op { file bgp.slax; }
user@dc1a> show system commit 0 2020-12-17 15:33:50 PST by user via netconf Configuring op script with Ansible
user@dc1a> show log messages Dec 17 15:33:39 dc1a mgd[33444]: UI_COMMIT: User 'user' requested 'commit' operation (comment: Configuring op script with Ansible) Dec 17 15:33:57 dc1a mgd[33444]: UI_COMMIT_COMPLETED: commit complete
Résoudre les erreurs dans le playbook
- Résoudre les erreurs de délai d’expiration
- Résoudre les erreurs de verrouillage de configuration
- Résoudre les erreurs de changement de configuration
Résoudre les erreurs de délai d’expiration
Problème
Le playbook génère un TimeoutExpiredError
message d’erreur et ne parvient pas à mettre à jour la configuration de l’appareil.
ncclient.operations.errors.TimeoutExpiredError: ncclient timed out while waiting for an rpc reply
Par défaut, le délai d’expiration d’un RPC NETCONF est de 30 secondes. Les modifications de configuration importantes peuvent dépasser cette valeur, ce qui entraîne l’expiration de l’opération avant que la configuration puisse être téléchargée et validée.
Solution
Pour prendre en charge les modifications de configuration qui peuvent nécessiter un temps de validation plus long que l’intervalle de délai d’expiration RPC par défaut, définissez l’argument du timeout
module sur une valeur appropriée et réexécutez le playbook.
Résoudre les erreurs de verrouillage de configuration
Problème
Le playbook génère un LockError
message d’erreur indiquant que la configuration ne peut pas être verrouillée. Par exemple:
FAILED! => {"changed": false, "msg": "Unable to open the configuration in exclusive mode: LockError(severity: error, bad_element: None, message: configuration database modified)"}
ou
FAILED! => {"changed": false, "msg": "Unable to open the configuration in exclusive mode: LockError(severity: error, bad_element: lock-configuration, message: permission denied)"}
Une erreur de verrouillage de configuration peut se produire pour les raisons suivantes :
-
Un autre utilisateur dispose d’un verrou exclusif sur la configuration.
-
Un autre utilisateur a apporté des modifications à la base de données de configuration, mais ne les a pas encore validées.
-
L’utilisateur qui exécute le module Ansible n’est pas autorisé à configurer l’appareil.
Solution
La LockError
chaîne de message indique généralement la cause racine du problème. Si un autre utilisateur dispose d’un verrou exclusif sur la configuration ou l’a modifiée, attendez que le verrou soit libéré ou que les modifications soient validées, puis exécutez à nouveau le playbook. Si la cause du problème est que l’utilisateur ne dispose pas des autorisations nécessaires pour configurer le périphérique, exécutez le playbook avec un utilisateur disposant des autorisations nécessaires ou, le cas échéant, configurez le périphérique Junos pour donner à l’utilisateur actuel les autorisations nécessaires pour effectuer les modifications.
Résoudre les erreurs de changement de configuration
Problème
Le playbook génère un ConfigLoadError
message d’erreur indiquant que la configuration ne peut pas être modifiée, car l’autorisation est refusée.
FAILED! => {"changed": false, "msg": "Failure loading the configuraton: ConfigLoadError(severity: error, bad_element: scripts, message: error: permission denied)"}
Ce message d’erreur est généré lorsque l’utilisateur exécutant le module Ansible est autorisé à modifier la configuration, mais n’a pas l’autorisation de modifier la section demandée de la configuration.
Solution
Exécutez le playbook avec un utilisateur disposant des autorisations nécessaires ou, le cas échéant, configurez le périphérique Junos de manière à ce qu’il accorde à l’utilisateur actuel les autorisations nécessaires pour effectuer les modifications.