community.network.ironware_command module – Run arbitrary commands on Extreme IronWare devices

Note

This module is part of the community.network collection (version 5.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ironware_command.

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

  • Sends arbitrary commands to a Extreme Ironware node and returns the results read from the device. This module includes a wait_for argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Aliases: network.ironware.ironware_command

Parameters

Parameter

Comments

authorize

boolean

Deprecated

Starting with Ansible 2.7 we recommend using connection: network_cli and become: true.

For more information please see the IronWare Platform Options guide.

<hr>

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

Choices:

  • false ← (default)

  • true

commands

string / required

List of commands to send to the remote device over the configured provider. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.

interval

string

Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.

Default: 1

match

string

The match argument is used in conjunction with the wait_for argument to specify the match policy. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.

Choices:

  • "any"

  • "all" ← (default)

retries

string

Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.

Default: 10

wait_for

string

List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples.

Notes

Note

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

failed_conditions

list / elements=string

the conditionals that failed

Returned: failed

Sample: ["...", "..."]

stdout

list / elements=string

the set of responses from the commands

Returned: always

Sample: ["...", "..."]

stdout_lines

list / elements=string

The value of stdout split into a list

Returned: always

Sample: [["...", "..."], ["..."], ["..."]]

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Paul Baker (@paulquack)