diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2022-09-07 09:49:23 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-07 09:49:23 -0400 |
| commit | 77ba025a1301c62dd945fd0f18153c5eef9a0b77 (patch) | |
| tree | 9eb2c05ede7cac81658d2724279935bf62acf866 /lib/ansible/plugins/test/all.yml | |
| parent | fcfdca8e7d2875f81d441a24d7b53ec12a04b4de (diff) | |
| download | ansible-77ba025a1301c62dd945fd0f18153c5eef9a0b77.tar.gz | |
document tests (#78685)
Document the builtin test plugins
Co-authored-by: Felix Fontein <felix@fontein.de>
Diffstat (limited to 'lib/ansible/plugins/test/all.yml')
| -rw-r--r-- | lib/ansible/plugins/test/all.yml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/all.yml b/lib/ansible/plugins/test/all.yml new file mode 100644 index 0000000000..e227d6e422 --- /dev/null +++ b/lib/ansible/plugins/test/all.yml @@ -0,0 +1,23 @@ +DOCUMENTATION: + name: all + author: Ansible Core + version_added: "2.4" + short_description: are all conditions in a list true + description: + - This test checks each condition in a list for truthiness. + - Same as the C(all) Python function. + options: + _input: + description: List of conditions, each can be a boolean or conditional expression that results in a boolean value. + type: list + elements: raw + required: True +EXAMPLES: | + varexpression: "{{ 3 == 3 }}" + # are all statements true? + {{ [true, booleanvar, varexpression] is all }} + +RETURN: + _value: + description: Returns C(True) if all elements of the list were True, C(False) otherwise. + type: boolean |