community.general.redis_info module – Gather information about Redis servers
Note
This module is part of the community.general collection (version 5.8.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.redis_info
.
New in community.general 0.2.0
Synopsis
Gathers information and statistics about Redis servers.
Requirements
The below requirements are needed on the host that executes this module.
redis
Parameters
Parameter |
Comments |
---|---|
The host running the database. Default: |
|
The password used to authenticate with, when authentication is enabled for the Redis server. |
|
The port to connect to. Default: |
Notes
Note
Requires the redis-py Python package on the remote host. You can install it with pip (
pip install redis
) or with a package manager. https://github.com/andymccurdy/redis-py
See Also
See also
- community.general.redis
Various redis commands, replica and flush.
Examples
- name: Get server information
community.general.redis_info:
register: result
- name: Print server information
ansible.builtin.debug:
var: result.info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The default set of server information sections https://redis.io/commands/info. Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication