community.network.cnos_showrun 模块 – 收集运行 CNOS 的设备上的当前运行配置

注意

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

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

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

要在 playbook 中使用它,请指定:community.network.cnos_showrun

注意

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

已弃用

在以下版本中删除:

6.0.0 版本

原因:

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

替代方案:

未知。

概要

  • 此模块允许您查看交换机运行配置。它在交换机上执行 display running-config CLI 命令,并返回一个包含目标网络设备的当前运行配置的文件。此模块使用 SSH 来管理网络设备配置。操作结果将放在名为“results”的目录中,该目录必须由用户在其运行 playbook 的本地目录中创建。

别名:network.cnos.cnos_showrun

参数

参数

注释

deviceType

字符串 / 必需

这指定执行方法的设备类型。自 Ansible 2.4 起添加了选项 NE1072T、NE1032、NE1032T、NE10032、NE2572。自 2.8 起添加了选项 NE0152T

选项

  • "g8272_cnos"

  • "g8296_cnos"

  • "g8332_cnos"

  • "NE0152T"

  • "NE1072T"

  • "NE1032"

  • "NE1032T"

  • "NE10032"

  • "NE2572"

enablePassword

字符串

配置用于在交换机上进入全局配置命令模式的密码。如果交换机不请求此密码,则忽略该参数。虽然通常该值应来自清单文件,但您也可以将其指定为变量。此参数是可选的。如果未指定,将不会使用默认值。

host

字符串 / 必需

这是用于在 /etc/ansible/hosts 中搜索主机文件,并识别应用模板的设备的 IP 地址的变量。通常,Ansible 关键字 {{ inventory_hostname }} 在 playbook 中指定,作为需要配置的网络元素组的抽象。

outputfile

字符串 / 必需

这指定保存每个命令执行输出的文件路径。此处保存合并的模板文件中指定的每个命令以及来自设备的每个响应。通常,该位置是结果文件夹,但您可以根据您的写入权限选择其他位置。

password

字符串 / 必需

配置用于验证与远程设备的连接的密码。密码参数的值用于验证 SSH 会话。虽然通常该值应来自清单文件,但您也可以将其指定为变量。此参数是可选的。如果未指定,将不会使用默认值。

username

字符串 / 必需

配置用于验证与远程设备的连接的用户名。用户名参数的值用于验证 SSH 会话。虽然通常该值应来自清单文件,但您也可以将其指定为变量。此参数是可选的。如果未指定,将不会使用默认值。

注释

注意

示例

Tasks : The following are examples of using the module cnos_showrun. These are
 written in the main.yml file of the tasks directory.
---
- name: Run show running-config
  community.network.cnos_showrun:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_showrun_{{ inventory_hostname }}_output.txt"

返回值

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

描述

msg

字符串

成功或失败消息

返回: 始终

示例: "运行配置 已保存在文件中"

状态

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

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

作者

  • Anil Kumar Muraleedharan (@amuraleedhar)