Utiliser Junos Snapshot Administrator en Python (JSNAPy) dans les playbooks Ansible

Le juniper.device.jsnapy module vous permet d’exécuter des fonctions JSNAPy à partir d’un playbook Ansible, notamment :

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

• Comparaison de deux instantanés

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

Le module nécessite de spécifier l’argument action et l’argument ou config_file l’argument test_files . L’argument action spécifie l’action JSNAPy à effectuer. Le Tableau 2 présente les valeurs valides action et les commandes JSNAPy équivalentes.

Tableau 2 : valeurs d’argument de l’action jsnapy

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 section du fichier de hosts configuration. En revanche, le module Ansible exécute l’action demandée sur les hôtes spécifiés dans le playbook Ansible. En conséquence, 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 action , le juniper.device.jsnapy module a également besoin de l’argument config_file ou de l’argument test_files pour spécifier le fichier de configuration JSNAPy ou les fichiers de test JSNAPy à utiliser pour l’action donnée. Le tableau 3 présente les config_file arguments and test_files .

Tableau 3 : Arguments de fichier jsnapy

Argument du module	Valeur	Informations complé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é : Annuaire des playbooks Ansible dir répertoire d’arguments, s’il est fourni /etc/jsnapy/testfiles (uniquement si l’argument dir est omis) Si le fichier de configuration fait référence aux fichiers de test à l’aide d’un chemin d’accès relatif, le module vérifie 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 , ce qui varie en fonction de la version de JSNAPy et de votre environnement.
test_files	Chemin d’accès absolu ou relatif à un fichier de test JSNAPy. Il peut s’agir d’un chemin d’accès à un seul fichier ou d’une liste de chemins d’accès aux fichiers.	Pour chaque fichier de test qui spécifie un chemin relatif, le module vérifie le fichier aux emplacements suivants et dans l’ordre indiqué : Annuaire des playbooks Ansible dir répertoire d’arguments, s’il est fourni /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 au fichier, vous pouvez éventuellement inclure l’argument dir module pour spécifier le répertoire dans lequel résident les fichiers. Si un config_file argument ou test_files utilise un 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 dans le répertoire playbook, le module vérifie dans le dir répertoire des arguments, s’il est spécifié, ou dans le 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.

Il est important de noter que lorsque vous incluez le dir paramètre, le module vérifie cet emplacement uniquement pour l’argument ou test_files spécifiéconfig_file. Ainsi, lorsque vous spécifiez un fichier de configuration, le module ne vérifie pas le dir répertoire des fichiers de test que vous spécifiez dans le fichier de configuration. Si le fichier de configuration fait référence à des chemins relatifs pour les fichiers de test, le module recherche les fichiers de test uniquement dans le répertoire playbook et dans le répertoire par défauttestfiles.

Supposons que vous ayez le fichier de configuration JSNAPy suivant, jsnapy_config_base_tests.yaml, qui réside dans le répertoire ~/jsnapy/testfiles et fait référence à plusieurs fichiers de test JSNAPy :

L’exemple de playbook suivant effectue l’action snap_pre pour chacun des fichiers de test du fichier de configuration jsnapy_config_base_tests.yaml . Si le fichier de configuration n’existe pas dans le répertoire playbook, le module recherche le fichier dans le dir répertoire, qui dans ce cas est ~/jsnapy/testfiles. Le fichier de configuration utilise des chemins relatifs pour les fichiers de test. Par conséquent, le module vérifie d’abord les fichiers de test dans le répertoire playbook, puis recherche les fichiers de test dans le répertoire testfiles par défaut.

Alternativement, le jsnapy module peut utiliser le test_files paramètre pour spécifier les fichiers de test individuels à utiliser. Le playbook suivant exécute les mêmes tests que dans l’exemple du playbook précédent. Dans ce cas, le module vérifie d’abord les fichiers de test dans le répertoire playbook, puis vérifie les fichiers de test dans le dir répertoire.

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. Toutefois, 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 comprenant 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 ansible.builtin.assert module pour vérifier le 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 . Le juniper.device.jsnapy module peut éventuellement inclure l’argument logfile , qui spécifie le chemin d’accès à 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 de détail et les options de débogage d’Ansible déterminent le niveau d’informations enregistrées dans le fichier. Par défaut, seuls les messages de niveau de gravité AVERTISSEMENT ou supérieur sont consigné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 -v de ligne de commande ou -vv respectivement.

