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

Примечание

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

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

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

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

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогнозируемый измененный статус, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	Возвращает подробности о том, что изменилось (или, возможно, что должно измениться в `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/redis_data_module.html