Cache Plugins

Cache plugins allow Ansible to store gathered facts or inventory source data without the performance hit of retrieving them from source.

The default cache plugin is the memory plugin, which only caches the data for the current execution of Ansible. Other plugins with persistent storage are available to allow caching the data across runs. Some of these cache plugins write to files, others write to databases.

You can use different cache plugins for inventory and facts. If you enable inventory caching without setting an inventory-specific cache plugin, Ansible uses the fact cache plugin for both facts and inventory.

Enabling Fact Cache Plugins

Fact caching is always enabled. However, only one fact cache plugin can be active at a time. You can select the cache plugin to use for fact caching in the Ansible configuration, either with an environment variable:

export ANSIBLE_CACHE_PLUGIN=jsonfile

or in the ansible.cfg file:

[defaults]
fact_caching=redis

If the cache plugin is in a collection use the fully qualified name:

[defaults]
fact_caching = namespace.collection_name.cache_plugin_name

To enable a custom cache plugin, save it in a cache_plugins directory adjacent to your play, inside a role, or in one of the directory sources configured in ansible.cfg.

You also need to configure other settings specific to each plugin. Consult the individual plugin documentation or the Ansible configuration for more details.

Enabling Inventory Cache Plugins

Inventory caching is disabled by default. To cache inventory data, you must enable inventory caching and then select the specific cache plugin you want to use. Not all inventory plugins support caching, so check the documentation for the inventory plugin(s) you want to use. You can enable inventory caching with an environment variable:

export ANSIBLE_INVENTORY_CACHE=True

or in the ansible.cfg file:

[inventory]
cache=True

or if the inventory plugin accepts a YAML configuration source, in the configuration file:

# dev.aws_ec2.yaml
plugin: aws_ec2
cache: True

Only one inventory cache plugin can be active at a time. You can set it with an environment variable:

export ANSIBLE_INVENTORY_CACHE_PLUGIN=jsonfile

or in the ansible.cfg file:

[inventory]
cache_plugin=jsonfile

or if the inventory plugin accepts a YAML configuration source, in the configuration file:

# dev.aws_ec2.yaml
plugin: aws_ec2
cache_plugin: jsonfile

To cache inventory with a custom plugin in your plugin path, follow the developer guide on cache plugins.

You can use any cache plugin shipped with Ansible to cache inventory, but you cannot use a cache plugin inside a collection. If you enable caching for inventory plugins without selecting an inventory-specific cache plugin, Ansible falls back to caching inventory with the fact cache plugin you configured. Consult the individual inventory plugin documentation or the Ansible configuration for more details.

Using Cache Plugins

Cache plugins are used automatically once they are enabled.

Plugin List

You can use ansible-doc -t cache -l to see the list of available plugins. Use ansible-doc -t cache <plugin name> to see specific documentation and examples.

See also

Action Plugins
Ansible Action plugins
Callback Plugins
Ansible callback plugins
Connection Plugins
Ansible connection plugins
Inventory Plugins
Ansible inventory plugins
Shell Plugins
Ansible Shell plugins
Strategy Plugins
Ansible Strategy plugins
Vars Plugins
Ansible Vars plugins
User Mailing List
Have a question? Stop by the google group!
webchat.freenode.net
#ansible IRC chat channel