community.general.redis lookup — получение данных из Redis
Примечание
Этот lookup-плагин входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для работы с этим lookup-плагином могут потребоваться дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: community.general.redis.
- Краткое описание
- Требования
- Аргументы
- Именованные параметры
- Примечания
- Примеры
- Возвращаемое значение
Краткое описание
- Этот lookup возвращает список результатов из базы данных Redis, соответствующих переданному ему списку элементов.
Требования
Перечисленные ниже компоненты должны быть установлены на локальном управляющем узле, выполняющем этот lookup.
- redis (библиотека Python https://github.com/andymccurdy/redis-py/)
Аргументы
Параметр | Описание |
|---|---|
Аргументы список / элементы=строка | Список ключей для запроса. |
Именованные параметры
Здесь описаны именованные параметры lookup. В следующих примерах это значения key1=value1, key2=value2 и так далее: lookup('community.general.redis', key1=value1, key2=value2, ...) и query('community.general.redis', key1=value1, key2=value2, ...)
Параметр | Описание |
|---|---|
host строка | Адрес узла Redis. По умолчанию: Конфигурация:
|
port целое число | Порт, на котором Redis ожидает подключения. По умолчанию: Конфигурация:
|
socket путь | Путь к сокету для запроса к Redis. Если этот параметр задан, он имеет приоритет над параметрами host и port. Конфигурация:
|
Примечание
Указанные выше записи конфигурации для каждого типа записи (переменная Ansible, переменная окружения и так далее) перечислены в порядке от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).
Примечания
Примечание
- Если именованные и позиционные параметры используются вместе, позиционные параметры необходимо указывать перед именованными:
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. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_lookup.html
