ansible / ansible.builtin / v2.9.27 / module / fail Fail with custom message | "added in version" 0.8 of ansible.builtin" Authors: Dag Wieers (@dagwieers) stableinterface | supported by coreansible.builtin.fail (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
This module fails the progress with a custom message.
It can be useful for bailing out when a certain condition is met using C(when).
This module is also supported for Windows targets.
# Example playbook using fail and when together - fail: msg: The system may not be provisioned according to the CMDB status. when: cmdb_status != "to-be-staged"
msg: default: Failed as requested from task description: - The customized message used for failing execution. - If omitted, fail will simply bail out with a generic message. type: str