community.general.redis cache – Use Redis DB for cache
Note
This cache plugin is part of the community.general collection (version 9.4.0).
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
.
You need further requirements to be able to use this cache plugin,
see Requirements for details.
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 |
Comments |
---|---|
User defined name for cache keyset name. Default: Configuration:
|
|
User defined prefix to use when creating the DB entries Default: Configuration:
|
|
The redis sentinel service name (or referenced as cluster name). Configuration:
|
|
Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire Default: Configuration:
|
|
A colon separated string of connection information for Redis. The format is To use encryption in transit, prefix the connection with To use redis sentinel, use separator Configuration:
|