community.general.yaml cache – YAML formatted files

Note

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

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

Synopsis
Parameters

Synopsis

This cache uses YAML formatted, 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 = VALUE Environment variable: `ANSIBLE_CACHE_PLUGIN_PREFIX`
_timeout integer	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 saves the files. Configuration: INI entry: [defaults] fact_caching_connection = VALUE Environment variable: `ANSIBLE_CACHE_PLUGIN_CONNECTION`

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)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/yaml_cache.html