wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3480 from j2sol/fail_doc

Browse source 
Update fail docs for new syntax
This commit is contained in:
Michael DeHaan 2013-07-11 05:22:47 -07:00
commit d6d9e804d3
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
library/utilities/fail
View file

@ -24,7 +24,7 @@ module: fail
short_description: Fail with custom message
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(only_if).
useful for bailing out when a certain condition is met using C(when).
version_added: "0.8"
options:
msg:
@ -38,7 +38,7 @@ author: Dag Wieers
'''
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."
only_if: "'$cmdb_status' != 'to-be-staged'"
when: "{{ cmdb_status }} != 'to-be-staged'"
'''