From 64fb4f4c9383af3355313c96c87cd20cfab95315 Mon Sep 17 00:00:00 2001 From: Jesse Keating Date: Mon, 8 Jul 2013 14:22:05 -0700 Subject: [PATCH] Update fail docs for new syntax Use when instead of only_if Use new variable style --- utilities/fail | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utilities/fail b/utilities/fail index e9c072f2c75..7023f357cac 100644 --- a/utilities/fail +++ b/utilities/fail @@ -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'" '''