community.network.apconos_command 模块 – 在 APCON 设备上运行任意命令

注意

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

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

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

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

注意

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

community.network 0.2.0 中的新增功能

已弃用

删除于:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 将任意命令发送到 apcon 设备,并返回从设备读取的结果。该模块包含一个参数,该参数将使模块等待特定条件,然后再返回或在未满足条件时超时。

别名: network.apconos.apconos_command

参数

参数

注释

commands

list / elements=string / 必需

通过配置的提供程序发送到远程设备的命令列表。返回命令的最终输出。如果提供了 wait_for 参数,则模块不会返回,直到满足条件或重试次数已过期。

interval

integer

配置命令重试之间等待的间隔(以秒为单位)。如果命令未通过指定的条件,则间隔指示再次尝试命令前等待的时间。

默认值: 1

match

string

match 参数与 wait_for 参数结合使用,以指定匹配策略。有效值为 allany。如果值设置为 all,则必须满足 wait_for 中的所有条件。如果该值设置为 any,则只需满足其中一个值即可。

选项

  • "any"

  • "all" ← (默认)

retries

integer

指定在被认为失败之前应尝试命令的重试次数。每次重试都会在目标设备上运行该命令,并根据 wait_for 条件进行评估。

默认值: 10

wait_for

list / elements=string

针对命令输出评估的条件列表。任务将等待每个条件为真,然后继续前进。如果在配置的重试次数内条件不为真,则任务失败。请参阅示例。

说明

注意

  • 已针对 apcon iis+ii 进行测试

示例

- name: Basic Configuration
  community.network.apconos_command:
    commands:
    - show version
    - enable ssh
  register: result

- name: Get output from single command
  community.network.apconos_command:
    commands: ['show version']
  register: result

状态

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

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

作者

  • David Lee (@davidlee-ap)