Commit 5d7ab8a3 by Michael DeHaan

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

This hopefully fixes the documentation for the fail module
parents adfc4d6f 3d5c4df2
...@@ -32,7 +32,7 @@ options: ...@@ -32,7 +32,7 @@ options:
- The customized message used for failing execution. If ommited, - The customized message used for failing execution. If ommited,
fail will simple bail out with a generic message. fail will simple bail out with a generic message.
required: false required: false
default: "Failed because only_if condition is true" default: "'Failed because only_if condition is true'"
rc: rc:
description: description:
- The return code of the failure. This is currently not used by - The return code of the failure. This is currently not used by
...@@ -40,10 +40,11 @@ options: ...@@ -40,10 +40,11 @@ options:
required: false required: false
default: 1 default: 1
examples: examples:
- code: - code: |
- action: fail msg="The system may not be provisioned according to the CMDB status." action: fail msg="The system may not be provisioned according to the CMDB status." rc=100
only_if: "'$cmdb_status' != 'to-be-staged'" only_if: "'$cmdb_status' != 'to-be-staged'"
description: "Example of how a playbook may fail when a condition is not met" description: "Example playbook using fail and only_if together"
author: Dag Wieers author: Dag Wieers
''' '''
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment