Note
This lookup plugin is part of the community.general collection (version 10.7.3).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.shelvefile.
Parameter | Comments |
|---|---|
Terms list / elements=string | Sets of key value pairs of parameters. |
This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('community.general.shelvefile', key1=value1, key2=value2, ...) and query('community.general.shelvefile', key1=value1, key2=value2, ...)
Parameter | Comments |
|---|---|
file path / required | Path to shelve file. |
key string / required | Key to query. |
Note
lookup('community.general.shelvefile', term1, term2, key1=value1, key2=value2) and query('community.general.shelvefile', term1, term2, key1=value1, key2=value2)
---
- name: Retrieve a string value corresponding to a key inside a Python shelve file
ansible.builtin.debug:
msg: "{{ lookup('community.general.shelvefile', 'file=path_to_some_shelve_file.db key=key_to_retrieve') }}"
Key | Description |
|---|---|
Return value list / elements=string | Value(s) of key(s) in shelve file(s). Returned: success |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/shelvefile_lookup.html