community.general.pickle cache – Pickle formatted files

Note

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

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.pickle.

Synopsis

  • This cache uses Python’s pickle serialization format, in per host files, saved to the filesystem.

Parameters

Parameter

Comments

_prefix

string

User defined prefix to use when creating the files.

Configuration:

_timeout

float

Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.

Default: 86400.0

Configuration:

_uri

path / required

Path in which the cache plugin will save the files.

Configuration:

Note

Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) 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. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).

Authors

  • Brian Coca (@bcoca)