ansible.builtin.fail (v2.6.20) — module

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using C(when).

This module is also supported for Windows targets.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
msg:
    default: '''Failed as requested from task'''
    description:
    - The customized message used for failing execution. If omitted, fail will simply
      bail out with a generic message.
    required: false