fail
Collection: builtin
Full Name: fail
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Stop the play on this host with a custom message
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| msg | string | Failed as requested from task | The customized message used for failing execution |
Example
- name: Refuse to run on an unsupported platform
fail:
msg: "This role supports Debian only, not {{ ansible_os_family }}"