W3cubDocs

/Ansible

fail - Fail with custom message

Synopsis

  • This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using when.
  • This module is also supported for Windows targets.

Options

parameter required default choices comments
msg
 no 'Failed as requested from task'
The customized message used for failing execution. If omitted, fail will simply bail out with a generic message.

Examples

# 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"

Notes

Note

  • This module is also supported for Windows targets.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/fail_module.html