Cache Plugins — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# Cache Plugins

- Enabling Fact Cache Plugins
- Enabling Inventory Cache Plugins
- Using Cache Plugins
- Plugin List

Cache plugin implement a backend caching mechanism that allows 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.

You can use a separate cache plugin for inventory and facts. If an inventory-specific cache plugin is not provided and inventory caching is enabled, the fact cache plugin is used for inventory.

## Enabling Fact Cache Plugins

Only one fact cache plugin can be active at a time.

You can enable a cache plugin in the Ansible configuration, either via environment variable:

    export ANSIBLE_CACHE_PLUGIN=jsonfile

or in the `ansible.cfg` file:

    [defaults]
    fact_caching=redis

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

A custom cache plugin is enabled by dropping it into a `cache_plugins` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in ansible.cfg.

## Enabling Inventory Cache Plugins

Inventory may be cached using a file-based cache plugin (like jsonfile). Check the specific inventory plugin to see if it supports caching. If an inventory-specific cache plugin is not specified Ansible will fall back to caching inventory with the fact cache plugin options.

The inventory cache is disabled by default. You may enable it via 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

Similarly with fact cache plugins, only one inventory cache plugin can be active at a time and may be set via 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

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.

- jsonfile – JSON formatted files
- memcached – Use memcached DB for cache
- memory – RAM backed, non persistent
- mongodb – Use MongoDB for caching
- pickle – Pickle formatted files
- redis – Use Redis DB for cache
- yaml – YAML formatted files

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