community.network.ironware_command 模块 – 在 Extreme IronWare 设备上运行任意命令

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 向 Extreme Ironware 节点发送任意命令,并返回从设备读取的结果。 此模块包含一个 *wait_for* 参数,该参数将使模块等待特定条件,然后才返回,如果未满足条件,则会超时。

别名: network.ironware.ironware_command

参数

参数

注释

authorize

布尔值

已弃用

从 Ansible 2.7 开始,我们建议使用 connection: network_clibecome: true

有关更多信息,请参阅IronWare 平台选项指南

<hr>

指示模块在发送任何命令之前在远程设备上进入特权模式。 如果未指定,则设备将尝试在非特权模式下执行所有命令。 如果未在任务中指定该值,则将使用环境变量 ANSIBLE_NET_AUTHORIZE 的值。

选项

  • false ← (默认)

  • true

commands

字符串 / 必需

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

interval

字符串

配置命令重试之间等待的间隔秒数。 如果命令未通过指定的条件,则间隔表示在再次尝试命令之前等待的时间。

默认: 1

match

字符串

_match_ 参数与 _wait_for_ 参数结合使用,以指定匹配策略。 如果该值设置为 all,则必须满足 _wait_for_ 中的所有条件。 如果该值设置为 any,则仅必须满足其中一个值。

选项

  • "any"

  • "all" ← (默认)

retries

字符串

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

默认: 10

wait_for

字符串

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

说明

注意

  • 有关使用 Ansible 管理网络设备的更多信息,请参阅:ref:`Ansible 网络指南 <network_guide>`

示例

- name: Run a command
  community.network.ironware_command:
    commands:
      - show version

- name: Run several commands
  community.network.ironware_command:
    commands:
      - show interfaces brief wide
      - show mpls vll

返回值

常见返回值记录在这里,以下是此模块特有的字段

描述

failed_conditions

列表 / elements=字符串

失败的条件

返回: 失败

示例: ["...", "..."]

stdout

列表 / elements=字符串

来自命令的响应集

返回: 总是

示例: ["...", "..."]

stdout_lines

列表 / elements=字符串

stdout 的值分割成列表

返回: 总是

示例: [["...", "..."], ["..."], ["..."]]

状态

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

  • 更多信息请参见 已弃用

作者

  • Paul Baker (@paulquack)