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

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

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

别名：network.voss.voss_config

参数

参数	注释
after 字符串	如果需要进行更改，则将附加到命令栈末尾的命令的有序集合。与 *before* 一样，这允许 playbook 设计者追加一组要在命令集之后执行的命令。
backup 布尔值	此参数将导致模块在进行任何更改之前创建远程设备当前 running-config 的完整备份。如果未给出 backup_options 值，则备份文件将写入 playbook 根目录或角色根目录（如果 playbook 是 ansible 角色的一部分）中的 backup 文件夹。如果目录不存在，则会创建它。 选项 false ← (默认) true
backup_options 字典	这是一个包含与备份文件路径相关的可配置选项的字典对象。只有当 backup 设置为 *yes* 时，才会读取此选项的值，如果 backup 设置为 *no*，则此选项将被静默忽略。
dir_path 路径	此选项提供以目录名结尾的路径，其中将存储备份配置文件。如果目录不存在，则首先创建它，文件名要么是 filename 的值，要么是 filename 选项说明中描述的默认文件名。如果没有给出路径值，则会在当前工作目录中创建一个 *backup* 目录，并将备份配置复制到 *backup* 目录中的 filename。
filename 字符串	用于存储备份配置的文件名。如果没有给出文件名，它将基于主机名、当前时间和日期以 <hostname>_config.<current-date>@<current-time> 格式生成。
before 字符串	如果需要进行更改，则要推送到命令栈的有序命令集。这允许 playbook 设计者有机会在推送任何更改之前执行配置命令，而不会影响如何将命令集与系统匹配。
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 字符串	默认情况下，模块将连接到远程设备并检索当前的运行配置，将其用作与源内容进行比较的基础。有时，不需要任务为 playbook 中的每个任务获取当前的运行配置。running_config参数允许实现者传入用作比较基础配置的配置。
save_when 字符串	对设备运行配置进行更改时，默认情况下不会将更改复制到非易失性存储器。使用此参数将更改该行为。如果将参数设置为always，则始终保存运行配置，并且modified标志将始终设置为True。如果将参数设置为modified，则只有在自上次保存到启动配置以来运行配置已更改时，才会保存运行配置。如果将参数设置为never，则永远不会保存运行配置。如果将参数设置为changed，则只有在任务进行了更改时才会保存运行配置。 选项 "always" "never" ← (默认) "modified" "changed"
src 字符串	指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是从 playbook 或角色根目录的相对路径。此参数与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 字符串	备份文件的完整路径 返回：当备份为yes时 示例： "/playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21"
commands 列表 / 元素=字符串	将推送到远程设备的命令集 返回：始终 示例： ["interface GigabitEthernet 1/1", "name \"ServerA\"", "exit"]
updates 列表 / 元素=字符串	将推送到远程设备的命令集 返回：始终 示例： ["prompt \"VSP200\""]

状态

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

• 更多信息请参见已弃用。

作者

• Lindsay Hill (@LindsayHill)

收藏链接

• 问题追踪器
• 代码库 (源代码)