Модуль community.general.redis_data_incr — увеличение значений ключей в Redis

Примечание

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

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

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

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

Добавлено в community.general 4.0.0

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

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

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

Требования

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

redis
certifi

Параметры

Параметр	Комментарии
ca_certs string	Путь к файлу корневых сертификатов. Если параметр не задан, а `tls` имеет значение `true`, используются сертификаты CA из certifi.
client_cert_file string добавлено в community.general 9.3.0	Путь к файлу сертификата клиента.
client_key_file string добавлено в community.general 9.3.0	Путь к файлу закрытого ключа клиента.
increment_float float	Величина с плавающей запятой, на которую нужно увеличить значение ключа. Работает только с ключами, строковое представление значений которых содержит числа с плавающей запятой.
increment_int integer	Целое число, на которое нужно увеличить значение ключа.
key string / обязательный	Ключ базы данных.
login_host string	Укажите целевой узел, на котором запущена база данных. По умолчанию: `"localhost"`
login_password string	Укажите пароль для аутентификации. Обычно не используется, если целевой узел — localhost.
login_port integer	Укажите порт для подключения. По умолчанию: `6379`
login_user string	Укажите пользователя для аутентификации. Требуется пакет redis версии >= 3.4.0.
tls boolean	Укажите, следует ли использовать TLS для подключения. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Укажите, следует ли проверять сертификаты 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 string	Краткое сообщение. Возвращается: всегда Пример: `"Incremented key: foo by 20.4 to 65.9"`
value float	Увеличенное значение ключа. Возвращается: при успешном выполнении Пример: `4039.4`

Авторы

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