tpajon.aos.aos_command (1.0.8) — module

Install collection

Install with ansible-galaxy collection install tpajon.aos:==1.0.8

Add to requirements.yml

  collections:
    - name: tpajon.aos
      version: 1.0.8

Description

Sends arbitrary commands to an aos node and returns the results read from the device. This module includes an 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 show version on remote devices
  tpajon.aos.aos_command:
    commands: show version

Scanned by Steampunk Spotter

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

- name: run show version and check to see if output contains WC
  tpajon.aos.aos_command:
    commands: show version
    wait_for: result[0] contains WC

Scanned by Steampunk Spotter

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

- name: run multiple commands on remote nodes
  tpajon.aos.aos_command:
    commands:
    - show version
    - show interfaces all

Scanned by Steampunk Spotter

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

- name: run multiple commands and evaluate the output
  tpajon.aos.aos_command:
    commands:
    - show version
    - show interfaces all
    wait_for:
    - result[0] contains WC
    - result[1] contains "port 2"

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.  Valid values are C(all) or C(any).  If the value is set to C(all)
      then all conditionals in the wait_for must be satisfied.  If the value is set to
      C(any) then only one of the values must be satisfied.
    type: str

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.
    type: int

commands:
    description:
    - List of commands to send to the remote ios 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 retries has expired. If a command sent to the device requires answering a prompt,
      it is possible to pass a dict containing I(command), I(answer) and I(prompt). Common
      answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
    elements: raw
    required: true
    type: list

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.
    type: int

wait_for:
    aliases:
    - waitfor
    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.
    elements: str
    type: list

Outputs

failed_conditions:
  description: The list of conditionals that have failed
  returned: failed
  sample:
  - '...'
  - '...'
  type: list
stdout:
  description: The set of responses from the commands
  returned: always apart from low level errors (such as action plugin)
  sample:
  - '...'
  - '...'
  type: list
stdout_lines:
  description: The value of stdout split into a list
  returned: always apart from low level errors (such as action plugin)
  sample:
  - - '...'
    - '...'
  - - '...'
  - - '...'
  type: list