使用 Ansible 配置 Junos 设备

该 juniper.device.config 模块允许您在 Junos 设备上执行以下操作：

• 加载配置数据

• 提交配置

• 回滚配置

• 加载救援配置

要修改配置，模块的参数列表必须包含 load 用于加载新配置数据的参数或 rollback 用于恢复到挽救配置或先前提交的配置的参数。进行配置更改的基本过程是锁定配置，加载配置更改，提交配置以使其处于活动状态，然后解锁配置。

默认情况下， config 模块使用 configure exclusive 模式对候选配置数据库进行更改，该模式会自动锁定和解锁候选全局配置。您还可以指定其他配置模式。例如，您可以对候选配置的专用副本或临时配置数据库进行更改。有关指定配置模式的详细信息，请参阅 如何指定配置模式。

加载新配置数据时，除了指定配置模式外，还可以指定加载操作以及更改的来源和格式。

• 加载操作 - 加载操作确定如何将配置数据加载到所选配置数据库中。该函数支持许多与 Junos OS CLI 中提供的相同加载操作。有关更多信息，请参见 如何指定加载操作。

• 格式 - 您可以使用其中一种受支持的标准格式来配置 Junos 设备。您可以以文本、Junos XML 元素、Junos OS 命令或 JSON 的形式提供配置数据或 Jinja2 set 模板。有关指定配置数据格式的信息，请参阅 如何指定要加载的配置数据的格式。

• 配置数据源 — 您可以分别从linessrctemplateurl字符串列表、本地 Ansible 控制节点上的文件、Jinja2 模板或可从客户端设备访问的 URL 加载配置数据。有关指定配置数据源的详细信息，请参阅以下部分：

  • 如何将配置数据加载为字符串

  • 如何从本地或远程文件加载配置数据

  • 如何使用 Jinja2 模板加载配置数据

该 config 模块还允许您加载并提交救援配置，或将配置回滚到之前提交的配置。若要加载救援配置或以前提交的配置，必须包含 rollback 模块参数。有关详细信息，请参阅以下部分：

• 如何加载救援配置

• 如何回滚配置

修改配置后，您必须提交配置，使其成为设备上的活动配置。默认情况下， config 模块会提交对配置的更改。要更改此行为或提供其他提交选项，请参阅 如何提交配置。

默认情况下，当模块包含用于更改配置的 load or rollback 参数时config，模块会在模块的响应中自动以 diff 或 patch 格式返回配置更改。差异在 和 diff_lines 变量中diff返回。要防止模块计算并返回差值，请将 diff module 参数设置为 false。

您可以指定修改设备配置时要使用的配置模式。要在任务中指定配置模式，请包含 config 模块的 config_mode 参数。支持的配置模式包括：

• batch

• dynamic

• ephemeral

• exclusive

• private

默认情况下， juniper.device.config 模块使用 configure exclusive 模式对候选配置数据库进行更改。只要模块需要对配置进行请求的更改，配置独占模式就会锁定候选全局配置（也称为 共享配置数据库）。锁定数据库可防止其他用户修改或提交对数据库的更改，直到解锁为止。

以下示例说明如何配置候选配置的专用副本以及如何配置临时数据库。

• 示例： config_mode：“private”
• 配置临时数据库

该 juniper.device.config 模块支持使用许多与 Junos OS CLI 中支持的相同加载操作来加载配置更改。通过将参数包含在 load 模块的参数列表中并将其设置为相应加载操作的值来指定加载操作。 表 2 总结了每种类型的加载操作所需的参数设置。

表 2：指定加载操作的参数

负载操作	load 参数	描述
load merge	load: "merge"	将加载的配置与现有配置合并。
load override	load: "override"	将整个配置替换为加载的配置。
load patch	load: "patch"	从修补程序文件加载配置数据。
load replace	load "replace"	将加载的配置与现有配置合并，但将现有配置中的语句替换为在已加载的配置中指定标记的 replace: 语句。如果现有配置中没有语句，则会添加已加载配置中的语句。
load set	load: "set"	加载格式化的 set 配置数据。配置数据将逐行加载，并且可以包含配置模式命令，例如 set、 delete和 deactivate。
load update	load: "update"	将完整加载的配置与现有配置进行比较。在已加载的配置中不同的每个配置元素都会替换现有配置中其对应的元素。在提交操作期间，只有受更改配置元素影响的系统进程才会分析新配置。

