summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/falsy.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/test/falsy.yml')
-rw-r--r--lib/ansible/plugins/test/falsy.yml24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/falsy.yml b/lib/ansible/plugins/test/falsy.yml
new file mode 100644
index 0000000..49a198f
--- /dev/null
+++ b/lib/ansible/plugins/test/falsy.yml
@@ -0,0 +1,24 @@
+DOCUMENTATION:
+ name: falsy
+ author: Ansible Core
+ version_added: "2.10"
+ short_description: Pythonic false
+ description:
+ - This check is a more Python version of what is 'false'.
+ - It is the opposite of 'truthy'.
+ options:
+ _input:
+ description: An expression that can be expressed in a boolean context.
+ type: string
+ required: True
+ convert_bool:
+ description: Attempts to convert the result to a strict Python boolean vs normally acceptable values (C(yes)/C(no), C(on)/C(off), C(0)/C(1), etc).
+ type: bool
+ default: false
+EXAMPLES: |
+ thisisfalse: '{{ "any string" is falsy }}'
+ thisistrue: '{{ "" is falsy }}'
+RETURN:
+ _value:
+ description: Returns C(False) if the condition is not "Python truthy", C(True) otherwise.
+ type: boolean