fail - Fail with custom message

Synopsis
Options
Examples
This is a Core Module

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.

Options

parameter	required	default	choices	comments
msg	no	'Failed as requested from task'		The customized message used for failing execution. If omitted, fail will simple 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"

This is a Core Module

For more information on what this means please read Core Modules

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