centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

Improve failed_when documentation and fix minor errors (#3249)

Browse Source 
* Improve failed_when documentation and fix minor errors

- Add clarifying example for 'or' operator in failed_when conditions
- Fix template syntax: remove extra space in Jinja2 braces

Signed-off-by: Piyush Malik <piyush.malik@optimoloan.com>

* Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Signed-off-by: Piyush Malik <piyush.malik@optimoloan.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Piyush Malik
2025-12-04 02:53:15 +05:30
committed by GitHub
parent 86f9d4351e
commit 7cefbd2a0c
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docsite/rst/playbook_guide/playbooks_error_handling.rst
View File

@@ -61,8 +61,7 @@ And at the playbook level:
Resetting unreachable hosts
===========================
If Ansible cannot connect to a host, it marks that host as 'UNREACHABLE' and removes it from the list of active hosts for the run. You can use `meta: clear_host_errors` to reactivate all hosts, so subsequent tasks can try to reach them again.
If Ansible cannot connect to a host, it marks that host as 'UNREACHABLE' and removes it from the list of active hosts for the run. You can use ``meta: clear_host_errors`` to reactivate all hosts, so subsequent tasks can try to reach them again.
.. _handlers_and_failure:
@@ -87,7 +86,16 @@ the handler from running, such as a host becoming unreachable.)
Defining failure
================
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.
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 single string with an explicit ``or`` operator.
For example, to fail when either of two conditions is true:
.. code-block:: yaml
- name: Fail task when either condition is met
ansible.builtin.command: /usr/bin/example-command
register: command_result
failed_when: command_result.rc != 0 or 'ERROR' in command_result.stdout
You may check for failure by searching for a word or phrase in the output of a command
@@ -184,7 +192,7 @@ You can reference simple variables in conditionals to avoid repeating certain te
tasks:
- name: Create empty log file
ansible.builtin.shell: mkdir {{ log_path }} || touch {{log_path }}{{ log_file }}
ansible.builtin.shell: mkdir {{ log_path }} || touch {{ log_path }}{{ log_file }}
register: tmp
changed_when:
- tmp.rc == 0