借助该 juniper.device.config 模块，您可以使用其中一种标准、受支持的格式来配置 Junos 设备。您可以提供字符串或文件形式的配置数据。文件可以包含配置数据或 Jinja2 模板。在字符串、文件或 Jinja2 模板中提供配置数据时，支持的数据格式包括文本、Junos XML 元素、Junos OS set 命令和 JSON。

该 config 模块尝试自动检测在参数中 lines 作为字符串提供的配置数据的格式。但是，您可以通过包含 format 参数来显式指定字符串的格式。在文件或 Jinja2 模板中提供配置数据时，必须通过向文件添加适当的扩展名或包含 format 参数来指定数据的格式。

表 3 汇总了配置数据支持的格式以及文件扩展名和 format 参数的相应值。如果包含该 format 参数，它将覆盖字符串的自动检测格式和文件扩展名指示的格式。

表 3：指定配置数据的格式

配置数据格式	文件扩展名	format 参数
CLI 配置语句（文本）	.conf 文件	“text”
JavaScript 对象标记 （JSON）	.json	“json”
set Junos OS 命令	。设置	“set”
Junos XML 元素	.xml	“xml”

注意：

将 load 模块的参数设置为 'override' 或 'update'时，不能使用 Junos OS set 命令格式。

您可以通过该 juniper.device.config 模块从字符串列表中加载配置数据。若要将配置数据加载为字符串，请包含相应的 load 参数和 lines 参数。该 lines 参数采用包含要加载的配置数据的字符串列表。

该模块会尝试自动检测配置数据的 lines 格式。但是，您可以通过包含 format 参数来显式指定格式。有关指定格式的信息，请参阅 如何指定要加载的配置数据的格式。如果包含该 format 参数，它将覆盖自动检测的格式。

以下 playbook 配置并提交两个 op 脚本。在这种情况下， load 参数的值 'set'为 ，因为中的 lines 配置数据使用 Junos OS set 语句格式。

以下操作指南使用 lines 文本格式的配置数据来配置相同的语句。在本例中， load: "merge" 是使用。

该 juniper.device.config 模块允许您从文件加载配置数据。该文件可以驻留在以下位置之一：

• Ansible 控制节点

• 客户端设备

• 可从客户端设备访问的 URL

从文件加载配置数据时，必须指明文件的位置和文件中配置数据的格式。支持的配置数据格式包括文本、Junos XML 元素、Junos OS set 命令和 JSON。有关加载包含 Jinja2 模板的文件的信息，请参阅 如何使用 Jinja2 模板加载配置数据。

您可以通过在模块的参数列表中显式包含 format 参数，或者向配置数据文件添加适当的扩展名来指定配置数据的格式。如果指定该 format 参数，它将覆盖文件扩展名指示的格式。有关指定格式的信息，请参阅 如何指定要加载的配置数据的格式。当配置数据使用 Junos XML 格式时，必须将数据括在顶级 <configuration> 标记中。

注意：

直接在 NETCONF 会话中配置设备时，无需根据需要将格式为 ASCII 文本、Junos OS set 命令或 JSON <configuration-text>的配置数据包含在、 <configuration-set>、或 <configuration-json> 标记中。

表 4 概述了可用于指定文件位置的模块参数。

表 4：指定配置文件的位置

模块参数	描述
src	Ansible 控制节点上文件的绝对或相对路径。默认目录是 playbook 目录。
url	客户端设备上文件的绝对或相对路径，或者 FTP 位置或 HTTP URL。 客户端设备上的默认目录是当前工作目录，默认为用户的主目录。

要从 Ansible 控制节点上的本地文件加载配置数据，请将 src 参数设置为包含配置数据的文件的绝对路径或相对路径。例如：

要从 Junos 设备上的文件或者从 FTP 或 HTTP URL 加载配置数据，请使用 url 该参数并指定包含要加载的配置数据的文件的路径。例如：

的 url 值可以是绝对或相对本地文件路径、FTP 位置或 HTTP URL。

