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

Note

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

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.

Terms

Parameter

Comments

Terms

string

Sets of key value pairs of parameters.

Keyword 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

string / required

Path to shelve file.

key

string / required

Key to query.

Notes

Note

  • When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters: lookup('community.general.shelvefile', term1, term2, key1=value1, key2=value2) and query('community.general.shelvefile', term1, term2, key1=value1, key2=value2)

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 Value

Key

Description

Return value

list / elements=string

Value(s) of key(s) in shelve file(s).

Returned: success

Authors

  • Alejandro Guirao

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.