Working with command output and prompts in network modules¶
Ansible allows you to use conditionals to control the flow of your playbooks. Ansible networking command modules use the following unique conditional statements.
neq- Not equal
gt- Greater than
ge- Greater than or equal
lt- Less than
le- Less than or equal
contains- Object contains specified item
Conditional statements evaluate the results from the commands that are
executed remotely on the device. Once the task executes the command
wait_for argument can be used to evaluate the results before
returning control to the Ansible playbook.
--- - name: wait for interface to be admin enabled arista.eos.eos_command: commands: - show interface Ethernet4 | json wait_for: - "result.interfaces.Ethernet4.interfaceStatus eq connected"
In the above example task, the command
show interface Ethernet4 | json
is executed on the remote device and the results are evaluated. If
(result.interfaces.Ethernet4.interfaceStatus) is not equal to
“connected”, then the command is retried. This process continues
until either the condition is satisfied or the number of retries has
expired (by default, this is 10 retries at 1 second intervals).
The commands module can also evaluate more than one set of command results in an interface. For instance:
--- - name: wait for interfaces to be admin enabled arista.eos.eos_command: commands: - show interface Ethernet4 | json - show interface Ethernet5 | json wait_for: - "result.interfaces.Ethernet4.interfaceStatus eq connected" - "result.interfaces.Ethernet5.interfaceStatus eq connected"
In the above example, two commands are executed on the remote device, and the results are evaluated. By specifying the result index value (0 or 1), the correct result output is checked against the conditional.
wait_for argument must always start with result and then the
command index in
0 is the first command in the commands list,
1 is the second command,
2 is the third and so on.
Network devices may require that you answer a prompt before performing a change on the device. Individual network modules such as cisco.ios.ios_command and cisco.nxos.nxos_command can handle this with a
prompt is a Python regex. If you add special characters such as
? in the
prompt value, the prompt won’t match and you will get a timeout. To avoid this, ensure that the
prompt value is a Python regex that matches the actual device prompt. Any special characters must be handled correctly in the
You can also use the ansible.netcommon.cli_command to handle multiple prompts.
--- - name: multiple prompt, multiple answer (mandatory check for all prompts) ansible.netcommon.cli_command: command: "copy sftp sftp://[email protected]//user/test.img" check_all: True prompt: - "Confirm download operation" - "Password" - "Do you want to change that to the standby image" answer: - 'y' - <password> - 'y'
You must list the prompt and the answers in the same order (that is, prompt is answered by answer).
In the above example,
check_all: True ensures that the task gives the matching answer to each prompt. Without that setting, a task with multiple prompts would give the first answer to every prompt.
In the following example, the second answer would be ignored and
y would be the answer given to both prompts. That is, this task only works because both answers are identical. Also notice again that
prompt must be a Python regex, which is why the
? is escaped in the first prompt.
--- - name: reboot ios device ansible.netcommon.cli_command: command: reload prompt: - Save\? - confirm answer: - y - y