This hopefully fixes the documentation for the fail module

This commit is contained in:
Dag Wieers 2012-10-04 20:58:07 +02:00
parent 184523ecac
commit 3d5c4df2ac

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."
- 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 of how a playbook may fail when a condition is not met"
description: "Example playbook using fail and only_if together"
author: Dag Wieers
'''