community.network.cnos_config 模块 – 管理 Lenovo CNOS 配置段

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

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

别名：network.cnos.cnos_config

参数

参数	注释
admin 布尔值	进入管理配置模式以对设备进行配置更改。 选项 false ← (默认) true
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 字符串	如果需要进行更改，则要推送到命令栈的有序命令集。这允许剧本设计者有机会在推送任何更改之前执行配置命令，而不会影响命令集与系统匹配的方式。
comment 字符串	允许指定一个提交描述，在提交配置时包含在内。如果配置没有更改或提交，则忽略此参数。 默认值： "configured by cnos_config"
config 字符串	默认情况下，此模块将连接到远程设备并检索当前的 running-config，将其用作与源内容进行比较的基准。有时，不希望任务为剧本中的每个任务获取当前的 running-config。config 参数允许实现者传入用作比较基准配置的配置。
lines 别名：commands 字符串	应该在该部分中配置的命令的有序集合。这些命令必须与设备 running-config 中找到的命令完全相同。请务必注意配置命令语法，因为某些命令会由设备配置解析器自动修改。
match 字符串	指示模块如何执行命令集与当前设备配置的匹配。如果 match 设置为 line，则逐行匹配命令。如果 match 设置为 strict，则命令行将根据位置匹配。如果 match 设置为 exact，则命令行必须是完全匹配。最后，如果 match 设置为 none，则模块将不会尝试将源配置与远程设备上的运行配置进行比较。 选项 "line" ← (默认) "strict" "exact" "none"
parents 字符串	用于唯一标识应针对其检查命令的节的父级有序集。如果省略 parents 参数，则会针对顶级或全局命令集检查命令。
replace 字符串	指示模块在设备上执行配置的方式。如果 replace 参数设置为line，则修改后的行将以配置模式推送到设备。如果 replace 参数设置为block，则如果任何一行不正确，则整个命令块将以配置模式推送到设备。 选项 "line" ← (默认) “block” “config”
src 字符串	指定包含要加载的配置或配置模板的文件的源路径。源文件的路径可以是 Ansible 控制主机上的完整路径，也可以是相对于剧本或角色根目录的相对路径。此参数与lines、parents互斥。

注释

注意

• 已在 CNOS 10.9.1 上测试

示例

Tasks: The following are examples of using the module cnos_config.
---
- name: Configure top level configuration
  community.network.cnos_config:
    "lines: hostname {{ inventory_hostname }}"

- name: Configure interface settings
  community.network.cnos_config:
    lines:
      - enable
      - ip ospf enable
    parents: interface ip 13

- name: Load a config from disk and replace the current config
  community.network.cnos_config:
    src: config.cfg
    backup: true

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

返回值

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

键	描述
backup_path 字符串	备份文件的完整路径 返回：当 backup 为 yes 时 示例："/playbooks/ansible/backup/cnos01.2016-07-16@22:28:34"
updates 列表 / 元素=字符串	将推送到远程设备的命令集 返回：仅当指定 lines 时。 示例：["...", "..."]

状态

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

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

作者

• Anil Kumar Muraleedharan (@amuraleedhar)

资源链接

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