eos_command - Run arbitrary commands on an Arista EOS device
New in version 2.1.
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.
Options
| parameter | required | default | choices | comments | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| auth_pass |
no | none |
Specifies the password to use if required to enter privileged mode on the remote device. If
authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTH_PASS will be used instead.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| authorize |
no |
|
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commands |
yes |
The commands to send to the remote EOS 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
retries has been exceeded.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interval |
no | 1 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| match
(added in 2.2)
|
no | all |
|
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| provider |
no |
A dict object containing connection details.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| retries |
no | 10 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| wait_for
(added in 2.2)
|
no |
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. See examples.
aliases: waitfor
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
- name: run show version on remote devices
eos_command:
commands: show version
- name: run show version and check to see if output contains Arista
eos_command:
commands: show version
wait_for: result[0] contains Arista
- name: run multiple commands on remote nodes
eos_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
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
eos_command:
commands:
- command: show version
output: json
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| failed_conditions |
The list of conditionals that have failed
|
failed | list | ['...', '...'] |
| stdout |
The set of responses from the commands
|
always apart from low level errors (such as action plugin) | list | ['...', '...'] |
| stdout_lines |
The value of stdout split into a list
|
always apart from low level errors (such as action plugin) | list | [['...', '...'], ['...'], ['...']] |
Notes
Note
- Tested against EOS 4.15
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/eos_command_module.html
