community.general.shelvefile – read keys from Python shelve file

Note

This plugin is part of the community.general collection (version 3.7.0).

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 Choices/Defaults Configuration Comments
_terms
string
sets of key value pairs of parameters
file
string / required
path to shelve file
key
string / required
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 Returned Description
_list
list / elements=string
success
value(s) of key(s) in shelve file(s)


Authors