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

列表 / 元素=字符串

失败的条件

返回:失败

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

stdout

列表 / 元素=字符串

命令的响应集

返回:始终

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

stdout_lines

列表 / 元素=字符串

stdout 的值拆分为列表

返回:始终

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

状态

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

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

作者

  • Paul Baker (@paulquack)