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

Install Ansible via pip

Install with pip install ansible-core==2.16.5

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.

- name: Example using fail and when together
  ansible.builtin.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.
    type: str

See also

• ansible.builtin.assert
• ansible.builtin.debug
• ansible.builtin.meta