Usar el administrador de instantáneas de Junos en Python (JSNAPy) en los manuales de estrategia de Ansible

El juniper.device.jsnapy módulo le permite ejecutar funciones de JSNAPy desde un manual de estrategias de Ansible, que incluye:

• Captura y guardado de una instantánea del entorno de ejecución

• Comparación de dos instantáneas

• Captura de una instantánea y evaluación inmediata

El módulo requiere especificar el action argumento y el o el config_file test_files argumento. El action argumento especifica la acción JSNAPy que se va a realizar. En la tabla 2 se describen los valores válidos action y los comandos JSNAPy equivalentes.

Tabla 2: Valores de argumento de acción jsnapy

action Valor	Descripción	Comando JSNAPy equivalente
check	Compare dos instantáneas existentes basadas en los casos de prueba dados o, si no se proporciona ningún caso de prueba, compare las instantáneas nodo por nodo.	jsnapy --check
snap_post	Tome instantáneas de los comandos o RPC especificados en los archivos de prueba después de realizar cambios en los dispositivos especificados.	jsnapy --snap
snap_pre	Tome instantáneas de los comandos o RPC especificados en los archivos de prueba antes de realizar cambios en los dispositivos especificados.	jsnapy --snap
snapcheck	Tome instantáneas de los comandos o RPC especificados en los archivos de prueba y evalúe inmediatamente las instantáneas con respecto a criterios predefinidos en los casos de prueba.	jsnapy --snapcheck

Cuando ejecuta JSNAPy en la línea de comandos, JSNAPy realiza la acción solicitada en los hosts especificados en la sección del archivo de hosts configuración. El módulo de Ansible, por otro lado, ejecuta la acción solicitada en los hosts especificados en el manual de estrategias de Ansible. Como resultado, el módulo puede hacer referencia a un archivo de configuración, ignorando la hosts sección, o puede hacer referencia directamente a uno o varios archivos de prueba.

Por lo tanto, además del action argumento, el juniper.device.jsnapy módulo también requiere que el config_file argumento o el test_files argumento especifiquen el archivo de configuración JSNAPy o los archivos de prueba JSNAPy que se utilizarán para la acción dada. La Tabla 3 describe los config_file argumentos y test_files .

Tabla 3: Argumentos de archivo jsnapy

Argumento de módulo	Valor	Información adicional
config_file	Ruta de archivo absoluta o relativa a un archivo de configuración JSNAPy.	Si la ruta es relativa, el módulo comprueba el archivo de configuración en las siguientes ubicaciones y en el orden indicado: Directorio del manual de estrategias de Ansible dir directorio de argumentos, si se proporciona /etc/jsnapy/testfiles (solo si se omite el dir argumento) Si el archivo de configuración hace referencia a archivos de prueba mediante una ruta de acceso de archivo relativa, el módulo comprueba primero los archivos de prueba en el directorio del cuaderno de estrategias. A continuación, comprueba los archivos de prueba en el directorio predeterminado testfiles , que variará en función de la versión de JSNAPy y de su entorno.
test_files	Ruta de archivo absoluta o relativa a un archivo de prueba JSNAPy. Este valor puede ser una ruta de un solo archivo o una lista de rutas de archivo.	Para cada archivo de prueba que especifica una ruta relativa, el módulo comprueba el archivo en las siguientes ubicaciones y en el orden indicado: Directorio del manual de estrategias de Ansible dir directorio de argumentos, si se proporciona /etc/jsnapy/testfiles (solo si se omite el dir argumento)

Los config_file argumentos and test_files pueden tomar una ruta de archivo absoluta o relativa. Cuando utilice una ruta de acceso de archivo relativa, puede incluir opcionalmente el argumento module dir para especificar el directorio en el que residen los archivos. Si un config_file argumento or test_files utiliza una ruta de archivo relativa, el módulo primero comprueba el archivo en el directorio del manual de estrategias de Ansible, incluso si el dir argumento está presente. Si el archivo no existe en el directorio del libro de jugadas, el módulo se verifica en el directorio de dir argumentos, si se especifica, o en el directorio /etc/jsnapy/testfiles , si se omite el dir argumento. El manual genera un mensaje de error si no se encuentra el archivo.

Es importante tener en cuenta que cuando se incluye el dir parámetro, el módulo comprueba esa ubicación solo para el argumento especificado config_file test_files . Por lo tanto, cuando se especifica un archivo de configuración, el módulo no comprueba el dir directorio de los archivos de prueba que se especifican en el archivo de configuración. Si el archivo de configuración hace referencia a rutas relativas para los archivos de prueba, el módulo comprueba los archivos de prueba solo en el directorio del manual y en el directorio predeterminado testfiles .

Supongamos que tiene el siguiente archivo de configuración JSNAPy, jsnapy_config_base_tests.yaml, que reside en el directorio ~/jsnapy/testfiles y hace referencia a varios archivos de prueba JSNAPy:

