community.network.aireos_config 模块 – 管理 Cisco WLC 配置

注意

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

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

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

要在剧本中使用它，请指定：community.network.aireos_config。

注意

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

已弃用

已在以下版本中删除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

• AireOS 不使用块缩进文件语法，因此没有节或父级。此模块提供了一种以确定性方式使用 AireOS 配置的实现。

别名：network.aireos.aireos_config

参数

参数	注释
after 字符串	如果需要进行更改，则追加到命令堆栈末尾的有序命令集。就像使用 before 一样，这允许剧本设计者在命令集之后追加一组要执行的命令。
backup 布尔值	此参数将使模块在进行任何更改之前，从远程设备创建当前 running-config 的完整备份。如果未提供 backup_options 值，则备份文件将写入剧本根目录中的 backup 文件夹。如果该目录不存在，则会创建它。 选项 false ←（默认） true
backup_options 字典	这是一个包含与备份文件路径相关的可配置选项的字典对象。仅当 backup 设置为 *yes* 时才读取此选项的值，如果 backup 设置为 *no*，则此选项将被静默忽略。
dir_path 路径	此选项提供路径，该路径以目录名称结尾，备份配置文件将存储在该目录中。如果该目录不存在，则会先创建该目录，并且文件名要么是 filename 的值，要么是 filename 选项描述中描述的默认文件名。如果未提供路径值，则将在当前工作目录中创建 backup 目录，并且备份配置将被复制到 backup 目录中的 filename 中。
filename 字符串	用于存储备份配置的文件名。如果未提供文件名，则将根据主机名、当前时间和日期生成文件名，格式为 <hostname>_config.<current-date>@<current-time>
before 字符串	如果需要进行更改，则要推送到命令堆栈的有序命令集。这允许剧本设计者有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。
diff_against 字符串	当使用 ansible-playbook --diff 命令行参数时，该模块可以针对不同的源生成差异。 当此选项配置为 intended 时，该模块将返回运行配置与 intended_config 参数中提供的配置的差异。 当此选项配置为 running 时，该模块将返回运行配置的更改前后的差异，以及对设备配置所做的任何更改。 选项 "intended" "running"
diff_ignore_lines 字符串	使用此参数指定在差异期间应忽略的一个或多个行。这用于配置中由系统自动更新的行。此参数采用正则表达式列表或确切的行匹配项。
intended_config 字符串	intended_config 提供节点应符合的主配置，用于检查最终运行配置。此参数不会修改远程设备上的任何设置，并且严格用于检查当前设备的配置是否符合要求。在指定此参数时，该任务还应修改 diff_against 值并将其设置为 intended。
lines 别名：commands 字符串	应配置的有序命令集。命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会自动被设备配置解析器修改。
match 字符串	指示模块如何执行命令集与当前设备配置的匹配。如果 match 设置为 line，则命令将逐行匹配。如果 match 设置为 none，则模块不会尝试将源配置与远程设备上的运行配置进行比较。 选项 "line" ←（默认） "none"
running_config 别名：config 字符串	默认情况下，该模块将连接到远程设备，并检索当前正在运行的配置，以作为与源内容进行比较的基础。有时，我们不希望任务在剧本中的每个任务都获取当前运行配置。running_config 参数允许实现者传入配置，将其用作比较的基础配置。
保存 布尔值	save 参数指示模块将运行配置保存到启动配置。此操作在对当前运行配置进行任何更改后执行。如果没有进行任何更改，配置仍会保存到启动配置。此选项将始终导致模块返回已更改。此参数与 save_when 互斥。 此选项已在 Ansible 2.7 中弃用，请使用 save_when 选项 false ←（默认） true
save_when 字符串	默认情况下，对设备运行配置所做的更改不会复制到非易失性存储中。使用此参数将改变这一点。如果参数设置为 always，则运行配置将始终复制到启动配置，并且模块将始终返回已更改。如果参数设置为 never，则运行配置将永远不会复制到启动配置。如果参数设置为 changed，则仅当任务进行了更改时，运行配置才会复制到启动配置。 选项 "always" "never" ← (默认) "changed"
src 字符串	指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是剧本或角色根目录中的相对路径。此参数与 lines 互斥。

示例

- name: Configure configuration
  community.network.aireos_config:
    lines: sysname testDevice

- name: Diff the running-config against a provided config
  community.network.aireos_config:
    diff_against: intended
    intended: "{{ lookup('file', 'master.cfg') }}"

- name: Load new acl into device
  community.network.aireos_config:
    lines:
      - acl create testACL
      - acl rule protocol testACL 1 any
      - acl rule direction testACL 3 in
    before: acl delete testACL

- name: Configurable backup path
  community.network.aireos_config:
    backup: true
    lines: sysname testDevice
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

返回值

通用返回值在此处记录：此处，以下是此模块独有的字段

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

状态

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

• 有关更多信息，请参阅 已弃用。

作者

• James Mighion (@jmighion)

集合链接

• 问题跟踪器
• 存储库（源代码）