• 目标设备上本地文件的文件路径具有以下形式之一：

  • /path/filename—已挂载文件系统（本地闪存盘或硬盘上的文件）上的文件。

  • 一个：filename 或 a：path/filename - 本地驱动器上的文件。默认路径为 /（根目录）。可移动介质可以是 MS-DOS 或 UNIX （UFS） 格式。

• FTP 服务器上文件的文件路径格式如下：

• HTTP 服务器上文件的文件路径格式如下：

在每种情况下，变量的 path 默认值都是用户的主目录。若要指定绝对路径，应用程序将使用字符 %2F 启动该路径;例如， ftp://username：password@hostname/%2Fpath/filename。

通过该 juniper.device.config 模块，您可以通过 Ansible 控制节点上的 Jinja2 模板文件渲染配置数据，并在 Junos 设备上加载并提交配置。Jinja 是 Python 的模板引擎，可让您从预定义的模板生成文档。模板是所需语言的文本文件，通过使用表达式和变量提供灵活性。您可以使用 Jinja2 模板以其中一种受支持的配置格式创建 Junos OS 配置数据，其中包括 ASCII 文本、Junos XML 元素、Junos OS set 命令和 JSON。Ansible 模块使用 Jinja2 模板和提供的变量字典来呈现配置数据。

要使用 Jinja2 模板加载和提交配置数据，请在模块的参数列表中包含 template 和 vars 参数。

• template- Jinja2 模板文件的路径

• vars- 呈现 Jinja2 模板所需的键和值字典

当模板的文件扩展名未指示数据的格式时，还必须包含该 format 参数。有关指定格式的信息，请参阅 如何指定要加载的配置数据的格式。

例如， interfaces-mpls.j2 文件包含以下 Jinja2 模板：

要使用该 juniper.device.config 模块加载 Jinja2 模板，请将 template 参数设置为模板文件的路径，并在字典中 vars 定义模板所需的变量。以下操作指南使用 Jinja2 模板和中 vars 定义的变量来呈现配置数据，并在目标主机上加载并提交这些数据。该 format 参数表示模板文件中配置数据的格式。

该模块将生成以下配置数据，这些数据将加载到设备上的候选配置中并提交：

通过挽救配置，您可以定义已知的工作配置或具有可随时还原的已知状态的配置。当需要恢复到已知配置时，或者在设备配置和备份配置文件损坏而无法修复时作为最后的手段，可以使用救援配置。创建挽救配置时，设备会将最近提交的配置另存为挽救配置。

您可以通过该 juniper.device.config 模块恢复到 Junos 设备上的现有救援配置。若要在设备上加载并提交救援配置，请包含模块的 rollback: "rescue" 参数。例如：

Junos 设备会存储最近提交的配置和最多 49 个以前配置的副本，具体取决于平台。您可以回滚到任何存储的配置。当配置更改导致不希望的结果，并且您希望恢复为已知的工作配置时，这将非常有用。回滚配置类似于在设备上进行配置更改的过程，但执行回滚，而不是加载配置数据，这会将整个候选配置替换为之前提交的配置。

您可以通过该 juniper.device.config 模块回滚到 Junos 设备上先前提交的配置。要回滚配置并提交，请包含模块的 rollback 参数，并指定回滚配置的 ID。有效 ID 值为 0（对于最近提交的配置为零），比之前存储的配置数（最大值为 49）少 1。

以下操作指南会提示输入要还原的配置的回滚 ID，回滚配置并提交，然后将配置更改打印为标准输出：

默认情况下，当您使用juniper.device.config模块通过load或 参数rollback修改配置时，模块会自动执行提交检查并提交更改。若要防止模块执行提交检查或提交更改，请将 或 commit 参数分别设置为 。check false

您还可以使用许多与 Junos OS CLI 中提供的相同选项来自定义提交操作。 表 5 概述了可用于指定不同提交选项的模块参数。

表 5：提交选项

