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

该 juniper.device.jsnapy 模块允许您从 Ansible 操作指南中执行 JSNAPy 函数，包括：

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

• 比较两个快照

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

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

表 2：jsnapy action 参数值

action value	描述	等效 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 and test_files 参数。

表 3：jsnapy 文件参数

模块参数	value	其他信息
config_file	JSNAPy 配置文件的绝对或相对文件路径。	如果路径是相对路径，则模块将按指示的顺序检查以下位置的配置文件： Ansible 操作指南目录 dir 参数目录（如果提供） /etc/jsnapy/testfiles 目录（仅当省略参数 dir 时） 如果配置文件使用相对文件路径引用测试文件，则模块首先检查 playbook 目录中的测试文件。然后，它会检查默认 testfiles 目录中的测试文件，该文件将根据 JSNAPy 版本和您的环境而有所不同。
test_files	JSNAPy 测试文件的绝对或相对文件路径。此值可以是单个文件路径或文件路径列表。	对于指定相对路径的每个测试文件，模块将按指示的顺序检查以下位置中的文件： Ansible 操作指南目录 dir 参数目录（如果提供） /etc/jsnapy/testfiles 目录（仅当省略参数 dir 时）

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

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

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

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

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

注意：

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

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

默认情况下，JSNAPy 将有关其操作的信息记录到 /var/log/jsnapy/jsnapy.log 文件中。该juniper.device.jsnapy模块可以选择包含logfile参数。其值指定 Ansible 控制节点上可写文件的路径。Ansible 的详细程度和调试选项决定了文件中记录的信息级别。默认情况下，仅记录严重性级别为 WARNING 或更高的消息。要记录等于或高于严重性级别 INFO 或严重性级别 DEBUG 的消息，请分别使用 or -vv 命令行选项执行 -v 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 清单组中每台设备保存 POST 快照。该任务引用 ~/jsnapy/testfiles 目录中的相同 jsnapy_config_base_tests.yaml 配置文件，并将消息记录到 playbook 目录中的 jsnapy_tests.log 文件。

当模块juniper.device.jsnapy执行操作snap_pre或操作snap_post时，它会使用分别包含“PRE”或“POST”标签的自动生成的文件名将每个主机的每个快照保存在单独的文件中。您可以执行操作check来比较 和PREPOST快照，以快速验证更新或确定更改可能导致的任何问题。

当模块执行操作 check 时，JSNAPy 会比较每个设备上每个测试的 PRE 和 POST 快照，并根据测试文件部分中 tests: 定义的标准对其进行评估。如果测试文件未定义任何测试用例，则 JSNAPy 会逐个节点比较快照。

要比较 PRE 和 POST 快照，请执行以下操作：

• 将模块的 action 参数 check设置为 。

• 指定用于拍摄快照的相同配置文件或测试文件。

• 通过注册模块的响应并使用模块验证 ansible.builtin.assert 响应中的预期结果来检查测试结果。

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

运行操作指南时，断言会快速识别出哪些设备未通过测试。

JSNAPy 使您能够为 JSNAPy 测试文件中指定的命令或 RPC 拍摄快照，并立即根据测试用例中预定义的标准评估快照。该 juniper.device.jsnapy 模块允许您在 Ansible 操作指南中执行 JSNAPy snapcheck 操作。

要拍摄快照并立即根据测试文件部分中的 tests: 预定义标准集进行评估：

• 将模块的 action 参数 snapcheck设置为 。

• 指定一个配置文件或一个或多个测试文件。

• 通过注册模块的响应并使用模块验证 ansible.builtin.assert 响应中的预期结果来检查测试结果。

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

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

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

• juniper.device.jsnapy 回调插件 — 在剧本输出后打印失败的 JSNAPy 测试摘要。

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

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

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

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

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

例如，请考虑以下剧本：

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