ansible.builtin.fail – Fail with custom message
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
fail
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 0.8: of ansible.builtin
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.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
The customized message used for failing execution. If omitted, fail will simply bail out with a generic message. Default: “Failed as requested from task” |
See Also
See also
- ansible.builtin.assert
The official documentation on the ansible.builtin.assert module.
- ansible.builtin.debug
The official documentation on the ansible.builtin.debug module.
- ansible.builtin.meta
The official documentation on the ansible.builtin.meta module.