community.general.shelvefile lookup – read keys from Python shelve file
Note
This lookup plugin is part of the community.general collection (version 5.0.2).
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
.
Synopsis
Read keys from Python shelve file.
Parameters
Parameter |
Comments |
---|---|
sets of key value pairs of parameters |
|
path to shelve file |
|
key to query |
Examples
- 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') }}
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key |
Description |
---|---|
value(s) of key(s) in shelve file(s) Returned: success |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication