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 字典	这是一个包含与备份文件路径相关的可配置选项的字典对象。只有当 backup 设置为 yes 时，才会读取此选项的值，如果 backup 设置为 no，则将静默忽略此选项。
dir_path 路径	此选项提供了以目录名称结尾的路径，备份配置文件将存储在该路径中。如果该目录不存在，则将首先创建该目录，并且文件名是 filename 的值，或者如 filename 选项描述中所述的默认文件名。如果未给出路径值，则将在当前工作目录中创建一个 backup 目录，并且备份配置将复制到 backup 目录中的 filename 中。
filename 字符串	用于存储备份配置的文件名。如果未给出文件名，则将基于主机名、当前时间和日期生成文件名，格式由 <主机名>_config.<当前日期>@<当前时间> 定义
before 字符串	如果需要进行更改，则推送到命令堆栈的有序命令集。这使 playbook 设计人员有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式
commit 字符串	此参数指定在将配置更改应用于远程节点时使用的更新方法。如果值设置为 merge，则配置更新将与运行中的配置合并。如果值设置为 check，则不会对远程主机进行任何更改。 选择 "merge" ← (默认) "检查"
配置 字符串	config 参数允许剧本设计者提供用于验证必要配置更改的基本配置。如果提供了此参数，模块将不会从远程节点下载运行配置。
lines 别名: commands 字符串	应在节中配置的有序命令集。这些命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会被设备配置解析器自动修改。
匹配 字符串	指示模块如何将命令集与当前设备配置进行匹配。如果 match 设置为line，则命令将逐行匹配。如果 match 设置为strict，则命令行的匹配将考虑其位置。如果 match 设置为exact，则命令行必须完全匹配。最后，如果 match 设置为none，则模块将不会尝试将源配置与远程设备上的运行配置进行比较。 选择 "line" ← (默认) "strict" "exact" "none"
父级 字符串	唯一标识命令应检查的节的有序父级集。如果省略 parents 参数，则命令将针对顶级或全局命令集进行检查。
替换 字符串	指示模块如何在设备上执行配置。如果 replace 参数设置为line，则修改后的行将被推送到配置模式下的设备。如果 replace 参数设置为block，则如果任何行不正确，则整个命令块将被推送到配置模式下的设备。 选择 "line" ← (默认) "block"
save_when 字符串	当对设备运行配置进行更改时，默认情况下不会将更改复制到非易失性存储器。使用此参数将在之前更改它。如果参数设置为always，则运行配置将始终复制到启动配置，并且modified标志将始终设置为True。如果参数设置为modified，则仅当运行配置自上次保存到启动配置以来发生更改时，才会将运行配置复制到启动配置。如果参数设置为never，则永远不会将运行配置复制到启动配置。 选择 "always" "never" ← (默认) "modified"
源 字符串	指定包含要加载的配置或配置模板的源文件路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是剧本或角色根目录中的相对路径。此参数与lines、parents互斥。
更新 字符串	update参数控制如何在远程设备上处理配置语句。update 参数的有效选项为merge 和check。当参数设置为merge时，配置更改将与当前设备运行配置合并。当参数设置为check时，将确定配置更新，但实际上不会在远程设备上进行配置。 选择 "merge" ← (默认) "检查"

注释

注意

• 有关使用 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 字符串	备份文件的完整路径 返回: 当备份为 yes 时 示例: "/playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34"
更新 列表 / 元素=字符串	将推送到远程设备的命令集 返回: 始终 示例: ["...", "..."]

状态

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

• 有关详细信息，请参阅 已弃用。

作者

• Paul Baker (@paulquack)

集合链接

• 问题跟踪器
• 存储库 (源)