New in version 2.2.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
commands
required |
|
List of commands to send to the remote dellos9 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 expired.
|
|
interval
|
Default:
yes
|
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.
|
|
match
(added in 2.5) |
|
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
|
|
A dict object containing connection details.
|
|
username
|
|
User to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
|
host
required |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
|
ssh_keyfile
|
|
Path to an ssh key used to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
|
timeout
|
Default:
10
|
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
|
|
password
|
|
Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
|
port
|
Default:
22
|
Specifies the port to use when building the connection to the remote device.
|
|
retries
|
Default:
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 conditions.
|
|
wait_for
(added in 2.2) |
|
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.
|
Note
tasks:
- name: run show version on remote devices
dellos9_command:
commands: show version
- name: run show version and check to see if output contains OS9
dellos9_command:
commands: show version
wait_for: result[0] contains OS9
- name: run multiple commands on remote nodes
dellos9_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
dellos9_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains OS9
- result[1] contains Loopback
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
failed_conditions
list
|
failed |
The list of conditionals that have failed
Sample:
['...', '...']
|
|
stdout
list
|
always apart from low level errors (such as action plugin) |
The set of responses from the commands
Sample:
['...', '...']
|
|
stdout_lines
list
|
always apart from low level errors (such as action plugin) |
The value of stdout split into a list
Sample:
[['...', '...'], ['...'], ['...']]
|
|
warnings
list
|
always |
The list of warnings (if any) generated by module based on arguments
Sample:
['...', '...']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.