community.network.cnos_showrun 模块 – 收集在 CNOS 上运行的设备的当前运行配置
注意
此模块是 community.network 集合 (版本 5.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.network
。
要在剧本中使用它,请指定:community.network.cnos_showrun
。
注意
community.network 集合已被弃用,并将从 Ansible 12 中移除。有关更多信息,请参阅 讨论主题。
已弃用
- 在以下版本中移除:
版本 6.0.0
- 原因:
此集合及其中的所有内容均未维护且已弃用。
- 替代方案:
未知。
概要
此模块允许您查看交换机的运行配置。它在交换机上执行 display running-config CLI 命令,并返回包含目标网络设备当前运行配置的文件。此模块使用 SSH 管理网络设备配置。操作结果将放置在名为“results”的目录中,用户必须在其本地目录(运行剧本的位置)中创建此目录。
别名:network.cnos.cnos_showrun
参数
参数 |
注释 |
---|---|
这指定了执行方法的设备类型。自 Ansible 2.4 起添加了 NE1072T、NE1032、NE1032T、NE10032、NE2572 选项。自 2.8 起添加了 NE0152T 选项。 选项
|
|
配置用于进入交换机全局配置命令模式的密码。如果交换机不需要此密码,则忽略此参数。虽然通常应从清单文件获取该值,但您也可以将其指定为变量。此参数是可选的。如果未指定,则不使用默认值。 |
|
这是用于搜索 /etc/ansible/hosts 中的主机文件并识别要在其上应用模板的设备的 IP 地址的变量。通常,Ansible 关键字 {{ inventory_hostname }} 在剧本中指定为需要配置的网络元素组的抽象。 |
|
这指定了保存每个命令执行输出的文件路径。在合并的模板文件中指定的每个命令以及来自设备的每个响应都将保存到这里。通常位置是 results 文件夹,但您可以根据您的写入权限选择其他位置。 |
|
配置用于验证与远程设备连接的密码。password 参数的值用于验证 SSH 会话。虽然通常应从清单文件获取该值,但您也可以将其指定为变量。此参数是可选的。如果未指定,则不使用默认值。 |
|
配置用于验证与远程设备连接的用户名。username 参数的值用于验证 SSH 会话。虽然通常应从清单文件获取该值,但您也可以将其指定为变量。此参数是可选的。如果未指定,则不使用默认值。 |
备注
注意
有关使用 Ansible 管理联想网络设备的更多信息,请参见 https://ansible.org.cn/ansible-lenovo。
示例
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"
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
成功或失败消息 返回值:始终 示例: |
状态
此模块将在 6.0.0 版本中移除。[已弃用]
有关更多信息,请参见 已弃用。