En el siguiente manual de estrategia de ejemplo, se realiza la snap_pre acción para cada uno de los archivos de prueba del archivo de configuración jsnapy_config_base_tests.yaml . Si el archivo de configuración no existe en el directorio del libro de jugadas, el módulo busca el archivo en el dir directorio, que en este caso es ~/jsnapy/testfiles. El archivo de configuración utiliza rutas relativas para los archivos de prueba. Como resultado, el módulo primero busca los archivos de prueba en el directorio del libro de estrategias y, a continuación, comprueba los archivos de prueba en el directorio predeterminado testfiles .

Como alternativa, el jsnapy módulo puede utilizar el test_files parámetro para especificar los archivos de prueba individuales que se van a utilizar. El siguiente manual ejecuta las mismas pruebas que en el ejemplo del manual anterior. En este caso, el módulo primero busca los archivos de prueba en el directorio del libro de estrategias y, a continuación, comprueba los archivos de prueba en el dir directorio.

Nota:

A partir de Junos Snapshot Administrator en la versión 1.3.0 de Python, la ubicación predeterminada para la configuración y los archivos de prueba es ~/jsnapy/testfiles. Sin embargo, la ubicación predeterminada dentro de un entorno virtual o para versiones anteriores es /etc/jsnapy/testfiles.

El módulo realiza la acción solicitada en los hosts especificados en el manual de estrategias de Ansible, incluso si el módulo hace referencia a un archivo de configuración que incluye una hosts sección. El módulo informa de que falló si encuentra un error y no puede ejecutar las pruebas de JSNAPy. No informa si falla una o más de las pruebas de JSNAPy. Para verificar los resultados de la prueba JSNAPy, registre la respuesta del módulo y use el ansible.builtin.assert módulo para verificar el resultado esperado en la respuesta.

JSNAPy registra información sobre sus operaciones en el archivo /var/log/jsnapy/jsnapy.log de forma predeterminada. Opcionalmente, juniper.device.jsnapy el módulo puede incluir el logfile argumento. Su valor especifica la ruta a un archivo grabable en el nodo de control de Ansible. El nivel de detalle y las opciones de depuración de Ansible determinan el nivel de información registrado en el archivo. De forma predeterminada, solo se registran los mensajes de nivel de gravedad WARNING o superior. Para registrar mensajes iguales o superiores al nivel de gravedad INFO o al nivel de gravedad DEBUG, ejecute el manual con la -v opción de línea de comandos o -vv , respectivamente.

Cuando ejecuta pruebas de JSNAPy en un libro de jugadas de Ansible, puede guardar o resumir la información de las pruebas de JSNAPy fallidas. Para obtener más información, consulte Revisión de pruebas JSNAPy fallidas.

JSNAPy le permite capturar instantáneas del entorno de ejecución de sus dispositivos Junos antes y después de un cambio y luego comparar las instantáneas para verificar los cambios esperados o identificar problemas inesperados. El juniper.device.jsnapy módulo le permite tomar y comparar instantáneas de JSNAPy como parte de un manual de Ansible. El módulo guarda cada instantánea de cada host en un archivo separado en el directorio de instantáneas predeterminado de JSNAPy utilizando un nombre de archivo predeterminado. Para obtener más información sobre los archivos de salida, consulte Descripción de la salida del módulo jsnapy.

Para tomar instantáneas de línea base de uno o más dispositivos antes de realizar cambios:

• Establezca el argumento del action módulo en snap_pre.

• Especifique un archivo de configuración o uno o varios archivos de prueba.

En el siguiente manual se guardan las instantáneas de PRE para cada dispositivo del grupo de inventario de Ansible. La tarea hace referencia al archivo de configuración jsnapy_config_base_tests.yaml en el directorio ~/jsnapy/testfiles y registra los mensajes en el archivo jsnapy_tests.log en el directorio playbook.

Para tomar una instantánea de uno o más dispositivos después de realizar cambios:

• Establezca el argumento del action módulo en snap_post.

• Especifique un archivo de configuración o uno o varios archivos de prueba.

En el siguiente manual se guardan instantáneas POST para cada dispositivo del grupo de inventario de Ansible. La tarea hace referencia al mismo archivo de configuración jsnapy_config_base_tests.yaml en el directorio ~/jsnapy/testfiles y registra los mensajes en el archivo jsnapy_tests.log en el directorio playbook.

Cuando el juniper.device.jsnapy módulo realiza una snap_pre acción o una snap_post acción, guarda cada instantánea de cada host en un archivo separado utilizando nombres de archivo generados automáticamente que contienen una etiqueta 'PRE' o 'POST', respectivamente. Puede realizar una check acción para comparar las PRE instantáneas y POST para comprobar rápidamente las actualizaciones o identificar cualquier problema que pueda haber resultado de los cambios.

