Utiliser Ansible pour configurer des périphériques Junos

Les config modules et juniper_junos_config vous permettent 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 de nouvelles données de configuration, soit le load paramètre pour revenir à la configuration de rollback 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 la rendre active, puis à déverrouiller la configuration.

Par défaut, les config modules et apportent des modifications à la base de données de configuration candidate à l’aide du configure exclusive mode qui verrouille et juniper_junos_config déverrouille automatiquement la configuration globale candidate. Vous pouvez également apporter des modifications à une copie privée de la configuration candidate. Pour plus d’informations sur la spécification du mode de configuration, consultez Comment spécifier le mode de configuration.

Lors du chargement de nouvelles données de configuration, outre 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 configuration candidate. Les fonctions prennent en charge bon nombre des mêmes opérations de chargement que celles disponibles dans l’interface de ligne de commande Junos OS. Pour plus d’informations, consultez Comment spécifier 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 JSON. Pour plus d’informations sur la spécification du format des données de configuration, consultez Comment spécifier le format des données de configuration à charger.

• Source de données de configuration : vous pouvez charger les 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 depuis l’appareil client en incluant respectivement le linesparamètre , src, templateou url . Pour plus d’informations sur la spécification de la source des données de configuration, consultez les sections suivantes :

  • 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

Les config modules et vous permettent également de charger et juniper_junos_config de valider la configuration de secours ou de restaurer 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 module rollback . Pour plus d’informations, consultez les sections suivantes :

• Comment charger la configuration de sauvetage

• Comment restaurer la configuration

Après avoir modifié la configuration, vous devez valider la configuration pour en faire la configuration active sur l’appareil. Par défaut, les modules et juniper_junos_config valident les config modifications apportées à la configuration. Pour modifier ce comportement ou fournir des options de validation supplémentaires, consultez Comment valider la configuration.

Par défaut, lorsque le module ou inclut les arguments ou pour modifier la configuration, le config module renvoie automatiquement les load modifications de configuration au format diff ou juniper_junos_config rollback patch dans la réponse du module. Les différences sont renvoyées dans les diff variables etdiff_lines. Pour empêcher le module de calculer et de renvoyer les différences, définissez l’argument diff module sur false.

Vous pouvez spécifier le mode de configuration à utiliser lors de la modification de la base de données de configuration candidate. Par défaut, les config modules et juniper_junos_config apportent 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 pour apporter les modifications demandées à la configuration. Le verrouillage de la base de données empêche les autres utilisateurs de modifier ou de valider les modifications apportées à la base de données tant que le verrou n’est pas levé.

Pour spécifier le mode, incluez le config_mode paramètre dans la liste d’arguments du module. Les modes pris en charge incluent exclusive et private. Les deux modes ignorent toutes les modifications non validées à la sortie.

Le playbook suivant utilise configure private le mode pour modifier la configuration :

Les config modules et juniper_junos_config prennent en charge le chargement des modifications de configuration en utilisant bon nombre des mêmes opérations de chargement que celles prises en charge dans l’interface de ligne de commande Junos OS. Vous spécifiez l’opération de chargement en incluant le load paramètre dans la liste d’arguments du module et en le définissant sur la valeur de l’opération de chargement correspondante. Le tableau 2 récapitule les paramètres requis pour chaque type d’opération de charge.

Tableau 2 : paramètres permettant de spécifier l’opération de chargement

Opération de chargement	load Argument	Description
load merge	load: "merge"	Fusionnez la configuration chargée avec la configuration existante.
load override	load: "override"	Remplacez l’ensemble de la configuration par la configuration chargée.
load replace	load "replace"	Fusionnez la configuration chargée avec la configuration existante, mais remplacez les instructions de la configuration existante par celles qui spécifient la balise dans la replace: configuration chargée. S’il n’y a pas d’instruction dans la configuration existante, l’instruction dans la configuration chargée est ajoutée.
load patch	load: "patch"	Chargez les données de configuration à partir d’un fichier correctif.
load set	load: "set"	Chargez les données de configuration formatées set . Les données de configuration sont chargées ligne par ligne et peuvent contenir des commandes de mode de configuration telles que set, deleteet deactivate.
load update	load: "update"	Comparez la configuration chargée complète à la configuration existante. Chaque élément de configuration différent dans la configuration chargée remplace l’élément correspondant dans la configuration existante. Pendant l’opération de validation, seuls les processus système affectés par les éléments de configuration modifiés analysent la nouvelle configuration.

Les config modules et juniper_junos_config vous permettent de configurer des é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 incluent du texte, des éléments XML Junos, des commandes Junos OS set et JSON.

Note:

À partir de Junos OS version 16.1R1, les équipements Junos prennent en charge le chargement des données de configuration au format JSON.

