community.network.voss_config 模块 – 管理 Extreme VOSS 配置节

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

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

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

要在剧本中使用它，请指定：community.network.voss_config。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。有关更多信息，请参阅讨论帖。

已弃用

在以下版本中删除:

版本 6.0.0

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

• Extreme VOSS 配置使用简单的纯文本文件语法。此模块提供了以确定方式处理 EXOS 配置行的实现。

别名：network.voss.voss_config

参数

参数	注释
after 字符串	如果需要进行更改，则要追加到命令堆栈末尾的有序命令集。就像before一样，这允许剧本设计者追加一组在命令集之后执行的命令。
backup 布尔值	此参数将使模块在进行任何更改之前，从远程设备创建当前 running-config 的完整备份。如果未给出 backup_options 值，则备份文件将写入剧本根目录或角色根目录（如果剧本是 ansible 角色的一部分）中的 backup 文件夹。如果该目录不存在，则会创建该目录。 选择 false ←（默认） true
backup_options 字典	这是一个包含与备份文件路径相关的可配置选项的字典对象。仅当 backup 设置为 yes 时才读取此选项的值，如果 backup 设置为 no，则此选项将被静默忽略。
dir_path 路径	此选项提供以目录名称结尾的路径，其中将存储备份配置文件。如果该目录不存在，则会先创建它，并且文件名是 filename 的值，或 filename 选项描述中描述的默认文件名。如果未给出路径值，则将在当前工作目录中创建一个 backup 目录，并且备份配置将复制到 backup 目录中的 filename 中。
filename 字符串	用于存储备份配置的文件名。如果未给出文件名，则将根据主机名、当前时间和日期以 <主机名>_config.<当前日期>@<当前时间> 定义的格式生成。
before 字符串	如果要进行更改，则推送到命令堆栈的有序命令集。这使剧本设计者有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。
defaults 布尔值	此参数指定在获取远程设备运行配置时是否收集所有默认值。启用后，模块将通过发出命令 show running-config verbose 来获取当前配置。 选择 false ←（默认） true
diff_against 字符串	使用 ansible-playbook --diff 命令行参数时，该模块可以生成针对不同来源的差异。 当此选项配置为 startup 时，模块将返回运行配置与启动配置的差异。 当此选项配置为 intended 时，模块将返回运行配置与 intended_config 参数中提供的配置的差异。 当此选项配置为 running 时，模块将返回运行配置在对设备配置进行任何更改之前和之后的差异。 选择 "running" "startup" "intended"
diff_ignore_lines 字符串	使用此参数指定一个或多个在差异期间应忽略的行。这用于系统中自动更新的配置中的行。此参数采用正则表达式列表或精确行匹配。
intended_config 字符串	intended_config 提供节点应符合的主配置，并用于检查最终运行配置是否符合要求。此参数不会修改远程设备上的任何设置，并且严格用于检查当前设备的配置是否符合要求。指定此参数时，任务还应修改 diff_against 值并将其设置为 intended。
lines 别名：commands 字符串	应在节中配置的有序命令集。这些命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会由设备配置解析器自动修改。
match 字符串	指示模块如何执行命令集与当前设备配置的匹配。如果 match 设置为 line，则命令按行匹配。如果 match 设置为 strict，则命令行的匹配与位置有关。如果 match 设置为 exact，则命令行必须完全匹配。最后，如果 match 设置为 none，则模块不会尝试将源配置与远程设备上的运行配置进行比较。 选择 "line" ← (默认) "strict" "exact" "none"
parents 字符串	父级行，唯一标识应该检查命令所属的部分。如果省略此参数，则将针对顶层或全局命令集检查命令。请注意，VOSS 配置仅支持一层嵌套命令。
replace 字符串	指示模块在设备上执行配置的方式。如果 replace 参数设置为 line，则修改后的行将以配置模式推送到设备。如果 replace 参数设置为 block，则如果任何行不正确，则整个命令块将以配置模式推送到设备。 选择 "line" ← (默认) "block"
running_config 别名: config 字符串	默认情况下，该模块将连接到远程设备并检索当前的 running-config，用作与源内容进行比较的基础。有时，不希望任务在剧本中的每个任务都获取当前的 running-config。running_config 参数允许实现者传入配置以用作比较的基础配置。
save_when 字符串	当对设备运行配置进行更改时，默认情况下不会将更改复制到非易失性存储中。使用此参数将更改此行为。如果参数设置为 always，则始终保存运行配置，并且 modified 标志将始终设置为 True。如果参数设置为 modified，则仅当自上次保存到启动配置以来运行配置已更改时才会保存运行配置。如果参数设置为 never，则永远不会保存运行配置。如果参数设置为 changed，则仅当任务进行了更改时才会保存运行配置。 选择 "always" "never" ← (默认) "modified" "changed"
src 字符串	指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是剧本或角色根目录中的相对路径。此参数与 lines、parents 互斥。

注释

注意

• 已针对 VOSS 7.0.0 进行测试

• 缩写的命令不是幂等的，请参阅 网络常见问题解答。

示例

- name: Configure system name
  community.network.voss_config:
    lines: prompt "{{ inventory_hostname }}"

- name: Configure interface settings
  community.network.voss_config:
    lines:
      - name "ServerA"
    backup: true
    parents: interface GigabitEthernet 1/1

- name: Check the running-config against master config
  community.network.voss_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: Check the startup-config against the running-config
  community.network.voss_config:
    diff_against: startup
    diff_ignore_lines:
      - qos queue-profile .*

- name: Save running to startup when modified
  community.network.voss_config:
    save_when: modified

- name: Configurable backup path
  community.network.voss_config:
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

返回值

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

键	描述
backup_path 字符串	备份文件的完整路径 返回: 当 backup 为 yes 时 示例: "/playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21"
commands list / elements=string	将推送到远程设备的命令集 返回: 始终 示例: ["interface GigabitEthernet 1/1", "name \"ServerA\"", "exit"]
updates list / elements=string	将推送到远程设备的命令集 返回: 始终 示例: ["prompt \"VSP200\""]

状态

• 此模块将在 6.0.0 版本中删除。 [已弃用]

• 有关更多信息，请参阅 已弃用。

作者

• Lindsay Hill (@LindsayHill)

集合链接

• 问题跟踪器
• 存储库（来源）