community.network.ironware_config 模块 – 管理 Extreme Ironware 设备上的配置段

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

摘要

• Extreme Ironware 配置使用简单的块缩进文件语法将配置分割成多个部分。此模块提供了一种以确定性方式处理 Ironware 配置部分的实现。

别名：network.ironware.ironware_config

参数

参数	注释
after 字符串	如果需要进行更改，则将附加到命令堆栈末尾的命令的有序集合。与 *before* 一样，这允许 playbook 设计者附加一组要在命令集之后执行的命令。
authorize 布尔值	已弃用 从 Ansible 2.7 开始，我们建议使用 connection: network_cli 和 become: true。 有关更多信息，请参阅 IronWare 平台选项指南。 <hr> 指示模块在发送任何命令之前进入远程设备的特权模式。如果未指定，则设备将尝试以非特权模式执行所有命令。如果任务中未指定该值，则将改用环境变量 ANSIBLE_NET_AUTHORIZE 的值。 选项 false ← (默认) true
backup 布尔值	此参数将导致模块在进行任何更改之前创建当前远程设备 running-config 的完整备份。如果未给出 backup_options 值，则备份文件将写入 playbook 根目录中的 backup 文件夹。如果目录不存在，则会创建它。 选项 false ← (默认) true
backup_options 字典	这是一个包含与备份文件路径相关的可配置选项的 dict 对象。仅当 backup 设置为 *yes* 时，才会读取此选项的值；如果 backup 设置为 *no*，则此选项将被静默忽略。
dir_path 路径	此选项提供以目录名结尾的路径，将在其中存储备份配置文件。如果目录不存在，则首先会创建它，文件名要么是 filename 的值，要么是 filename 选项说明中描述的默认文件名。在这种情况下，如果没有给出路径值，则将在当前工作目录中创建一个 *backup* 目录，并将备份配置复制到 *backup* 目录中的 filename 中。
filename 字符串	用于存储备份配置的文件名。如果未给出文件名，它将基于主机名、当前时间和日期以 _config.@ 格式生成。
before 字符串	如果需要进行更改，则要推送到命令堆栈的有序命令集。这允许 playbook 设计者有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。
commit 字符串	此参数指定在将配置更改应用于远程节点时要使用的更新方法。如果该值设置为merge，则配置更新将与运行配置合并。如果该值设置为check，则不会对远程主机进行任何更改。 选项 "merge" ← (默认) "check"
config 字符串	config 参数允许剧本设计者提供用作验证必要配置更改的基础配置。如果提供此参数，模块将不会从远程节点下载运行配置。
lines 别名：commands 字符串	应在该部分中配置的命令的有序集合。这些命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会由设备配置解析器自动修改。
match 字符串	指示模块如何对命令集与当前设备配置进行匹配。如果将match设置为line，则逐行匹配命令。如果将match设置为strict，则命令行将根据位置进行匹配。如果将match设置为exact，则命令行必须完全匹配。最后，如果将match设置为none，则模块将不会尝试将源配置与远程设备上的运行配置进行比较。 选项 "line" ← (默认) "strict" "exact" "none"
parents 字符串	唯一标识应检查命令的部分的有序父级集合。如果省略parents参数，则将针对顶级或全局命令集检查命令。
replace 字符串	指示模块如何在设备上执行配置。如果replace参数设置为line，则修改后的行将以配置模式推送到设备。如果replace参数设置为block，则如果任何一行不正确，则整个命令块将以配置模式推送到设备。 选项 "line" ← (默认) "block"
save_when 字符串	对设备运行配置进行更改时，默认情况下不会将更改复制到非易失性存储器。使用此参数将在此之前更改。如果参数设置为always，则运行配置将始终复制到启动配置，并且modified标志将始终设置为True。如果参数设置为modified，则只有在自上次保存到启动配置以来运行配置已更改时，运行配置才会复制到启动配置。如果参数设置为never，则运行配置将永远不会复制到启动配置。 选项 "always" "never" ← (默认) "modified"
src 字符串	指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是Ansible控制主机上的完整路径，也可以是相对于剧本或角色根目录的相对路径。此参数与lines、parents互斥。
update 字符串	update参数控制如何在远程设备上处理配置语句。update参数的有效选择是merge和check。当参数设置为merge时，配置更改将与当前设备运行配置合并。当参数设置为check时，将确定配置更新，但不会实际在远程设备上配置。 选项 "merge" ← (默认) "check"

备注

注意

• 有关使用Ansible管理网络设备的更多信息，请参见：ref:`Ansible网络指南 <network_guide>`

示例

- name: Run commands that should be configured in the section
  community.network.ironware_config:
    lines:
      - port-name test
      - enable
      - load-interval 30
      - rate-limit input broadcast unknown-unicast multicast 521216 64000
    parents: ['interface ethernet 1/2']

返回值

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

键	描述
backup_path 字符串	备份文件的完整路径 返回：当backup为yes时 示例： "/playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34"
updates 列表 / 元素=字符串	将推送到远程设备的命令集 返回：始终 示例： ["...", "..."]

状态

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

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

作者

• Paul Baker (@paulquack)

资源链接

• 问题追踪器
• 代码库（源代码）