community.general.redis – Use Redis DB for cache

From Get docs
Ansible/docs/2.11/collections/community/general/redis cache


community.general.redis – Use Redis DB for cache

Note

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

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.redis.


Synopsis

  • This cache uses JSON formatted, per host records saved in Redis.

Requirements

The below requirements are needed on the local controller node that executes this cache.

  • redis>=2.4.5 (python lib)

Parameters

Parameter Choices/Defaults Configuration Comments

_keyset_name

string

added in 1.3.0 of community.general

Default:

"ansible_cache_keys"

ini entries: [defaults]fact_caching_redis_keyset_name = ansible_cache_keys


env:ANSIBLE_CACHE_REDIS_KEYSET_NAME

User defined name for cache keyset name.

_prefix

string

Default:

"ansible_facts"

ini entries: [defaults]fact_caching_prefix = ansible_facts


env:ANSIBLE_CACHE_PLUGIN_PREFIX

User defined prefix to use when creating the DB entries

_sentinel_service_name

string

added in 1.3.0 of community.general

ini entries: [defaults]fact_caching_redis_sentinel = None


env:ANSIBLE_CACHE_REDIS_SENTINEL

The redis sentinel service name (or referenced as cluster name).

_timeout

integer

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

A colon separated string of connection information for Redis.

The format is host:port:db:password, for example localhost:6379:0:changeme.

To use encryption in transit, prefix the connection with tls://, as in tls://localhost:6379:0:changeme.

To use redis sentinel, use separator ;, for example localhost:26379;localhost:26379;0:changeme. Requires redis>=2.9.0.



Authors

  • Unknown (!UNKNOWN)

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