community.network.nos_config 模块 – 管理 Extreme Networks NOS 配置节

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.network

要在剧本中使用它,请指定:community.network.nos_config

注意

community.network 集合已弃用,并将从 Ansible 12 中移除。有关更多信息,请参见 讨论主题

已弃用

在以下版本中移除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • Extreme NOS 配置使用简单的块缩进文件语法将配置分割成多个部分。此模块提供了一种确定性地处理 NOS 配置节的实现。

注意

此模块具有相应的 操作插件

别名:network.nos.nos_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* 时,模块将返回相对于对设备配置所做的任何更改的运行配置的之前和之后的差异。

选项

  • "running"

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

multiline_delimiter

字符串

此参数用于将多行配置元素推送到 NOS 设备。它指定用作分隔符的字符。这仅适用于配置操作。

默认值: "@"

parents

字符串

唯一标识应针对其检查命令的节或层次结构的有序父集。如果省略 parents 参数,则会针对顶级或全局命令集检查命令。

replace

字符串

指示模块如何对设备执行配置。如果 replace 参数设置为 line,则修改后的行将以配置模式推送到设备。如果 replace 参数设置为 block,则如果任何一行不正确,则整个命令块将以配置模式推送到设备。

选项

  • "line" ← (默认)

  • "block"

running_config

别名:config

字符串

默认情况下,模块将连接到远程设备并检索当前的 running-config,将其用作与源内容进行比较的基准。有时不需要让任务为 playbook 中的每个任务获取当前的 running-config。running_config 参数允许实现者传入用作比较基准配置的配置。

src

字符串

指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径,也可以是 playbook 或角色根目录的相对路径。此参数与 linesparents 互斥。

备注

注意

  • 已针对 NOS 7.2.0 进行测试

示例

- name: Configure top level configuration
  community.network.nos_config:
    lines: logging raslog console INFO

- name: Configure interface settings
  community.network.nos_config:
    lines:
      - description test interface
      - ip address 172.31.1.1/24
    parents:
      - interface TenGigabitEthernet 104/0/1

- name: Configure multiple interfaces
  community.network.nos_config:
    lines:
      - lacp timeout long
    parents: "{{ item }}"
  with_items:
    - interface TenGigabitEthernet 104/0/1
    - interface TenGigabitEthernet 104/0/2

- name: Load new acl into device
  community.network.nos_config:
    lines:
      - seq 10 permit ip host 1.1.1.1 any log
      - seq 20 permit ip host 2.2.2.2 any log
      - seq 30 permit ip host 3.3.3.3 any log
      - seq 40 permit ip host 4.4.4.4 any log
      - seq 50 permit ip host 5.5.5.5 any log
    parents: ip access-list extended test
    before: no ip access-list extended test
    match: exact

- name: Check the running-config against master config
  community.network.nos_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: Configurable backup path
  community.network.nos_config:
    lines: logging raslog console INFO
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

返回值

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

描述

backup_path

字符串

备份文件的完整路径

返回:当 backup 为 yes 时

示例: "/playbooks/ansible/backup/nos_config.2018-02-12@18:26:34"

commands

列表 / 元素=字符串

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

返回:始终返回

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

updates

列表 / 元素=字符串

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

返回:始终返回

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

状态

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

  • 更多信息请参见 已弃用

作者

  • Lindsay Hill (@LindsayHill)