Lorsque vous exécutez des tests JSNAPy dans un playbook Ansible, vous pouvez enregistrer ou résumer les informations relatives aux tests JSNAPy ayant échoué. Pour plus d’informations, consultez Examiner les tests JSNAPy ayant échoué.

JSNAPy vous permet de capturer des instantanés de l’environnement d’exécution de vos équipements Junos avant et après une modification, puis de comparer les instantanés pour vérifier les changements attendus ou identifier des problèmes inattendus. Le juniper.device.jsnapy module vous permet de prendre et de comparer des instantanés JSNAPy dans le cadre d’un playbook Ansible. Le module enregistre chaque snapshot de chaque hôte dans un fichier séparé dans le répertoire d’instantanés JSNAPy par défaut en utilisant un nom de fichier prédéterminé. Pour plus d’informations sur les fichiers de sortie, consultez Comprendre la sortie du module jsnapy.

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

Le playbook suivant enregistre les instantanés PRE pour chaque appareil du groupe d’inventaire Ansible. La tâche fait référence au fichier de configuration jsnapy_config_base_tests.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 de l’auto-test de démarrage (POST) pour chaque appareil du groupe d’inventaire Ansible. La tâche fait référence au même fichier de configuration jsnapy_config_base_tests.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 effectue une snap_pre action ou une snap_post action, il enregistre chaque instantané de chaque hôte dans un fichier séparé à l'aide de noms de fichiers générés automatiquement qui contiennent une balise 'PRE' ou 'POST', respectivement. Pour comparer les instantanés et PRE POST afin de vérifier rapidement les mises à jour ou d’identifier les problèmes susceptibles d’avoir résulté des modifications, définissez l’argument du module sur check, et spécifiez le même fichier de action configuration ou les mêmes fichiers de test que ceux utilisés pour prendre les instantanés.

Lorsque le module effectue une check action, JSNAPy compare les instantanés PRE et POST de chaque test sur chaque appareil et les évalue 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 à la place les instantanés nœud par nœud. Pour vérifier les résultats du test, enregistrez la réponse du module, puis utilisez le ansible.builtin.assert module pour vérifier le résultat attendu dans la réponse.

Le guide suivant compare les instantanés pris pour les appareils précédemment exécutés snap_pre 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 sous la forme 'test_result' et utilise le ansible.builtin.assert module pour vérifier que tous les tests réussis sur l'appareil 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. Le juniper.device.jsnapy module vous permet d’effectuer une opération de vérification d’enclenchement JSNAPy dans le cadre d’un playbook Ansible.

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

Par exemple, pour chaque appareil 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 ansible.builtin.assert module 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, vous pouvez rapidement vérifier si tous les tests JSNAPy ont réussi en enregistrant la jsnapy réponse du module et en utilisant le ansible.builtin.assert module pour vérifier que le passPercentage est égal à 100. Toutefois, en cas d’échec d’un ou de plusieurs tests, il peut être difficile d’identifier et d’extraire les tests ayant échoué si les résultats sont nombreux.

Le juniper.device.jsnapy module fournit les options suivantes pour voir les tests JSNAPy ayant échoué :

• jsnapy plug-in de rappel : affiche un résumé des tests JSNAPy ayant échoué après la sortie du playbook.

• dest_dir module argument : écrit les tests JSNAPy ayant échoué dans les fichiers du répertoire spécifié.

Le jsnapy plugin de rappel vous permet d’extraire et de résumer facilement les informations sur les tests JSNAPy ayant échoué. Lorsque vous activez le jsnapy plug-in de rappel et exécutez un playbook qui inclut des tests JSNAPy, le plug-in résume les informations relatives aux tests JSNAPy ayant échoué après le playbook PLAY RECAP.

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

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

À partir de juniper.device la version 1.0.6, le juniper.device.jsnapy module prend également en charge l’argumentdest_dir. Vous pouvez inclure l’argument et snapcheck check les dest_dir opérations qui évaluent les instantanés par rapport à des critères de test. Lorsque vous effectuez une check opération ou snapcheck et que vous incluez l’argumentdest_dir, le module écrit chaque test JSNAPy ayant échoué pour un hôte donné dans un fichier du répertoire de sortie spécifié.

Par exemple, considérez le guide suivant :

Lorsque vous exécutez le playbook, le module génère un fichier dans le dest_dir répertoire pour chaque test ayant échoué sur l’hôte donné. Par exemple, les fichiers suivants ont été générés pour les échecs bgp_neighbor et bgp_summary les tests sur les hôtes r1 et r3.