Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

This hopefully fixes the documentation for the fail module #1231

Merged
merged 1 commit into from
Oct 4, 2012
Merged

This hopefully fixes the documentation for the fail module #1231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions library/fail
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,19 @@ 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
Ansible, but might be used in the future.
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
'''

Expand Down