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

Примечание

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

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

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

Для использования в playbook укажите: community.general.redis_data_info.

Новое в community.general 3.7.0

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

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

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

Требования

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

redis
certifi

Параметры

Параметр	Комментарии
ca_certs string	Путь к файлу корневых сертификатов. Если не задан и `tls` установлен в `true`, будут использоваться сертификаты certifi ca-certificates.
client_cert_file string добавлено в community.general 9.3.0	Путь к файлу клиентского сертификата.
client_key_file string добавлено в community.general 9.3.0	Путь к файлу закрытого ключа клиента.
key string / обязательно	Ключ базы данных.
login_host string	Укажите целевой хост, на котором запущена база данных. По умолчанию: `"localhost"`
login_password string	Укажите пароль для аутентификации. Обычно не используется, когда целевой объект — localhost.
login_port integer	Укажите порт для подключения. По умолчанию: `6379`
login_user string	Укажите пользователя для аутентификации. Требуется redis >= 3.4.0.
tls boolean	Укажите, использовать ли TLS для подключения. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Укажите, следует ли проверять 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 boolean	Если ключ существует в базе данных. Возвращается: при успехе
msg string	Краткое сообщение. Возвращается: всегда Пример: `"Got key: foo with value: bar"`
value string	Значение, которому был установлен ключ. Возвращается: если существует Пример: `"value_of_some_key"`

Авторы

Andreas Botzner (@paginabianca)

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

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