Модуль community.general.redis_data_incr – Увеличение ключей в Redis

Примечание

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

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

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

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

Новое в community.general 4.0.0

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

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

Увеличивает целочисленные или вещественные ключи в базе данных Redis и получает новое значение.
Увеличение по умолчанию для всех ключей равно 1. Для указания конкретных значений увеличения используйте параметры increment_int и increment_float.

Требования

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

redis
certifi

Параметры

Параметр	Комментарии
ca_certs строка	Путь к файлу корневых сертификатов. Если не задан и `tls` установлен в `true`, будут использоваться сертификаты certifi ca-certificates.
client_cert_file строка добавлено в community.general 9.3.0	Путь к файлу клиентского сертификата.
client_key_file строка добавлено в community.general 9.3.0	Путь к файлу закрытого ключа клиента.
increment_float число с плавающей точкой	Величина увеличения ключа с плавающей точкой. Работает только с ключами, которые содержат значения с плавающей точкой в своём строковом представлении.
increment_int целое число	Величина увеличения ключа (целое число).
key строка / обязательно	Ключ базы данных.
login_host строка	Укажите целевой хост, на котором работает база данных. Значение по умолчанию: `"localhost"`
login_password строка	Укажите пароль для аутентификации. Обычно не используется, когда целевой хост — localhost.
login_port целое число	Укажите порт для подключения. Значение по умолчанию: `6379`
login_user строка	Укажите пользователя для аутентификации. Требуется redis >= 3.4.0.
tls логическое значение	Укажите, использовать ли TLS для подключения. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Укажите, следует ли проверять TLS-сертификаты. Это следует отключать только для лично контролируемых сайтов или с `localhost` в качестве цели. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная Для работы `check_mode` указанному `login_user` необходимы права на выполнение команды `GET` для ключа, иначе модуль завершится с ошибкой. При использовании `check_mode` модуль попытается вычислить значение, которое вернул бы Redis. Если ключ отсутствует, в качестве значения используется 0.0.	Может работать в режиме `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_info: Получение значения ключа в базе данных Redis.
community.general.redis: Различные команды redis, репликация и очистка.

Примеры

- name: Increment integer key foo on localhost with no username and print new value
  community.general.redis_data_incr:
    login_host: localhost
    login_password: supersecret
    key: foo
    increment_int: 1
  register: result
- name: Print new value
  debug:
    var: result.value

- name: Increment float key foo by 20.4
  community.general.redis_data_incr:
    login_host: redishost
    login_user: redisuser
    login_password: somepass
    key: foo
    increment_float: '20.4'

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

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

Ключ	Описание
msg строка	Краткое сообщение. Возвращается: всегда Пример: `"Incremented key: foo by 20.4 to 65.9"`
value вещественное число	Увеличенное значение ключа Возвращается: при успехе Пример: `4039.4`

Авторы

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_incr_module.html