Documentation

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.

Parameters

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.

Notes

Note

  • This module is also supported for Windows targets.

See Also

See also

assert – Asserts given expressions are true
The official documentation on the assert module.
debug – Print statements during execution
The official documentation on the debug module.
meta – Execute Ansible ‘actions’
The official documentation on the meta module.

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"

Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation you can edit this document to improve it.