Модуль community.general.redis_data — установка пар ключ-значение в Redis

Примечание

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

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

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

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

Добавлен в 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	Путь к файлу закрытого ключа клиента.
existing логическое значение	Устанавливать ключ, только если он уже существует. Варианты: `false` `true`
expiration целое число	Время истечения срока действия в миллисекундах. При установке этого параметра база данных всегда изменяется.
keep_ttl логическое значение	Сохранять время жизни, связанное с ключом. Варианты: `false` `true`
key строка / обязательный	Ключ базы данных.
login_host строка	Укажите целевой узел, на котором работает база данных. По умолчанию: `"localhost"`
login_password строка	Укажите пароль для аутентификации. Обычно не используется, если целевой узел — localhost.
login_port целое число	Укажите порт для подключения. По умолчанию: `6379`
login_user строка	Укажите пользователя для аутентификации. Требуется redis >= 3.4.0.
non_existing логическое значение	Устанавливать ключ, только если он ещё не существует. Варианты: `false` `true`
state строка	Состояние ключа. Варианты: `"present"` ← (по умолчанию) `"absent"`
tls логическое значение	Укажите, следует ли использовать TLS для подключения. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Укажите, следует ли проверять сертификаты TLS. Отключать проверку следует только для сайтов под личным контролем или если в качестве целевого узла используется `localhost`. Варианты: `false` `true` ← (по умолчанию)
value строка	Значение, которое будет присвоено ключу.

Атрибуты

Атрибут	Поддержка	Описание
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_incr: Увеличивает значения ключей в Redis.
community.general.redis_data_info: Получает значение ключа из базы данных Redis.
community.general.redis: Выполняет различные команды Redis, включая команды для реплик и очистки.

Примеры

- name: Set key foo=bar on localhost with no username
  community.general.redis_data:
    login_host: localhost
    login_password: supersecret
    key: foo
    value: bar
    state: present

- name: Set key foo=bar if non existing with expiration of 30s
  community.general.redis_data:
    login_host: localhost
    login_password: supersecret
    key: foo
    value: bar
    non_existing: true
    expiration: 30000
    state: present

- name: Set key foo=bar if existing and keep current TTL
  community.general.redis_data:
    login_host: localhost
    login_password: supersecret
    key: foo
    value: bar
    existing: true
    keep_ttl: true

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

- name: Delete key foo on localhost with no username
  community.general.redis_data:
    login_host: localhost
    login_password: supersecret
    key: foo
    state: absent

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

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

Ключ	Описание
msg строка	Краткое сообщение. Возвращается: всегда Пример: `"Set key: foo to bar"`
old_value строка	Значение ключа до установки. Возвращается: при успешном выполнении, если `state=present` и ключ существует в базе данных. Пример: `"old_value_of_key"`
value строка	Значение, присвоенное ключу. Возвращается: при успешном выполнении, если `state=present`. Пример: `"new_value_of_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_module.html