community.general.redis lookup – получение данных из Redis

Примечание

Этот плагин поиска входит в состав коллекции community.general (версия 9.5.0).

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

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

Для использования в книге задач укажите: community.general.redis.

Обзор
Требования
Термины
Параметры ключевых слов
Примечания
Примеры
Значение возврата

Обзор

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

Требования

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

redis (библиотека python https://github.com/andymccurdy/redis-py/)

Термины

Параметр	Комментарии
Термины список / элементы=строка	список ключей для запроса

Параметры ключевых слов

Это описание параметров ключевых слов поиска. Это значения key1=value1, key2=value2 и т. д. в следующих примерах: lookup('community.general.redis', key1=value1, key2=value2, ...) и query('community.general.redis', key1=value1, key2=value2, ...)

Параметр	Комментарии
host строка	местоположение хоста Redis По умолчанию: `"127.0.0.1"` Настройка: Запись в INI: [lookup_redis] host = 127.0.0.1 Переменная среды: `ANSIBLE_REDIS_HOST`
port целое число	порт, на котором Redis слушает По умолчанию: `6379` Настройка: Запись в INI: [lookup_redis] port = 6379 Переменная среды: `ANSIBLE_REDIS_PORT`
socket путь	путь к сокету для запроса Redis, этот параметр переопределяет параметры host и port при установке. Настройка: Запись в INI: [lookup_redis] socket = VALUE Переменная среды: `ANSIBLE_REDIS_SOCKET`

Примечания

Примечание

Когда параметры ключевых слов и позиционные параметры используются вместе, позиционные параметры должны быть перечислены перед параметрами ключевых слов: lookup('community.general.redis', term1, term2, key1=value1, key2=value2) и query('community.general.redis', term1, term2, key1=value1, key2=value2)

Примеры

- name: query redis for somekey (default or configured settings used)
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.redis', 'somekey') }}"

- name: query redis for list of keys and non-default host and port
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.redis', item, host='myredis.internal.com', port=2121) }}"
  loop: '{{list_of_redis_keys}}'

- name: use list directly
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.redis', 'key1', 'key2', 'key3') }}"

- name: use list directly with a socket
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.redis', 'key1', 'key2', socket='/var/tmp/redis.sock') }}"

Значение возврата

Ключ	Описание
Возвращаемое значение список / элементы=строка	сохранённое(ые) в Redis значение(я) Возвращено: успех

Авторы

Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
Команда Ansible Core

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета снизу вверх. Например, переменная, которая расположена ниже в списке, переопределит переменную, которая расположена выше.

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

© 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_lookup.html