模块参数	描述	和 rollback 操作的load默认值
check: boolean	执行提交检查或确认之前确认的提交操作。	true
check_commit_wait: seconds	在提交检查和提交操作之间等待指定的秒数。	–
comment: "string"	在系统日志文件和设备的提交历史记录中记录该提交操作的注释。	–
commit: boolean	提交配置更改或确认之前确认的提交操作。	true
commit_empty_changes: boolean	即使候选配置与提交的配置之间没有差异，也要提交配置更改。	false
commit_force_sync: boolean	同步并提交所有路由引擎上的配置，即使其他路由引擎上有打开的配置会话或未提交的配置更改也是如此。	false
commit_sync: boolean	同步并提交所有路由引擎上的配置。	false
confirmed: minutes	要求在初始提交后的指定时间内确认提交操作。如果未在指定时间内确认提交，请回滚到之前提交的配置。 commit: true必须使用选项或check: true选项来确认提交。	–
timeout: seconds	使用指定值作为超时，等待操作完成。	30 秒

提交评论

提交配置时，可以添加简短注释，说明已提交更改的用途。若要记录描述更改的注释，请将参数与消息字符串一起包含在 comment: "comment string" 内。

提交检查

默认情况下，该 config 模块同时执行提交检查和提交操作。该 check_commit_wait 参数定义提交检查和提交操作之间等待的秒数。当需要为设备提供足够的时间来完成提交检查操作并在启动提交操作之前释放配置锁定时，请包含此参数。如果省略该 check_commit_wait 参数，在某些情况下，设备可能会在提交检查操作释放其对配置的锁定之前启动提交操作，从而导致 CommitError 提交操作失败。

提交空更改

默认情况下，如果候选配置和提交的配置之间没有差异，则模块不会提交更改。若要在没有差异的情况下强制执行提交操作，请包含 commit_empty_changes: true 该参数。

提交同步

如果设备具有双路由引擎，则可以通过包含 commit_sync: true 参数在两个路由引擎上同步并提交配置。若要强制 commit synchronize 操作成功，即使其他路由引擎上存在打开的配置会话或未提交的配置更改，请使用参数 commit_force_sync: true 。如果包含该 commit_force_sync: true 选项，设备将终止其他路由引擎上的所有配置会话，然后再同步并提交配置。

提交、确认

若要要求在初始提交后的指定时间内确认提交操作，请包含该confirmed: minutes参数。如果在给定时限内未确认提交，配置将自动回滚到之前提交的配置。允许的范围为 1 到 65,535 分钟。确认的提交操作可用于验证配置更改是否正常工作，并且不会阻止对设备的管理访问。如果更改阻止访问或导致其他错误，则自动回滚到之前的配置将在回滚截止时间过后允许访问设备。若要确认提交操作，请使用 check: true or commit: true 参数调用config模块。

在下面的操作指南中，第一个任务修改配置，在提交检查和提交操作之间等待 10 秒，并要求在 5 分钟内确认提交操作。它还记录提交的注释。第二个任务发出 commit check 一个操作以确认提交。在实际场景中，您可能会在初始提交之后执行验证任务，并且仅当任务通过某些验证标准时才执行提交确认。

您可以通过该 juniper.device.config 模块在 Junos 设备上修改和提交配置。在某些情况下，RPC 回复可能包含 <rpc-error> 严重性级别为 warning 或更高的元素，这些元素会导致模块引发 RpcError 异常。 RpcError 异常可能会导致加载或提交操作失败。

在某些情况下，可能有必要或希望抑制RpcError为响应加载和提交操作的警告而引发的异常。您可以通过在模块的参数列表中包含ignore_warning参数来指示config模块抑制RpcError因警告而引发的异常。该ignore_warning参数采用布尔值、字符串或字符串列表。

若要指示模块忽略模块执行的加载和提交操作的所有警告，请包含该 ignore_warning: true 参数。下面的示例忽略加载和提交操作的所有警告。

如果包含 ignore_warning: true 并且所有 <rpc-error> 元素都具有警告的严重性级别，则应用程序将忽略所有警告，并且不会引发 RpcError 异常。但是，任何 <rpc-error> 具有较高严重级别的元素仍将引发异常。

若要指示模块忽略特定警告，请将 ignore_warning 参数设置为字符串或包含要忽略的警告的字符串列表。以下示例忽略两个特定警告：

如果所有<rpc-error>元素的严重性级别均为警告，并且响应中的每个警告都与一个或多个指定字符串匹配，则该模块将RpcError抑制异常。