Модуль community.general.redis_data_info — получение значения ключа в базе данных Redis

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.redis_data_info.

Добавлено в community.general 3.7.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Получение значений ключей в базе данных Redis.

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

redis
certifi

Параметры

Параметр	Комментарии
ca_certs строка	Путь к файлу корневых сертификатов. Если параметр `tls` не задан, а `true` установлен, используются сертификаты CA из certifi.
client_cert_file строка добавлено в community.general 9.3.0	Путь к файлу сертификата клиента.
client_key_file строка добавлено в community.general 9.3.0	Путь к файлу закрытого ключа клиента.
key строка / обязательный	Ключ базы данных.
login_host строка	Укажите целевой узел, на котором запущена база данных. По умолчанию: `"localhost"`
login_password строка	Укажите пароль для аутентификации. Обычно не используется, если целевой узел — localhost.
login_port целое число	Укажите порт для подключения. По умолчанию: `6379`
login_user строка	Укажите пользователя для аутентификации. Требуется redis версии 3.4.0 или выше.
tls логическое значение	Укажите, следует ли использовать TLS для подключения. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Укажите, следует ли проверять сертификаты TLS. Отключайте проверку только для сайтов под вашим контролем или если целевой узел — `localhost`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать предполагаемый статус изменений, не изменяя целевой узел.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

На удаленном узле требуется пакет Python redis. Его можно установить с помощью pip (pip install redis) или менеджера пакетов. Сведения о библиотеке доступны по адресу https://github.com/andymccurdy/redis-py.

См. также

community.general.redis_data: Задание пар ключ-значение в Redis.
community.general.redis_data_incr: Увеличение значений ключей в Redis.
community.general.redis_info: Сбор информации о серверах Redis.
community.general.redis: Различные команды Redis, управление репликами и очистка.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
exists логическое значение	Существует ли ключ в базе данных. Возвращается: при успешном выполнении
msg строка	Краткое сообщение. Возвращается: всегда Пример: `"Got key: foo with value: bar"`
value строка	Значение, заданное для ключа. Возвращается: если ключ существует Пример: `"value_of_some_key"`

Авторы

Andreas Botzner (@paginabianca)

Ссылки на коллекцию

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