New in version 2.1.
|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
|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
|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.
(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
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.
(added in 2.2)
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.
- 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 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 contains Arista - result contains Loopback0 - name: run commands and specify the output format eos_command: commands: - command: show version output: json
Common return values are documented here Return Values, the following are the fields unique to this module:
The value of stdout split into a list
|always apart from low level errors (such as action plugin)||list||[['...', '...'], ['...'], ['...']]|
The set of responses from the commands
|always apart from low level errors (such as action plugin)||list||['...', '...']|
The list of conditionals that have failed
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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>
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.