dellemc.enterprise_sonic.sonic_config 模块 – 管理运行 Enterprise SONiC 的设备上的配置段

注意

此模块是 dellemc.enterprise_sonic 集合（版本 2.5.1）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.enterprise_sonic。

要在剧本中使用它，请指定：dellemc.enterprise_sonic.sonic_config。

dellemc.enterprise_sonic 1.0.0 中的新功能

概要 

管理戴尔科技公司的 Enterprise SONiC 发行版的配置段。 SONiC 配置使用简单的块缩进文件语法将配置分段为多个段。此模块提供了一种以确定性方式处理 SONiC 配置段的实现。

注意

此模块具有相应的操作插件。

参数 

参数	注释
after list / elements=string	如果需要进行更改，则附加到命令堆栈末尾的有序命令集。与 before 类似，这允许剧本设计人员附加一组命令，以便在命令集之后执行。
backup boolean	此参数使模块在进行任何更改之前，从远程设备创建当前 `running-configuration` 的完整备份。如果未给出 `backup_options` 值，则备份文件将写入剧本根目录中的 `backup` 文件夹。如果该目录不存在，则会创建它。选择 `false` ← (默认) `true`
backup_options dictionary	这是一个字典对象，其中包含与备份文件路径相关的可配置选项。仅当 `backup` 设置为 yes 时，才会读取此选项的值，如果 `backup` 设置为 no，则会忽略此选项。
dir_path path	此选项提供以目录名称结尾的路径，在该路径中存储备份配置文件。如果该目录不存在，则会首先创建该目录，并且文件名是 `filename` 的值，或者是 `filename` 选项描述中描述的默认文件名。如果未提供路径值，则会在当前工作目录中创建 backup 目录，并且备份配置将复制到 backup 目录内的 `filename` 中。
filename string	用于存储备份配置的文件名。如果未提供文件名，则会根据主机名、当前时间和日期生成，格式由 <hostname>_config.<current-date>@<current-time> 定义。
before list / elements=string	如果需要进行更改，则推送到命令堆栈上的有序命令集。这使剧本设计人员有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。
config string	默认情况下，该模块连接到远程设备并检索当前运行配置，以用作与源内容进行比较的基础。有时，不希望任务在剧本中的每个任务都获取当前运行配置。 config 参数允许实施者传入配置，以用作比较的基础配置。
lines aliases: commands list / elements=string	应在段中配置的有序命令集。这些命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会由设备配置解析器自动修改。此参数与 src 互斥。
match string	指示模块如何执行命令集与当前设备配置的匹配。如果 match 设置为 line，则逐行匹配命令。如果 match 设置为 strict，则按位置匹配命令行。如果 match 设置为 exact，则命令行必须完全匹配。如果 match 设置为 none，则模块不会尝试将源配置与远程设备上的运行配置进行比较。选择 `"line"` ← (默认) `"strict"` `"exact"` `"none"`
parents list / elements=string	唯一标识命令应检查的段或层次结构的有序父级集。如果省略 parents 参数，则会针对顶层或全局命令集检查这些命令。
replace string	指示模块如何在设备上执行配置。如果 replace 参数设置为 line，则将修改后的行以配置模式推送到设备。如果 replace 参数设置为 block，则如果任何行不正确，则将整个命令块以配置模式推送到设备。选择 `"line"` ← (默认) `"block"`
save boolean	`save` 参数指示模块在模块运行结束时，将运行配置保存到启动配置。如果指定了检查模式，则会忽略此参数。选择 `false` ← (默认) `true`
src path	指定要加载的配置或配置模板的源文件路径。源文件路径可以是 Ansible 控制主机上的完整路径，也可以是相对于 playbook 或角色根目录的相对路径。此参数与 lines 互斥。
update string	update 参数控制在远程设备上处理配置语句的方式。 update 参数的有效选项为 merge 和 check。当您将此参数设置为 merge 时，配置更改将与当前设备运行配置合并。当您将此参数设置为 check 时，将确定配置更新，但不会在远程设备上进行配置。选择 `"merge"` ← (默认) `"check"`

注意 

注意

已针对戴尔科技公司的 Enterprise SONiC 发行版进行了测试。
支持 check_mode。

示例 

- dellemc.enterprise_sonic.sonic_config:
    lines: ['username {{ user_name }} password {{ user_password }} role {{ user_role }}']

- dellemc.enterprise_sonic.sonic_config:
    lines:
      - description 'SONiC'
    parents: ['interface Eth1/10']

- dellemc.enterprise_sonic.sonic_config:
    lines:
      - seq 2 permit udp any any
      - seq 3 deny icmp any any
    parents: ['ip access-list test']
    before: ['no ip access-list test']

返回值 

通用返回值记录在这里，以下是此模块特有的字段

键	描述
commands list / elements=string	推送到远程设备的命令集。返回: 总是示例: `["username foo password foo role admin", "router bgp 1", "router-id 1.1.1.1"]`
saved boolean	返回配置是否已保存到启动配置。返回: 当不是 check_mode 时。示例: `true`
updates list / elements=string	推送到远程设备的命令集。返回: 总是示例: `["username foo password foo role admin", "router bgp 1", "router-id 1.1.1.1"]`

作者

Abirami N (@abirami-n)