Les config modules et juniper_junos_config tentent de détecter automatiquement le format des données de configuration fournies sous forme de chaînes à l’aide de 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 en ajoutant l’extension appropriée au fichier ou 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.

Tableau 3 : spécification du format des données de configuration

Format des données de configuration	Extension De Fichier	paramètre de format
Instructions de configuration CLI (texte)	.Conf	« text »
Notation d’objet JavaScript (JSON)	.Json	« json »
Commandes Junos OS set	.Ensemble	« set »
Éléments XML Junos	.Xml	« xml »

Note:

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 .

Les config modules et juniper_junos_config vous permettent 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.

Les modules tentent 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, consultez Comment spécifier le format des données de configuration à charger. Si vous incluez le paramètre dans la liste d’arguments du module, il remplace le format format de détection automatique.

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 .

Le playbook suivant configure les mêmes instructions à l’aide de lines données de configuration au format texte. Dans ce cas, load: "merge" est utilisé.

Les config modules et juniper_junos_config vous permettent 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 depuis l’appareil client

Lorsque vous chargez des données de configuration à partir d’un fichier, vous devez indiquer le format des données de configuration dans le fichier et l’emplacement du fichier. Les formats de données de configuration pris en charge incluent 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 en incluant explicitement le format paramètre dans la liste d’arguments du module ou en ajoutant l’extension appropriée au fichier de données de configuration. Si vous spécifiez le paramètre, il remplace le format format indiqué par l’extension de fichier. Pour plus d’informations sur la spécification du format, consultez Comment spécifier le format des données de configuration à charger. Lorsque les données de configuration utilisent le format XML Junos, vous devez les placer dans la balise de niveau <configuration> supérieur.

Note:

Vous n’avez pas besoin d’inclure des données de configuration au format texte ASCII, commandes Junos OS set ou JSON dans , ou <configuration-json> balises, <configuration-set>comme requis lors de la configuration du périphérique directement dans <configuration-text>une session NETCONF.

Le tableau 4 présente les paramètres de module que vous pouvez inclure pour spécifier l’emplacement du fichier.

Tableau 4 : spécification de l’emplacement du fichier de configuration

Paramètre de module	Description
src	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.
url	Chemin absolu ou relatif d’accès à un fichier sur l’appareil client, à un emplacement FTP ou à une URL HTTP (Hypertext Transfer Protocol). Le répertoire par défaut sur l’appareil client est le répertoire de travail actuel, qui est par défaut le répertoire de base 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 d’accès absolu ou relatif du fichier contenant les données de configuration. Par exemple :

Pour charger des données de configuration à partir d’un fichier sur le périphérique Junos géré 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 :

La valeur de peut url être un chemin d’accès de fichier local absolu ou relatif, un emplacement FTP ou une URL HTTP (Hypertext Transfer Protocol).

• Un nom de fichier local peut avoir 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).

• Un nom de fichier pour un fichier sur un serveur FTP a la forme suivante :

• Le nom d’un fichier sur un serveur HTTP se présente sous la forme suivante :

Dans chaque cas, la valeur par défaut de la path variable est le répertoire de base de l’utilisateur. Pour spécifier un chemin absolu, l’application commence le chemin avec les caractères %2F ; par exemple, ftp://username :password@hostname/%2Fpath/filename.

Les config modules et vous permettent de restituer les données de configuration d’un fichier de modèle Jinja2 sur le nœud de contrôle Ansible, puis de charger et juniper_junos_config valider la configuration sur un équipement Junos. Jinja est un moteur de template 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 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, qui inclut du texte ASCII, des éléments XML Junos, des commandes Junos OS set et JSON. Les modules Ansible utilisent le modèle Jinja2 et un dictionnaire de variables fourni pour restituer les données de configuration.

Pour charger et valider des données de configuration à l’aide d’un modèle Jinja2, incluez les template paramètres et vars dans la liste d’arguments du module.

• template—Chemin du fichier de modèle Jinja2

• vars—Dictionnaire des clés et des valeurs requises pour rendre le modèle Jinja2

Vous devez également inclure le paramètre lorsque l’extension de fichier des modèles n’indique pas le format format des données. Pour plus d’informations sur la spécification du format, consultez Comment spécifier le format des données de configuration à charger.

Par exemple, le fichier interfaces-mpls.j2 contient le modèle Jinja2 suivant :

Pour utiliser le module ou juniper_junos_config pour charger le modèle Jinja2, définissez l’argument template sur le chemin d’accès du fichier de modèle et définissez les variables requises par le modèle dans le config vars dictionnaire. Le playbook suivant utilise le modèle Jinja2 et les variables définies dans vars pour restituer les données de configuration et 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.

