在 Ansible作指南中使用 Python 中的 Junos 快照管理员 （JSNAPy）

该 juniper.device.jsnapy 模块使您能够从 Ansible作指南中执行 JSNAPy 功能，包括：

• 捕获并保存运行时环境快照

• 比较两个快照

• 捕获快照并立即对其进行评估

该模块需要指定 action 参数和 或 config_file 参数 test_files 。该 action 参数指定要执行的 JSNAPy作。 表 2 概述了有效 action 值和等效的 JSNAPy 命令。

表 2：jsnapy作参数值

action 值	描述	等效的 JSNAPy 命令
check	根据给定的测试用例比较两个现有快照，或者如果未提供测试用例，则逐个节点比较快照。	jsnapy --check
snap_post	在给定设备上进行更改后，为测试文件中指定的命令或 RPC 拍摄快照。	jsnapy --snap
snap_pre	在对给定设备进行更改之前，请为测试文件中指定的命令或 RPC 拍摄快照。	jsnapy --snap
snapcheck	拍摄测试文件中指定的命令或 RPC 的快照，并立即根据测试用例中的预定义标准评估快照。	jsnapy --snapcheck

在命令行上执行 JSNAPy 时，JSNAPy 将对配置文件 hosts 部分中指定的主机执行请求的作。相反，Ansible 模块会在 Ansible作指南中指定的主机上执行请求的作。因此，该模块可以引用配置文件（忽略该 hosts 部分），也可以直接引用一个或多个测试文件。

因此，除了 action 参数之外，模块 juniper.device.jsnapy 还需要 config_file 参数或 test_files 参数来指定用于给定作的 JSNAPy 配置文件或 JSNAPy 测试文件。 表 3 概述了 config_file 和 test_files 参数。

表 3：jsnapy 文件参数

模块参数	价值	其他信息
config_file	JSNAPy 配置文件的绝对或相对文件路径。	如果路径是相对路径，则模块将按指示的顺序在以下位置检查配置文件： Ansible playbook 目录 dir 参数目录（如果提供） /etc/jsnapy/testfiles 目录（仅当省略参数时 dir ） 如果配置文件使用相对文件路径引用测试文件，则模块将首先检查 playbook 目录中的测试文件，然后检查缺省 testfiles 目录中的测试文件，这将因 JSNAPy 版本和您的环境而异。
test_files	JSNAPy 测试文件的绝对或相对文件路径。这可以是单个文件路径，也可以是文件路径列表。	对于每个指定相对路径的测试文件，模块将在以下位置按指示的顺序检查该文件： Ansible playbook 目录 dir 参数目录（如果提供） /etc/jsnapy/testfiles 目录（仅当省略参数时 dir ）

config_file和 test_files 参数可以采用绝对或相对文件路径。使用相对文件路径时，可以选择包含 dir module 参数以指定文件所在的目录。config_file如果 或 test_files 参数使用相对文件路径，则模块会首先检查 Ansible playbook 目录中的文件，即使该dir参数存在也是如此。如果该文件在 playbook 目录中不存在，则模块在dir参数目录中检查（如果指定了该文件），或者在 dir /etc/jsnapy/testfiles 目录中检查（如果省略了参数）。如果找不到文件，playbook 将生成错误消息。

请务必注意，当您包含参数 dir 时，模块仅检查该位置的指定 config_file 或 test_files 参数。因此，当您指定配置文件时，该模块不会检查您在配置文件中指定的测试文件的 dir 目录。如果配置文件引用测试文件的相对路径，则模块仅在 playbook 目录和默认 testfiles 目录中检查测试文件。

假设您有以下 JSNAPy 配置文件 jsnapy_config_base_tests.yaml，它位于 ~/jsnapy/testfiles 目录中，并引用了多个 JSNAPy 测试文件：

以下示例 playbook 对 jsnapy_config_base_tests.yaml 配置文件中的每个测试文件执行snap_pre作。如果配置文件在 playbook 目录中不存在，则模块会检查该目录中的dir文件，在本例中为 ~/jsnapy/testfiles。配置文件使用测试文件的相对路径。因此，该模块首先检查 playbook 目录中的测试文件，然后检查默认 testfiles 目录中的测试文件。

或者，模块 jsnapy 可以使用参数 test_files 来指定要使用的单个测试文件。以下 playbook 执行的测试与上一个 playbook 示例中的测试相同。在这种情况下，模块首先检查 playbook 目录中的测试文件，然后检查目录中的 dir 测试文件。

注意：

从 Python 1.3.0 版的 Junos Snapshot Administrator 开始，配置和测试文件的默认位置为 ~/jsnapy/testfiles。但是，虚拟环境中或早期版本中的默认位置是 /etc/jsnapy/testfiles。

该模块会在 Ansible作指南中指定的主机上执行请求的作，即使该模块引用的配置文件包含某个 hosts 区段。如果模块遇到错误并且无法执行 JSNAPy 测试，则报告失败。如果一个或多个 JSNAPy 测试失败， 它不会报告失败 。要检查 JSNAPy 测试结果，请注册模块的响应，并使用该 ansible.builtin.assert 模块验证响应中的预期结果。

默认情况下，Python 中的 Junos 快照管理员会将有关其作的信息记录到 /var/log/jsnapy/jsnapy.log 文件中。该 juniper.device.jsnapy 模块可以选择包含参数 logfile ，该参数指定 Ansible 控制节点上可写文件的路径，用于记录特定任务的信息。Ansible 的详细级别和调试选项决定了文件中记录的信息级别。默认情况下，仅记录严重性级别为 WARNING 或更高级别的消息。要记录等于或高于严重性级别 INFO 或严重性级别 DEBUG 的消息，请分别使用 -v 或 -vv 命令行选项执行 playbook。

