You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.redis_data_info module – Get value of key in Redis database

Note

This module is part of the community.general collection (version 4.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.

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

New in version 3.7.0: of community.general

Synopsis

• Get value of keys in Redis database.

Requirements

The below requirements are needed on the host that executes this module.

• redis

• certifi

Parameters

Parameter	Comments
ca_certs string	Path to root certificates file. If not set and tls is set to true, certifi ca-certificates will be used.
key string / required	Database key.
login_host string	Specify the target host running the database. Default: “localhost”
login_password string	Specify the password to authenticate with. Usually not used when target is localhost.
login_port integer	Specify the port to connect to. Default: 6379
login_user string	Specify the user to authenticate with. Requires redis >= 3.4.0.
tls boolean	Specify whether or not to use TLS for the connection. Choices: no yes ← (default)
validate_certs boolean	Specify whether or not to validate TLS certificates. This should only be turned off for personally controlled sites or with localhost as target. Choices: no yes ← (default)

Notes

Note

• Requires the redis Python package on the remote host. You can install it with pip (pip install redis) or with a package manager. Information on the library can be found at https://github.com/andymccurdy/redis-py.

See Also

See also

community.general.redis_data

The official documentation on the community.general.redis_data module.

community.general.redis_data_incr

The official documentation on the community.general.redis_data_incr module.

community.general.redis_info

The official documentation on the community.general.redis_info module.

community.general.redis

The official documentation on the community.general.redis module.

Examples

- name: Get key foo=bar from loalhost with no username
  community.general.redis_data_info:
    login_host: localhost
    login_password: supersecret
    key: foo

- name: Get key foo=bar on redishost with custom ca-cert file
  community.general.redis_data_info:
    login_host: redishost
    login_password: supersecret
    login_user: somuser
    validate_certs: true
    ssl_ca_certs: /path/to/ca/certs
    key: foo

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
exists boolean	If they key exists in the database. Returned: on success
msg string	A short message. Returned: always Sample: “Got key: foo with value: bar”
value string	Value key was set to. Returned: if existing Sample: “value_of_some_key”

Authors

• Andreas Botzner (@paginabianca)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication