cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

subelements: Clarify parameter docs (#71177)

Browse source 
skip_missing parameter in subelements lookup plugin is accepted from
inside the dictionary.

Fixes: #38182

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2020-08-18 21:33:28 +05:30 committed by GitHub
parent 88bfc7977d
commit 6d17736ef4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/38182_subelements.yml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- subelements - clarify the lookup plugin documentation for parameter handling (https://github.com/ansible/ansible/issues/38182).

7
lib/ansible/plugins/lookup/subelements.py
View file

@ -18,8 +18,9 @@ DOCUMENTATION = """
skip_missing: skip_missing:
default: False default: False
description: description:
- If set to True, the lookup plugin will skip the lists items that do not contain the given subkey. - Lookup accepts this flag from a dictionary as optional. See Example section for more information.
If False, the plugin will yield an error and complain about the missing subkey. - If set to C(True), the lookup plugin will skip the lists items that do not contain the given subkey.
- If set to C(False), the plugin will yield an error and complain about the missing subkey.
""" """
EXAMPLES = """ EXAMPLES = """
@ -74,7 +75,7 @@ EXAMPLES = """
- name: list groups for users that have them, don't error if groups key is missing - name: list groups for users that have them, don't error if groups key is missing
debug: var=item debug: var=item
loop: "{{lookup('subelements', users, 'groups', {'skip_missing': True})}}" loop: "{{ q('subelements', users, 'groups', {'skip_missing': True}) }}"
""" """
RETURN = """ RETURN = """