community.network.aruba_config 模块 – 管理 Aruba 配置节
注意
此模块是 community.network 集合(版本 5.1.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.network
。
要在 playbook 中使用它,请指定:community.network.aruba_config
。
注意
community.network 集合已被弃用,并将从 Ansible 12 中删除。有关更多信息,请参阅讨论线程。
已弃用
- 在以下版本中移除:
版本 6.0.0
- 原因:
此集合及其中的所有内容均未维护且已弃用。
- 替代方案:
未知。
概要
Aruba 配置使用简单的块缩进文件语法将配置分段为不同的节。此模块提供了一种以确定性方式处理 Aruba 配置节的实现。
别名:network.aruba.aruba_config
参数
参数 |
注释 |
---|---|
如果需要进行更改,则附加到命令堆栈末尾的有序命令集。就像 before 一样,这允许 playbook 设计者附加一组命令,以便在命令集之后执行。 |
|
此参数将导致模块在进行任何更改之前,从远程设备创建当前 选项
|
|
这是一个字典对象,其中包含与备份文件路径相关的可配置选项。仅当 |
|
此选项提供了路径,该路径以将存储备份配置文件的目录名称结尾。如果该目录不存在,则将首先创建该目录,并且文件名是 |
|
用于存储备份配置的文件名。如果未给出文件名,则将根据主机名、当前时间和日期以 <hostname>_config.<current-date>@<current-time> 定义的格式生成。 |
|
如果需要进行更改,则要推送到命令堆栈的有序命令集。这使 playbook 设计者有机会在推送任何更改之前执行配置命令,而不会影响命令集与系统匹配的方式。 |
|
当使用 当此选项配置为 startup 时,模块将返回运行配置与启动配置的差异。 当此选项配置为 intended 时,模块将返回运行配置与 当此选项配置为 running 时,模块将返回对设备配置所做的任何更改的运行配置的前后差异。 选项
|
|
使用此参数指定在差异期间应忽略的一个或多个行。这用于配置中由系统自动更新的行。此参数采用正则表达式列表或精确的行匹配。 |
|
当设置为 false 时,这允许 Aruba 控制器的密码和密钥以明文形式显示;当设置为 true 时,则会加密显示。如果设置为 false,则该设置将在模块运行结束时重新加密。即使设置为 false,备份仍会被加密。 选项
|
|
|
|
应在节中配置的有序命令集。这些命令必须与设备运行配置中找到的命令完全相同。请务必注意配置命令语法,因为某些命令会由设备配置解析器自动修改。 |
|
指示模块如何将一组命令与当前设备配置进行匹配。如果 match 设置为 line,则按行匹配命令。如果 match 设置为 strict,则命令行的匹配会考虑位置。如果 match 设置为 exact,则命令行的匹配必须完全相同。最后,如果 match 设置为 none,则模块不会尝试将源配置与远程设备上的运行配置进行比较。 选项
|
|
有序的父级集合,用于唯一标识命令应检查的节或层次结构。如果省略 parents 参数,则命令将针对顶级或全局命令集进行检查。 |
|
指示模块如何在设备上执行配置。如果 replace 参数设置为 line,则修改后的行将在配置模式下推送到设备。如果 replace 参数设置为 block,则如果任何行不正确,则整个命令块将在配置模式下推送到设备。 选项
|
|
默认情况下,该模块将连接到远程设备并检索当前的运行配置,以作为与源内容进行比较的基础。有时,不希望在 playbook 中的每个任务都获取当前的运行配置。running_config 参数允许实施者传入配置,以用作比较的基本配置。 |
|
当对设备运行配置进行更改时,默认情况下不会将更改复制到非易失性存储器。使用此参数将在之前更改此行为。如果该参数设置为 always,则运行配置将始终复制到启动配置,并且 modified 标志将始终设置为 True。如果该参数设置为 modified,则只有在运行配置自上次保存到启动配置后发生更改时,才会将其复制到启动配置。如果该参数设置为 never,则永远不会将运行配置复制到启动配置。如果该参数设置为 changed,则只有在任务进行更改后,才会将运行配置复制到启动配置。 选项
|
|
指定包含要加载的配置或配置模板的源文件路径。源文件的路径可以是 Ansible 控制主机上的完整路径,也可以是 playbook 或角色根目录中的相对路径。此参数与 lines、 parents 互斥。 |
示例
- name: Configure top level configuration
community.network.aruba_config:
lines: hostname {{ inventory_hostname }}
- name: Diff the running-config against a provided config
community.network.aruba_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: Configure interface settings
community.network.aruba_config:
lines:
- description test interface
- ip access-group 1 in
parents: interface gigabitethernet 0/0/0
- name: Load new acl into device
community.network.aruba_config:
lines:
- permit host 10.10.10.10
- ipv6 permit host fda9:97d6:32a3:3e59::3333
parents: ip access-list standard 1
before: no ip access-list standard 1
match: exact
- name: Configurable backup path
community.network.aruba_config:
backup: true
lines: hostname {{ inventory_hostname }}
backup_options:
filename: backup.cfg
dir_path: /home/user
返回值
常见的返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
备份文件的完整路径 返回: 当 backup 为 yes 时 示例: |
|
将推送到远程设备的命令集 返回: 始终 示例: |
|
将推送到远程设备的命令集 返回: 始终 示例: |
状态
此模块将在 6.0.0 版本中移除。[已弃用]
有关详细信息,请参阅已弃用。