community.general.pickle – Pickle formatted files.

Note

This plugin is part of the community.general collection (version 4.2.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.pickle.

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
_prefix
string
ini entries:

[defaults]
fact_caching_prefix = None

env:ANSIBLE_CACHE_PLUGIN_PREFIX
User defined prefix to use when creating the files
_timeout
string
Default:
86400
ini entries:

[defaults]
fact_caching_timeout = 86400

env:ANSIBLE_CACHE_PLUGIN_TIMEOUT
Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
_uri
string / required
ini entries:

[defaults]
fact_caching_connection = None

env:ANSIBLE_CACHE_PLUGIN_CONNECTION
Path in which the cache plugin will save the files

Authors

  • Brian Coca (@bcoca)