Utiliser Junos Snapshot Administrator en Python (JSNAPy) dans Ansible Playbooks

Les jsnapy modules et juniper_junos_jsnapy vous permettent d’exécuter bon nombre des mêmes fonctions JSNAPy à partir d’un playbook Ansible que vous pouvez exécuter à l’aide de JSNAPy sur la ligne de commande, notamment :

• Capture et enregistrement d’un instantané de l’environnement d’exécution

• Comparaison de deux instantanés

• capturer un instantané et l’évaluer immédiatement

Les modules nécessitent de spécifier l’argument et l’argument action ou config_file test_files . L’argument action spécifie l’action JSNAPy à exécuter. Le tableau 2 présente les valeurs valides action et les commandes JSNAPy équivalentes.

Tableau 2 : action jsnapy et juniper_junos_jsnapy Valeurs des arguments

Valeur de l’action	Description	Commande JSNAPy équivalente
check	Comparez deux instantanés existants en fonction des cas de test donnés ou, si aucun cas de test n’est fourni, comparez les instantanés nœud par nœud.	jsnapy --check
snap_post	Prenez des instantanés pour les commandes ou les RPC spécifiés dans les fichiers de test après avoir apporté des modifications sur les périphériques donnés.	jsnapy --snap
snap_pre	Prenez des instantanés pour les commandes ou les RPC spécifiés dans les fichiers de test avant d’apporter des modifications sur les périphériques donnés.	jsnapy --snap
snapcheck	Prenez des instantanés des commandes ou des RPC spécifiés dans les fichiers de test et évaluez-les immédiatement par rapport à des critères prédéfinis dans les cas de test.	jsnapy --snapcheck

Lorsque vous exécutez JSNAPy sur la ligne de commande, JSNAPy effectue l’action demandée sur les hôtes spécifiés dans la hosts section du fichier de configuration. En revanche, les modules Ansible exécutent l’action demandée sur les hôtes du groupe d’inventaire Ansible défini dans le playbook. Par conséquent, le module peut soit référencer un fichier de configuration, en ignorant la hosts section, soit référencer directement un ou plusieurs fichiers de test.

Ainsi, en plus de l’argument, les modules et nécessitent également l’argument ou l’argument pour spécifier le fichier de configuration JSNAPy ou les fichiers de test JSNAPy à utiliser pour l’action action config_file test_files donnée. Le tableau 3 présente les config_file jsnapy arguments et.juniper_junos_jsnapy test_files

Tableau 3 : arguments de fichier jsnapy et juniper_junos_jsnapy

Module argument	Valeur	Informations supplémentaires
config_file	Chemin d’accès absolu ou relatif à un fichier de configuration JSNAPy.	Si le chemin est relatif, le module recherche le fichier de configuration aux emplacements suivants et dans l’ordre indiqué : Répertoire du playbook Ansible dir répertoire d’arguments, s’il est fourni Répertoire /etc/jsnapy/testfiles (uniquement si l’argument dir est omis) Si le fichier de configuration référence les fichiers de test à l’aide d’un chemin d’accès relatif, le module recherche d’abord les fichiers de test dans le répertoire playbook, puis recherche les fichiers de test dans le répertoire par défaut testfiles , qui varie en fonction de la version de JSNAPy et de votre environnement.
test_files	Chemin d’accès absolu ou relatif à un fichier test JSNAPy. Il peut s’agir d’un chemin d’accès à un seul fichier ou d’une liste de chemins d’accès.	Pour chaque fichier de test qui spécifie un chemin relatif, le module recherche le fichier aux emplacements suivants et dans l’ordre indiqué : Répertoire du playbook Ansible dir répertoire d’arguments, s’il est fourni Répertoire /etc/jsnapy/testfiles (uniquement si l’argument dir est omis)

Les config_file arguments et test_files peuvent prendre un chemin d’accès absolu ou relatif. Lorsque vous utilisez un chemin d’accès relatif, vous pouvez éventuellement inclure l’argument dir module pour spécifier le répertoire dans lequel résident les fichiers. Si un argument ou test_files utilise un config_file chemin d’accès relatif au fichier, le module vérifie d’abord le fichier dans le répertoire du playbook Ansible, même si l’argument dir est présent. Si le fichier n’existe pas sous le répertoire playbook, le module vérifie sous le répertoire des arguments, s’il est spécifié, ou sous le dir répertoire /etc/jsnapy/testfiles, si l’argument dir est omis. Le playbook génère un message d’erreur si le fichier est introuvable.

L’exemple de playbook suivant exécute l’action à l’aide snap_pre du fichier de configuration configuration_interface_status.yaml. Si le fichier de configuration n’existe pas dans le répertoire playbook, le module recherche le fichier dans le répertoire personnel de l’utilisateur sous le sous-répertoire jsnapy/testfiles .

Note:

À partir de Junos Snapshot Administrator dans Python version 1.3.0, l’emplacement par défaut des fichiers de configuration et de test est ~/jsnapy/testfiles. Cependant, l’emplacement par défaut dans un environnement virtuel ou pour les versions antérieures est / etc/jsnapy/testfiles.

Le module effectue l’action demandée sur les hôtes spécifiés dans le playbook Ansible, même s’il fait référence à un fichier de configuration qui inclut une hosts section. Le module signale un échec s’il rencontre une erreur et ne parvient pas à exécuter les tests JSNAPy. Il ne signale pas d’échec si un ou plusieurs des tests JSNAPy échouent. Pour vérifier les résultats du test JSNAPy, enregistrez la réponse du module et utilisez le module pour vérifier le assert résultat attendu dans la réponse.

Junos Snapshot Administrator en Python consigne par défaut les informations relatives à ses opérations dans le fichier / var/log/jsnapy/jsnapy.log . Les jsnapy modules et juniper_junos_jsnapy peuvent éventuellement inclure l’argument, qui spécifie le chemin d’accès logfile à un fichier accessible en écriture sur le nœud de contrôle Ansible où les informations relatives à la tâche particulière sont consignées. Le niveau d’informations enregistrées dans le fichier est déterminé par le niveau de détail et les options de débogage d’Ansible. Par défaut, seuls les messages de niveau de gravité AVERTISSEMENT ou supérieur sont enregistrés. Pour consigner des messages égaux ou supérieurs au niveau de gravité INFO ou au niveau de gravité DEBUG, exécutez le playbook avec l’option de ligne de -v commande ou -vv , respectivement.

Lorsque vous exécutez des tests JSNAPy dans un playbook Ansible, vous pouvez activer le plug-in de rappel pour capturer et résumer les jsnapy informations relatives aux tests JSNAPy ayant échoué. Pour activer le plug-in de rappel, ajoutez l’instruction callback_whitelist = jsnapy au fichier de configuration Ansible. Pour plus d’informations, consultez Activer le plug-in de rappel jsnapy.

JSNAPy vous permet de capturer des instantanés de l’environnement d’exécution de vos périphériques Junos réseau avant et après une modification, puis de comparer les instantanés pour vérifier les modifications attendues ou identifier les problèmes inattendus. Les jsnapy modules et juniper_junos_jsnapy Ansible vous permettent de prendre et de comparer des instantanés JSNAPy dans le cadre d’un playbook Ansible. Les modules enregistrent chaque snapshot pour chaque hôte dans un fichier séparé du répertoire de snapshots JSNAPy par défaut à l’aide d’un nom de fichier prédéterminé. Pour plus d’informations sur les fichiers de sortie, consultez Présentation de la sortie du module jsnapy et juniper_junos_jsnapy.

Pour prendre des instantanés de base d’un ou de plusieurs périphériques avant d’apporter des modifications, définissez l’argument du action module sur snap_pre, puis spécifiez un fichier de configuration ou un ou plusieurs fichiers de test.

Le playbook suivant enregistre les instantanés PRE pour chaque périphérique du groupe d’inventaire Ansible. La tâche référence le fichier de configuration configuration_interface_status.yaml dans le répertoire ~/jsnapy/testfiles et consigne les messages dans le fichier jsnapy_tests.log dans le répertoire playbook.

