when
.Parameter | Choices/Defaults | Comments |
---|---|---|
msg | 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
# 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"
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Core Team, see here.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/fail_module.html