Le module génère les données de configuration suivantes, qui sont chargées dans la configuration candidate sur l’appareil et validées :

Une configuration de secours vous permet de définir une configuration de travail connue ou une configuration avec un état connu que vous pouvez restaurer à tout moment. Vous utilisez 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 endommagés de manière irréparable. Lorsque vous créez une configuration de secours, l’appareil enregistre la dernière configuration validée en tant que configuration de secours.

Les config modules et juniper_junos_config vous permettent de revenir à une configuration de sauvetage existante sur les équipements Junos. Pour charger et valider la configuration de secours sur un appareil, incluez l’argument du rollback: "rescue" module. Par exemple :

Les appareils Junos stockent une copie de la dernière configuration validée et jusqu’à 49 configurations précédentes, selon la plate-forme. Vous pouvez revenir à n’importe quelle configuration stockée. Ceci est utile lorsque les 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’ensemble de la configuration candidate par une configuration précédemment validée.

Les config modules et juniper_junos_config vous permettent 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 comprises entre 0 (zéro pour la dernière configuration validée) et une de moins que le nombre de configurations précédentes stockées (49 au maximum).

Le playbook suivant vous invite à indiquer l’ID de restauration de la configuration à restaurer, annule la configuration et la valide, puis imprime les modifications de configuration à la sortie standard.

Par défaut, lorsque vous utilisez le module ou pour modifier la configuration à l’aide de l’argument load ou juniper_junos_config rollback, le config 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 avec bon nombre des options disponibles dans l’interface de ligne de commande Junos OS. Le tableau 5 présente les arguments de module que vous pouvez utiliser pour spécifier différentes options de validation.

Tableau 5 : options de validation

Module Argument	Description	Valeur par défaut pour load et rollback opérations
check: boolean	Effectuez une vérification de validation ou confirmez une opération de validation confirmée précédente.	True
check_commit_wait: seconds	Attendez le nombre de secondes spécifié entre la vérification de validation et l’opération de validation.	–
comment: "string"	Consignez un commentaire pour cette opération de validation dans le fichier journal système et dans l’historique des validations de l’appareil.	–
commit: boolean	Validez les modifications de configuration ou confirmez une opération de validation confirmée précédente.	True
commit_empty_changes: boolean	Validez les modifications de configuration même s’il n’y a aucune différence entre la configuration candidate et la configuration validée.	False
confirmed: minutes	Exigez qu’une opération de validation soit confirmée dans un délai spécifié après la validation initiale. Sinon, revenez à la configuration précédemment validée. L’option commit: true ou l’option check: true doit être utilisée pour confirmer la validation.	–

Lorsque vous validez la configuration, vous pouvez inclure un bref commentaire pour décrire 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.

Par défaut, les modules et exécutent à la config fois une vérification de validation et juniper_junos_config une opération de validation. L’argument check_commit_wait définit le nombre de secondes à attendre entre les opérations de vérification de validation et de validation. Incluez cet argument lorsque vous devez laisser suffisamment de temps à l’appareil pour terminer l’opération de vérification de validation et libérer le verrou de configuration avant de lancer l’opération de validation. Si vous omettez cet argument, il peut arriver qu’un périphérique lance l’opération de validation avant que l’opération de vérification de validation ne relâche son verrou sur la configuration, ce qui entraîne l’échec de l’opération CommitError de validation.

Par défaut, s’il n’y a pas de différences entre la configuration candidate et la configuration validée, le module ne valide pas les modifications. Pour forcer une opération de validation même en l’absence de différences, incluez l’argument commit_empty_changes: true .

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’argumentconfirmed: 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 l’accès de gestion à l’équipement. 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 l’expiration du délai de restauration. Pour confirmer l’opération de validation, appelez le config module ou avec l’argument check: true ou juniper_junos_config 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 requiert 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 le commit. 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.

Les config modules et vous permettent de modifier et juniper_junos_config 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 provoquent le déclenchement d’une RpcError exception par le module, provoquant ainsi l’échec de l’opération de chargement ou de validation.

Dans certains cas, il peut être nécessaire ou souhaitable de supprimer les exceptions déclenchées en réponse aux avertissements concernant les RpcError opérations de chargement et de validation. Vous pouvez demander config aux modules et juniper_junos_config de supprimer RpcError les exceptions déclenchées pour les avertissements en incluant le paramètre dans la ignore_warning liste d’arguments du module. L’argument ignore_warning prend un booléen, une chaîne ou une liste de chaînes.

Pour indiquer 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 pour les opérations de chargement et de validation.

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 déclenche RpcError pas d’exception. Toutefois, tous les <rpc-error> éléments présentant des niveaux de gravité plus élevés soulè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 :

Le module supprime RpcError les 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.