在 Ansible作指南中执行 JSNAPy 测试时，可以保存或汇总失败的 JSNAPy 测试的信息。有关更多信息，请参阅 查看失败的 JSNAPy 测试。

JSNAPy 允许您在更改前后捕获 Junos 设备的运行时环境快照，然后比较这些快照以验证预期的更改或识别意外问题。该 juniper.device.jsnapy 模块使您能够拍摄和比较 JSNAPy 快照，作为 Ansible作指南的一部分。该模块使用预先确定的文件名将每个主机的每个快照保存在缺省 JSNAPy 快照目录中的单独文件中。有关输出文件的更多信息，请参阅 了解 jsnapy 模块输出。

若要在进行更改之前拍摄一个或多个设备的基线快照，请将模块的 action 参数设置为 snap_pre，并指定一个配置文件或一个或多个测试文件。

以下作指南保存 Ansible 清单组中每台设备的 PRE 快照。该任务引用 ~/jsnapy/testfiles 目录中的 jsnapy_config_base_tests.yaml 配置文件，并将消息记录到 playbook 目录中的 jsnapy_tests.log 文件。

要在执行更改后拍摄一个或多个设备的快照，请将模块的 action 参数设置为 snap_post，并指定一个配置文件或一个或多个测试文件。

以下作指南保存 Ansible 清单组中每台设备的开机自检快照。该任务引用 ~/jsnapy/testfiles 目录中的相同 jsnapy_config_base_tests.yaml 配置文件，并将消息记录到 playbook 目录中的 jsnapy_tests.log 文件。

jsnapy当模块执行snap_pre作或作snap_post时，它会使用自动生成的文件名将每个主机的每个快照保存在单独的文件中，这些文件名分别包含“PRE”或“POST”标记。要比较PRE和POST快照以快速验证更新或识别更改可能导致的任何问题，请将action模块的参数设置为 check，并指定用于拍摄快照的相同配置文件或测试文件。

当模块执行 check 作时，JSNAPy 会比较每个设备上每个测试的 PRE 和 POST 快照，并根据测试文件部分中 tests: 定义的标准对其进行评估。如果测试文件未定义任何测试用例，则 JSNAPy 将逐个节点比较快照。要检查测试结果，请注册模块的响应，并使用该 ansible.builtin.assert 模块验证响应中的预期结果。

以下指南比较了为之前执行 snap_pre 的快照和 snap_post 在 Ansible 清单组中的每台设备上执行的作。使用配置文件中引用的测试文件中的标准对结果进行评估。playbook 将模块的响应注册为“test_result”，并使用该 ansible.builtin.assert 模块验证是否在给定设备上通过了所有测试。

运行作指南时，断言会快速确定哪些设备未通过测试。

JSNAPy 使您能够为 JSNAPy 测试文件中指定的命令或 RPC 拍摄快照，并立即根据测试用例中的预定义标准评估快照。该 juniper.device.jsnapy 模块使您能够执行 JSNAPy 快照检查作，作为 Ansible作手册的一部分。

要拍摄快照并立即根据测试文件部分中预定义的一组条件 tests: 对其进行评估，请将 action 模块的参数设置为 snapcheck，并指定一个配置文件或一个或多个测试文件。要检查测试结果，请注册模块的响应，并使用该 ansible.builtin.assert 模块验证响应中的预期结果。

例如，对于 Ansible 清单组中的每个设备，以下作指南会为测试文件中的每个命令或 RPC 保存单独的快照，注册模块的响应，并使用该 ansible.builtin.assert 模块验证测试文件中定义的所有测试是否在该设备上传递。

对 Junos 设备执行 JSNAPy 测试时，可以通过注册 jsnapy 模块的响应并使用 ansible.builtin.assert 模块检查是否 passPercentage 为 100 来快速验证所有 JSNAPy 测试是否都通过。但是，如果一个或多个测试失败，则如果输出范围很广，则可能很难识别和提取失败的测试。

该 juniper.device.jsnapy 模块提供了以下选项来查看失败的 JSNAPy 测试：

• jsnapy callback plugin — 在 playbook 输出后打印失败的 JSNAPy 测试的摘要。

• dest_dir module argument — 将失败的 JSNAPy 测试写入指定目录中的文件。

回 jsnapy 调插件使您能够轻松提取和汇总失败的 JSNAPy 测试的信息。当您启用 jsnapy 回调插件并执行包含 JSNAPy 测试的 playbook 时，该插件会在 playbook PLAY RECAP之后汇总失败的 JSNAPy 测试的信息。

默认情况下， jsnapy 回调插件处于禁用状态。要启用回调插件， jsnapy 请将 callback_whitelist = jsnapy 语句添加到 Ansible 配置文件中。

当您启用 jsnapy 回调插件并运行 playbook 时，该插件会以人类可读的格式总结失败的 JSNAPy 测试。例如：

从 juniper.device 1.0.6 版开始，该 juniper.device.jsnapy 模块还支持该 dest_dir 参数。您可以包括 dest_dir for check 的参数和 snapcheck 根据测试条件评估快照的作。当您执行 check 或 snapcheck 作并包含 dest_dir 参数时，该模块会将给定主机的每个失败的 JSNAPy 测试写入指定输出目录中的文件。

例如，请考虑以下作手册：

执行 playbook 时，该模块会在给定主机上的每个失败测试的目录中 dest_dir 生成一个文件。例如，为主机 r1 和 r3 上的失败 bgp_neighbor 和 bgp_summary 测试生成以下文件。