community.network.edgeos_config 模块 – 管理远程设备上的 EdgeOS 配置

注意

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

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

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

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

注意

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

已弃用

在以下版本中删除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

  • 此模块提供 EdgeOS 设备的配置文件管理。它提供了用于管理配置文件和活动配置状态的参数。所有配置语句都基于设备配置中的 `set` 和 `delete` 命令。

  • 这是一个网络模块，需要 connection: network_cli 才能正常工作。

  • 有关更多信息，请参阅网络指南。

注意

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

别名：network.edgeos.edgeos_config

参数

参数

注释

备份

布尔值

backup 参数将在进行任何更改之前将当前设备的活动配置备份到 Ansible 控制主机。如果未给出 backup_options 值，则备份文件将位于剧本根目录或角色根目录（如果剧本是 ansible 角色的一部分）的备份文件夹中。如果目录不存在，则会创建该目录。

选项

  • false ←（默认）

  • true

backup_options

字典

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

dir_path

路径

此选项提供以目录名称结尾的路径，备份配置文件将存储在该路径中。如果目录不存在，将首先创建该目录，文件名是 filename 的值，或者如 filename 选项描述中所述的默认文件名。如果未给出路径值，则将在当前工作目录中创建一个 *backup* 目录，并且备份配置将复制到 *backup* 目录中的 filename 中。

filename

字符串

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

注释

字符串

允许指定提交描述，以便在提交配置时包含该描述。如果配置未更改或未提交，则将忽略此参数。

默认值： "configured by edgeos_config"

配置

字符串

config 参数指定用于与所需配置进行比较的基础配置。如果未指定此值，模块将自动从远程设备检索当前活动配置。

行

列表 / 元素=字符串

要管理并与远程设备上现有配置进行比较的有序配置行集合。

匹配

字符串

match 参数控制用于匹配当前活动配置的方法。默认情况下，所需的配置与活动配置进行匹配，并加载增量。如果 match 参数设置为 none，则会忽略活动配置，并且始终加载配置。

选项

  • "line" ← (默认)

  • "none"

save

布尔值

save 参数控制是否将对活动配置所做的更改保存到磁盘。这与提交配置无关。当设置为 True 时，活动配置将被保存。

选项

  • false ←（默认）

  • true

src

字符串

src 参数指定要加载的源配置文件的路径。源配置文件可以是括号格式或集合格式。源文件可以包含 Jinja2 模板变量。

说明

注意

  • 已针对 EdgeOS 1.9.7 进行测试

  • 建议将 ANSIBLE_PERSISTENT_COMMAND_TIMEOUT 设置为 30，因为在某些 EdgeOS 硬件上，保存命令可能需要比默认的 10 秒更长的时间。

示例

- name: Configure the remote device
  community.network.edgeos_config:
    lines:
      - set system host-name {{ inventory_hostname }}
      - set service lldp
      - delete service dhcp-server

- name: Backup and load from file
  community.network.edgeos_config:
    src: edgeos.cfg
    backup: true

- name: Configurable backup path
  community.network.edgeos_config:
    src: edgeos.cfg
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

返回值

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

键

描述

backup_path

字符串

备份文件的完整路径

返回: 当 backup 为 yes 时

示例: "/playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34"

commands

列表 / 元素=字符串

发送到设备的配置命令列表

返回: 总是

示例: ["...", "..."]

状态

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

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

作者

  • Nathaniel Case (@Qalthos)

  • Sam Doran (@samdoran)