This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using when.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| msg | no | 'Failed as requested from task' | The customized message used for failing execution. If omitted, fail will simple bail out with a generic message. |
# 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"
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/fail_module.html