arista.eos.eos_command module – Run arbitrary commands on an Arista EOS device

Note

This module is part of the arista.eos collection (version 6.2.2).

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 arista.eos.

To use it in a playbook, specify: arista.eos.eos_command.

New in arista.eos 1.0.0

Synopsis

• Sends an arbitrary set of commands to an EOS 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.

Aliases: command

Parameters

Parameter	Comments
commands list / elements=any / required	The commands to send to the remote EOS device. 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 retries has been exceeded. Commands may be represented either as simple strings or as dictionaries as described below. Refer to the Examples setion for some common uses.
answer list / elements=string	The answer to reply with if prompt is matched. The value can be a single answer or a list of answer for multiple prompts. In case the command execution results in multiple prompts the sequence of the prompt and excepted answer should be in same order.
check_all boolean	By default if any one of the prompts mentioned in prompt option is matched it won’t check for other prompts. This boolean flag, that when set to True will check for all the prompts mentioned in prompt option in the given order. If the option is set to True all the prompts should be received from remote host if not it will result in timeout. Choices: false ← (default) true
command string / required	The command to send to the remote network device. The resulting output from the command is returned, unless sendonly is set.
newline boolean	The boolean value, that when set to false will send answer to the device without a trailing newline. Choices: false true ← (default)
output string	How the remote device should format the command response data. Choices: "text" "json"
prompt list / elements=string	A single regex pattern or a sequence of patterns to evaluate the expected prompt from command.
sendonly boolean	The boolean value, that when set to true will send command to the device but not wait for a result. Choices: false ← (default) true
version string	Specifies the version of the JSON response returned when output=json. Choices: "1" "latest" ← (default)
interval integer	Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to 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. Valid values are all or any. 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 integer	Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals. Default: 10
wait_for aliases: waitfor list / elements=string	Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. Note - With wait_for the value in result['stdout'] can be accessed using result, that is to access result['stdout'][0] use result[0] See examples.

Notes

Note

• Tested against Arista EOS 4.24.6F

Examples

- name: run show version on remote devices
  arista.eos.eos_command:
    commands: show version

- name: run show version and check to see if output contains Arista
  arista.eos.eos_command:
    commands: show version
    wait_for: result[0] contains Arista

- name: run multiple commands on remote nodes
  arista.eos.eos_command:
    commands:
      - show version
      - show interfaces

- name: run multiple commands and evaluate the output
  arista.eos.eos_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains Arista
      - result[1] contains Loopback0

- name: run commands and specify the output format
  arista.eos.eos_command:
    commands:
      - command: show version
        output: json

- name: check whether the switch is in maintenance mode
  arista.eos.eos_command:
    commands: show maintenance
    wait_for: result[0] contains 'Under Maintenance'

- name: check whether the switch is in maintenance mode using json output
  arista.eos.eos_command:
    commands:
      - command: show maintenance
        output: json
    wait_for: result[0].units.System.state eq 'underMaintenance'

- name: check whether the switch is in maintenance, with 8 retries
    and 2 second interval between retries
  arista.eos.eos_command:
    commands: show maintenance
    wait_for: result[0]['units']['System']['state'] eq 'underMaintenance'
    interval: 2
    retries: 8

- name: run a command that requires a confirmation. Note that prompt
    takes regexes, and so strings containing characters like brackets
    need to be escaped.
  arista.eos.eos_command:
    commands:
      - command: reload power
        prompt: \[confirm\]
        answer: y
        newline: false

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 list of conditionals that have failed Returned: failed Sample: ["...", "..."]
stdout list / elements=string	The set of responses from the commands Returned: always apart from low level errors (such as action plugin) Sample: ["...", "..."]
stdout_lines list / elements=string	The value of stdout split into a list Returned: always apart from low level errors (such as action plugin) Sample: [["...", "..."], ["..."], ["..."]]

Authors

• Peter Sprygada (@privateip)

Collection links

• Issue Tracker
• Repository (Sources)