Cuando el módulo realiza una check acción, JSNAPy compara las instantáneas PRE y POST de cada prueba en cada dispositivo y las evalúa en función de los criterios definidos en la tests: sección de los archivos de prueba. Si los archivos de prueba no definen ningún caso de prueba, JSNAPy compara las instantáneas nodo por nodo.

Para comparar instantáneas PRE y POST:

• Establezca el argumento del action módulo en check.

• Especifique el mismo archivo de configuración o archivos de prueba que se usaron para tomar las instantáneas.

• Para comprobar los resultados de la prueba, registre la respuesta del módulo y utilice el ansible.builtin.assert módulo para verificar el resultado esperado en la respuesta.

En el siguiente manual se comparan las instantáneas realizadas para las acciones ejecutadas snap_pre anteriormente y snap_post para cada dispositivo del grupo de inventario de Ansible. Los resultados se evalúan utilizando los criterios de los archivos de prueba a los que se hace referencia en el archivo de configuración. El manual registra la respuesta del módulo como 'test_result' y lo utiliza ansible.builtin.assert para verificar que todas las pruebas se aprobaron en el dispositivo dado.

Cuando ejecuta el manual de estrategias, las aserciones identifican rápidamente qué dispositivos no pasaron las pruebas.

JSNAPy le permite tomar instantáneas de los comandos o RPC especificados en los archivos de prueba de JSNAPy y evaluar inmediatamente las instantáneas con respecto a criterios predefinidos en los casos de prueba. El juniper.device.jsnapy módulo le permite realizar una operación de comprobación instantánea de JSNAPy como parte de un manual de estrategias de Ansible.

Para tomar una instantánea y evaluarla inmediatamente en función del conjunto de criterios predefinidos en la tests: sección de los archivos de prueba:

• Establezca el argumento del action módulo en snapcheck.

• Especifique un archivo de configuración o uno o varios archivos de prueba.

• Para comprobar los resultados de la prueba, registre la respuesta del módulo y utilice el ansible.builtin.assert módulo para verificar el resultado esperado en la respuesta.

Por ejemplo, para cada dispositivo del grupo de inventario de Ansible, el siguiente manual guarda una instantánea independiente para cada comando o RPC en los archivos de prueba. A continuación, registra la respuesta del módulo y lo utiliza ansible.builtin.assert para verificar que todas las pruebas definidas en los archivos de prueba pasaron a ese dispositivo.

Cuando ejecuta pruebas de JSNAPy en dispositivos Junos, puede verificar rápidamente si todas las pruebas de JSNAPy pasaron. Registre la respuesta del juniper.device.jsnapy módulo y use el ansible.builtin.assert módulo para verificar que sea passPercentage 100. Sin embargo, si una o más pruebas fallan, puede ser difícil identificar y extraer las pruebas fallidas si el resultado es extenso.

El juniper.device.jsnapy módulo proporciona las siguientes opciones para ver las pruebas de JSNAPy fallidas:

• juniper.device.jsnapy complemento de devolución de llamada: imprima un resumen de las pruebas JSNAPy fallidas después de la salida del libro de estrategias.

• dest_dir argumento de módulo: escriba las pruebas de JSNAPy fallidas en los archivos del directorio especificado.

El jsnapy complemento de devolución de llamada le permite extraer y resumir fácilmente la información de las pruebas de JSNAPy fallidas. Cuando habilita el complemento de devolución de jsnapy llamada y ejecuta un libro de jugadas que incluye pruebas de JSNAPy, el complemento resume la información de las pruebas de JSNAPy fallidas después del libro PLAY RECAPde jugadas.

El complemento de jsnapy devolución de llamada está deshabilitado de forma predeterminada. Para habilitar el complemento de devolución de jsnapy llamada, agregue la callbacks_enabled = juniper.device.jsnapy instrucción al archivo de configuración de Ansible.

Cuando habilita el complemento de devolución de jsnapy llamada y ejecuta un libro de jugadas, el complemento resume las pruebas de JSNAPy fallidas en un formato legible por humanos. Por ejemplo:

A partir de juniper.device la versión 1.0.6, el juniper.device.jsnapy módulo también admite el dest_dir argumento. Puede incluir el argumento a check favor y snapcheck las dest_dir operaciones que evalúan las instantáneas con respecto a los criterios de prueba. Cuando realiza una check operación o snapcheck e incluye el dest_dir argumento, el módulo escribe cada prueba JSNAPy fallida para un host determinado en un archivo en el directorio de salida especificado.

Por ejemplo, considere el siguiente manual de estrategias:

Cuando ejecuta el libro de estrategias, el módulo genera un archivo en el dest_dir directorio para cada prueba fallida en el host dado. Por ejemplo, el módulo generó los siguientes archivos para pruebas fallidas bgp_neighbor y bgp_summary en hosts r1 y r3.