mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Merge pull request #3480 from j2sol/fail_doc
Update fail docs for new syntax
This commit is contained in:
commit
d6d9e804d3
1 changed files with 3 additions and 3 deletions
|
@ -24,7 +24,7 @@ module: fail
|
||||||
short_description: Fail with custom message
|
short_description: Fail with custom message
|
||||||
description:
|
description:
|
||||||
- This module fails the progress with a custom message. It can be
|
- This module fails the progress with a custom message. It can be
|
||||||
useful for bailing out when a certain condition is met using C(only_if).
|
useful for bailing out when a certain condition is met using C(when).
|
||||||
version_added: "0.8"
|
version_added: "0.8"
|
||||||
options:
|
options:
|
||||||
msg:
|
msg:
|
||||||
|
@ -38,7 +38,7 @@ author: Dag Wieers
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# Example playbook using fail and only_if together
|
# Example playbook using fail and when together
|
||||||
- fail: msg="The system may not be provisioned according to the CMDB status."
|
- fail: msg="The system may not be provisioned according to the CMDB status."
|
||||||
only_if: "'$cmdb_status' != 'to-be-staged'"
|
when: "{{ cmdb_status }} != 'to-be-staged'"
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue