fail - Fail with custom message¶

Synopsis
Parameters
Notes
Examples
Status
Maintenance
- 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 ¶

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.

Notes ¶

Note

This module is also supported for Windows targets.

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.

Maintenance ¶

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.

Support ¶

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

Author ¶

Dag Wieers (@dagwieers)

Hint

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