community.network.ironware_command (5.0.2) — module

Install collection

Install with ansible-galaxy collection install community.network:==5.0.2

Add to requirements.yml

  collections:
    - name: community.network
      version: 5.0.2

Description

Sends arbitrary commands to a Extreme Ironware node and returns the results read from the device. This module includes a I(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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
match:
    choices:
    - any
    - all
    default: all
    description:
    - The I(match) argument is used in conjunction with the I(wait_for) argument to specify
      the match policy. If the value is set to C(all) then all conditionals in the I(wait_for)
      must be satisfied.  If the value is set to C(any) then only one of the values must
      be satisfied.

retries:
    default: 10
    description:
    - 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 I(wait_for) conditions.

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

interval:
    default: 1
    description:
    - 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.

wait_for:
    description:
    - 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.

authorize:
    default: false
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.7 we recommend using C(connection: network_cli) and C(become:
      true).'
    - For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html).
    - HORIZONTALLINE
    - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
    type: bool

Outputs

failed_conditions:
  description: the conditionals that failed
  returned: failed
  sample:
  - '...'
  - '...'
  type: list
stdout:
  description: the set of responses from the commands
  returned: always
  sample:
  - '...'
  - '...'
  type: list
stdout_lines:
  description: The value of stdout split into a list
  returned: always
  sample:
  - - '...'
    - '...'
  - - '...'
  - - '...'
  type: list