community.general.pickle cache – Pickle formatted files.

Note

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

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:

  • INI entry:

    [defaults]
fact_caching_prefix = None

  • Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX

_timeout

string

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

Default: 86400

Configuration:

  • INI entry:

    [defaults]
fact_caching_timeout = 86400

  • Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT

_uri

string / required

Path in which the cache plugin will save the files

Configuration:

  • INI entry:

    [defaults]
fact_caching_connection = None

  • Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION

Authors

  • Brian Coca (@bcoca)

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.