Pour prendre un instantané d’un ou de plusieurs périphériques après avoir effectué des modifications, définissez l’argument du action module sur snap_post, puis spécifiez un fichier de configuration ou un ou plusieurs fichiers de test.

Le playbook suivant enregistre les instantanés POST pour chaque périphérique du groupe d’inventaire Ansible. La tâche fait référence au même fichier de configuration configuration_interface_status.yaml dans le répertoire ~/jsnapy/testfiles et consigne les messages dans le fichier jsnapy_tests.log du répertoire playbook.

Lorsque le jsnapy module ou effectue une action ou une action, il enregistre chaque instantané pour chaque hôte dans un fichier distinct à l'aide de noms de fichiers générés automatiquement qui contiennent respectivement une snap_pre snap_post balise 'PRE' ou juniper_junos_jsnapy 'POST'. Pour comparer les instantanés et POST afin de vérifier rapidement les mises à jour ou d’identifier les problèmes susceptibles d’avoir pu résulter des modifications, définissez l’argument du action module sur check, et spécifiez le ou les mêmes fichiers de test que ceux utilisés pour prendre les PRE instantanés.

Lorsque le module effectue une check action, les instantanés PRE et POST préexistants pour chaque test sur chaque appareil sont comparés et évalués par rapport aux critères définis dans la tests: section des fichiers de test. Si les fichiers de test ne définissent aucun cas de test, JSNAPy compare les snapshots nœud par nœud. Pour vérifier les résultats du test, enregistrez la réponse du module et utilisez le module pour vérifier le assert résultat attendu dans la réponse.

Le playbook suivant compare les instantanés pris pour les exécutions snap_pre précédentes et snap_post les actions pour chaque appareil du groupe d’inventaire Ansible. Les résultats sont évalués à l’aide des critères des fichiers de test référencés dans le fichier de configuration. Le playbook enregistre la réponse du module comme '' et utilise le assert module pour vérifier que tous les tests ont réussi sur l'test_resultappareil donné.

Lorsque vous exécutez le playbook, les assertions identifient rapidement les appareils qui ont échoué aux tests.

JSNAPy vous permet de prendre des instantanés pour les commandes ou les RPC spécifiés dans les fichiers de test JSNAPy et d’évaluer immédiatement les instantanés par rapport à des critères prédéfinis dans les cas de test. Les jsnapy modules et juniper_junos_jsnapy Ansible vous permettent d’effectuer une opération snapcheck JSNAPy dans le cadre d’un playbook Ansible.

Pour prendre un instantané et l’évaluer immédiatement en fonction de l’ensemble de critères prédéfinis dans la tests: section des fichiers de test, définissez l’argument du action module sur snapcheck, puis spécifiez un fichier de configuration ou un ou plusieurs fichiers de test. Pour vérifier les résultats du test, enregistrez la réponse du module et utilisez le module pour vérifier le assert résultat attendu dans la réponse.

Par exemple, pour chaque périphérique du groupe d’inventaire Ansible, le playbook suivant enregistre un instantané distinct pour chaque commande ou RPC dans les fichiers de test, enregistre la réponse du module et utilise le module assert pour vérifier que tous les tests définis dans les fichiers de test ont réussi sur cet appareil.

Lorsque vous exécutez des tests JSNAPy sur des périphériques Junos et qu’un ou plusieurs tests échouent, il peut être difficile d’identifier et d’extraire les tests échoués si le résultat est étendu. Le jsnapy plug-in de rappel vous permet d’extraire et de résumer facilement les informations relatives aux tests JSNAPy qui ont échoué. Lorsque vous activez le plug-in de rappel et exécutez un playbook qui inclut des tests JSNAPy, le plug-in résume les informations pour les tests JSNAPy ayant échoué après le jsnapy playbook PLAY RECAP.

Le jsnapy plug-in de rappel n’est pas activé par défaut. Pour activer le plug-in de rappel, ajoutez l’instruction callback_whitelist = jsnapy au fichier de jsnapy configuration Ansible.

Lorsque vous activez le plug-in de rappel et exécutez un playbook, le jsnapy plug-in résume les tests JSNAPy échoués dans un format lisible par l’homme. Par exemple :