Note
This module is part of ansible-core
and included in all Ansible installations. In most cases, you can use the short module name fail
even without specifying the collections:
keyword. However, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.
New in version 0.8: of ansible.builtin
when
.Note
This module has a corresponding action plugin.
Parameter | Choices/Defaults | Comments |
---|---|---|
msg string | Default: "Failed as requested from task" | The customized message used for failing execution. If omitted, fail will simply bail out with a generic message. |
Note
See also
The official documentation on the ansible.builtin.assert module.
The official documentation on the ansible.builtin.debug module.
The official documentation on the ansible.builtin.meta module.
- name: Example using fail and when together fail: msg: The system may not be provisioned according to the CMDB status. when: cmdb_status != "to-be-staged"
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/fail_module.html