cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #1231 from dagwieers/fail-doc-fix

Browse source 
This hopefully fixes the documentation for the fail module
This commit is contained in:
Michael DeHaan 2012-10-04 16:18:10 -07:00
parent adfc4d6f59 3d5c4df2ac
commit 5d7ab8a300
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
library/fail
View file

@ -32,7 +32,7 @@ options:
- The customized message used for failing execution. If ommited,
fail will simple bail out with a generic message.
required: false
default: "Failed because only_if condition is true"
default: "'Failed because only_if condition is true'"
rc:
description:
- The return code of the failure. This is currently not used by
@ -40,10 +40,11 @@ options:
required: false
default: 1
examples:
- code:
- action: fail msg="The system may not be provisioned according to the CMDB status."
only_if: "'$cmdb_status' != 'to-be-staged'"
description: "Example of how a playbook may fail when a condition is not met"
- code: |
action: fail msg="The system may not be provisioned according to the CMDB status." rc=100
only_if: "'$cmdb_status' != 'to-be-staged'"
description: "Example playbook using fail and only_if together"
author: Dag Wieers
'''