cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Clarifies how Ansible processes multiple failed_when conditions (#55941)

Browse source 
Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
This commit is contained in:
Alicia Cozine 2019-05-01 07:31:59 -05:00 committed by GitHub
parent 0b002203b4
commit 5439eb8bd8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/docsite/rst/user_guide/playbooks_error_handling.rst
View file

@ -63,11 +63,9 @@ the handler from running, such as a host becoming unreachable.)
Controlling What Defines Failure Controlling What Defines Failure
```````````````````````````````` ````````````````````````````````
Suppose the error code of a command is meaningless and to tell if there Ansible lets you define what "failure" means in each task using the ``failed_when`` conditional. As with all conditionals in Ansible, lists of multiple ``failed_when`` conditions are joined with an implicit ``and``, meaning the task only fails when *all* conditions are met. If you want to trigger a failure when any of the conditions is met, you must define the conditions in a string with an explicit ``or`` operator.
is a failure what really matters is the output of the command, for instance
if the string "FAILED" is in the output.
Ansible provides a way to specify this behavior as follows:: You may check for failure by searching for a word or phrase in the output of a command::
- name: Fail task when the command error output prints FAILED - name: Fail task when the command error output prints FAILED
command: /usr/bin/example-command -x -y -z command: /usr/bin/example-command -x -y -z
@ -93,14 +91,18 @@ In previous version of Ansible, this can still be accomplished as follows::
msg: "the command failed" msg: "the command failed"
when: "'FAILED' in command_result.stderr" when: "'FAILED' in command_result.stderr"
You can also combine multiple conditions to specify this behavior as follows:: You can also combine multiple conditions for failure. This task will fail if both conditions are true::
- name: Check if a file exists in temp and fail task if it does - name: Check if a file exists in temp and fail task if it does
command: ls /tmp/this_should_not_be_here command: ls /tmp/this_should_not_be_here
register: result register: result
failed_when: failed_when:
- '"No such" not in result.stdout'
- result.rc == 0 - result.rc == 0
- '"No such" not in result.stdout'
If you want the task to fail when only one condition is satisfied, change the ``failed_when`` definition to::
failed_when: result.rc == 0 or "No such" not in result.stdout
.. _override_the_changed_result: .. _override_the_changed_result:
@ -185,5 +187,3 @@ See :ref:`block_error_handling` for more examples.
Have a question? Stop by the google group! Have a question? Stop by the google group!
`irc.freenode.net <http://irc.freenode.net>`_ `irc.freenode.net <http://irc.freenode.net>`_
#ansible IRC chat channel #ansible IRC chat channel