fail - Fail with custom message

• Synopsis
• Parameters
• Notes
• Examples
• Status
  • Support
  • Author

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

Notes

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

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

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

• Dag Wieers (@dagwieers)