community.network.cnos_command 模块 – 在联想 CNOS 设备上运行任意命令
注意
此模块是 community.network 集合 (版本 5.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install community.network
。
要在 playbook 中使用它,请指定: community.network.cnos_command
。
注意
community.network 集合已被弃用,并将从 Ansible 12 中删除。有关更多信息,请参阅 讨论主题。
已弃用
- 在以下版本中移除:
6.0.0 版
- 原因:
此集合及其中的所有内容均未维护且已弃用。
- 替代方案:
未知。
概要
将任意命令发送到 CNOS 节点并返回从设备读取的结果。
cnos_command
模块包含一个参数,该参数将导致模块在返回之前等待特定条件,或者如果未满足条件则超时。
别名:network.cnos.cnos_command
参数
参数 |
注释 |
---|---|
要发送到远程设备的命令列表。返回命令的输出结果。如果提供了 wait_for 参数,则在满足条件或重试次数过期之前,模块不会返回。 |
|
配置以秒为单位的间隔,用于在命令重试之间等待。如果命令未通过指定的条件,则间隔表示在再次尝试命令之前要等待的时间。 默认值: |
|
match 参数与 wait_for 参数结合使用以指定匹配策略。有效值为 选项
|
|
指定在命令被认为失败之前应尝试的重试次数。命令在每次重试时都在目标设备上运行,并根据 wait_for 条件进行评估。 默认值: |
|
要根据命令输出评估的条件列表。在继续执行之前,任务将等待每个条件都为真。如果在配置的重试次数内条件不为真,则任务失败。请参阅示例。 |
示例
---
- name: Test contains operator
community.network.cnos_command:
commands:
- show version
- show system memory
wait_for:
- "result[0] contains 'Lenovo'"
- "result[1] contains 'MemFree'"
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: Get output for single command
community.network.cnos_command:
commands: ['show version']
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: Get output for multiple commands
community.network.cnos_command:
commands:
- show version
- show interface information
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- "result.stdout | length == 2"
返回值
常用的返回值在 此处 有记录,以下是此模块特有的字段
键 |
描述 |
---|---|
失败的条件 返回:失败 示例: |
|
命令的响应集 返回:始终 示例: |
|
stdout 的值拆分成一个列表 返回:始终 示例: |
状态
此模块将在 6.0.0 版中删除。 *[已弃用]*
有关更多信息,请参见 已弃用。