community.network.exos_config 模块 – 管理 Extreme Networks EXOS 配置段
注意
此模块是 community.network 集合 (版本 5.1.0) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install community.network。
要在 playbook 中使用它，请指定： community.network.exos_config。
注意
community.network 集合已弃用，并将从 Ansible 12 中删除。有关更多信息，请参阅 讨论主题。
已弃用
- 在以下版本中移除：
6.0.0 版本
- 原因：
此集合及其中的所有内容均未维护且已弃用。
- 替代方案：
未知。
概要
Extreme EXOS 配置使用简单的纯文本文件语法。此模块提供了一种以确定性方式处理 EXOS 配置行的实现。
别名：network.exos.exos_config
参数
参数 |
注释 |
|---|---|
如果需要进行更改，则将附加到命令栈末尾的命令的有序集合。就像 *before* 一样，这允许 playbook 设计者附加一组命令，以便在命令集之后执行。 |
|
此参数将导致模块在进行任何更改之前创建远程设备当前 选项
|
|
这是一个包含与备份文件路径相关的可配置选项的 dict 对象。仅当 |
|
此选项提供以目录名结尾的路径，其中将存储备份配置文件。如果目录不存在，则首先创建它，文件名要么是 |
|
用于存储备份配置的文件名。如果未给出文件名，则它将基于主机名、当前时间和日期以 <hostname>_config.<current-date>@<current-time> 格式生成。 |
|
如果需要进行更改，则要推送到命令栈的有序命令集。这允许 playbook 设计者有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。 |
|
此参数指定获取远程设备运行配置时是否收集所有默认值。启用后，模块将通过发出命令 选项
|
|
使用 当此选项配置为 *startup* 时，模块将返回运行配置与启动配置的差异。 当此选项配置为 *intended* 时，模块将返回运行配置与 当此选项配置为 *running* 时，模块将返回运行配置相对于对设备配置所做的任何更改的之前和之后的差异。 选项
|
|
使用此参数指定在差异期间应忽略的一行或多行。这用于系统自动更新的配置中的行。此参数采用正则表达式或精确行匹配列表。 |
|
|
|
应在该部分中配置的有序命令集。命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会由设备配置解析器自动修改。 |
|
指示模块如何对命令集与当前设备配置进行匹配。如果 match 设置为 *line*，则逐行匹配命令。如果 match 设置为 *strict*，则命令行将根据位置匹配。如果 match 设置为 *exact*，则命令行必须是相等的匹配。最后，如果 match 设置为 *none*，则模块将不会尝试将源配置与远程设备上的运行配置进行比较。 选项
|
|
指示模块如何在设备上执行配置。如果将replace参数设置为line，则修改后的行将以配置模式推送到设备。如果将replace参数设置为block，则如果任何一行不正确，则整个命令块将以配置模式推送到设备。 选项
|
|
默认情况下，模块将连接到远程设备并检索当前运行配置，将其用作与源内容进行比较的基准。有时，并不希望任务为 playbook 中的每个任务获取当前运行配置。running_config参数允许实现者传入用作比较基准配置的配置。 |
|
对设备运行配置进行更改时，默认情况下不会将更改复制到非易失性存储器。使用此参数将更改此行为。如果参数设置为always，则运行配置将始终复制到启动配置，并且modified标志将始终设置为True。如果参数设置为modified，则只有在自上次保存到启动配置以来运行配置已更改时，才会将其复制到启动配置。如果参数设置为never，则运行配置将永远不会复制到启动配置。如果参数设置为changed，则只有在任务进行了更改时，才会将运行配置复制到启动配置。 选项
|
|
指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是 playbook 或角色根目录的相对路径。此参数与lines互斥。 |
注释
注意
针对 EXOS 版本 22.6.0b19 进行了测试
示例
- name: Configure SNMP system name
community.network.exos_config:
lines: configure snmp sysName "{{ inventory_hostname }}"
- name: Configure interface settings
community.network.exos_config:
lines:
- configure ports 2 description-string "Master Uplink"
backup: true
- name: Check the running-config against master config
community.network.exos_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: Check the startup-config against the running-config
community.network.exos_config:
diff_against: startup
diff_ignore_lines:
- ntp clock .*
- name: Save running to startup when modified
community.network.exos_config:
save_when: modified
- name: Configurable backup path
community.network.exos_config:
lines:
- configure ports 2 description-string "Master Uplink"
backup: true
backup_options:
filename: backup.cfg
dir_path: /home/user
返回值
常用返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
备份文件的完整路径 返回：当备份为yes时 示例： |
|
将推送到远程设备的命令集 返回：始终 示例： |
|
将推送到远程设备的命令集 返回：始终 示例： |
状态
此模块将在 6.0.0 版中移除。[已弃用]
更多信息请参见已弃用。