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

参数

参数

注释

after

字符串

如果需要进行更改，则将附加到命令堆栈末尾的命令的有序集合。与before一样，这允许 playbook 设计者附加一组要在命令集之后执行的命令。

backup

布尔值

此参数将导致模块在进行任何更改之前创建远程设备当前 running-config 的完整备份。如果未给出 backup_options 值，则备份文件将写入 playbook 根目录中的 backup 文件夹。如果目录不存在，则会创建它。

选项

  • false ← (默认)

  • true

backup_options

字典

这是一个包含与备份文件路径相关的可配置选项的 dict 对象。仅当 backup 设置为 yes 时才会读取此选项的值，如果 backup 设置为 no，则此选项将被静默忽略。

dir_path

路径

此选项提供以目录名结尾的路径，其中将存储备份配置文件。如果目录不存在，则首先创建它，文件名是 filename 的值或 filename 选项描述中定义的默认文件名。如果没有给出路径值，则将在当前工作目录中创建 backup 目录，并将备份配置复制到 backup 目录中的 filename。

filename

字符串

用于存储备份配置的文件名。如果未给出文件名，它将根据主机名、当前时间和日期以 <hostname>_config.<current-date>@<current-time> 格式生成。

before

字符串

如果需要进行更改，则推送到命令堆栈的有序命令集。这允许 playbook 设计者有机会在推送任何更改之前执行配置命令，而不会影响如何将命令集与系统匹配。

defaults

布尔值

此参数指定获取远程设备运行配置时是否收集所有默认值。启用后，模块将通过发出命令 show running-config all 来获取当前配置。

选项

  • 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"

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 互斥。

备注

注意

  • 针对 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

返回值

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

键

描述

backup_path

字符串

备份文件的完整路径

返回：当 backup 为 yes 时

示例： "/playbooks/ansible/backup/x870_config.2018-08-08@15:00:21"

commands

列表 / 元素=字符串

将推送到远程设备的命令集

返回：始终

示例： ["create vlan \"foo\"", "configure snmp sysName \"x620-red\""]

updates

列表 / 元素=字符串

将推送到远程设备的命令集

返回：始终

示例： ["switch-attributes hostname foo", "router ospf", "area 0"]

状态

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

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

作者

  • Lance Richardson (@hlrichardson)