ansible.netcommon.cli_backup 模块 – 通过 network_cli 从网络设备备份设备配置

注意

此模块是 ansible.netcommon 集合 (版本 7.1.0) 的一部分。

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

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

要在 playbook 中使用它，请指定：ansible.netcommon.cli_backup。

ansible.netcommon 4.2.0 中的新增功能

概要

  • 此模块提供了一种与平台无关的方法，用于通过 network_cli 连接插件从网络设备备份基于文本的配置。

注意

此模块具有相应的 action 插件。

参数

参数

注释

defaults

布尔值

defaults 参数将影响如何从设备收集运行配置。当值为 true 时，用于收集运行配置的命令将附加 all 关键字。当值为 false 时，命令将不带 all 关键字发出。

选项

  • false ← (默认值)

  • true

dir_path

路径

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

filename

字符串

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

备注

注意

  • 此模块支持 ansible_network_os 网络平台。有关详细信息，请参见：ref:`网络平台选项 `。

示例

- name: configurable backup path
  ansible.netcommon.cli_backup:
    filename: backup.cfg
    dir_path: /home/user

返回值

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

键

描述

backup_path

字符串

备份文件的完整路径

返回：始终

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

作者

  • Kate Case (@Qalthos)