Модуль community.general.influxdb_retention_policy — управление политиками хранения данных InfluxDB

Примечание

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

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

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

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

Краткое описание
Требования
Параметры
Атрибуты
Примеры

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

Управление политиками хранения данных InfluxDB.

Требования

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

influxdb >= 0.9
requests

Параметры

Параметр	Комментарии
database_name string / обязательный	Имя базы данных.
default boolean	Назначает политику хранения данных политикой по умолчанию. Варианты: `false` ← (по умолчанию) `true`
duration string	Определяет, как долго InfluxDB должна хранить данные. Если указано, значение должно быть `INF` или составлять не менее одного часа. Если значение не указано, предполагается `INF`. Поддерживаются составные выражения длительности с несколькими единицами измерения. Обязательно, только если для `state` задано значение `present`.
hostname string	Имя хоста или IP-адрес, на котором ожидает подключения сервер InfluxDB. По умолчанию: `"localhost"`
password псевдонимы: login_password string	Пароль для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
path string добавлено в community.general 0.2.0	Путь, по которому доступен сервер InfluxDB. Доступно только при использовании python-influxdb >= 5.1.0. По умолчанию: `""`
policy_name string / обязательный	Имя политики хранения данных.
port integer	Порт, на котором ожидает подключения сервер InfluxDB. По умолчанию: `8086`
proxies dictionary	Прокси HTTP(S), используемый библиотекой Requests для подключения к серверу InfluxDB. По умолчанию: `{}`
replication integer	Определяет, сколько независимых копий каждой точки хранится в кластере. Обязательно, только если для `state` задано значение `present`.
retries integer	Количество повторных попыток, выполняемых клиентом до прекращения работы. Значение `0` означает, что попытки будут выполняться до успеха. Доступно только при использовании `python-influxdb` >= 4.1.0. По умолчанию: `3`
shard_group_duration string добавлено в community.general 2.0.0	Определяет временной диапазон, охватываемый группой шардов. Если значение указано, оно должно составлять не менее одного часа. Если значение не задано, InfluxDB определяет его на основании длительности политики хранения данных. Поддерживаются составные выражения длительности с несколькими единицами измерения.
ssl boolean	Использовать https вместо http для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
state string добавлено в community.general 3.1.0	Состояние политики хранения данных. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout integer	Количество секунд, в течение которых Requests ожидает установления соединения с клиентом.
udp_port integer	Порт UDP для подключения к серверу InfluxDB. По умолчанию: `4444`
use_udp boolean	Использовать UDP для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: login_username string	Имя пользователя для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
validate_certs boolean	Если задано значение `false`, сертификаты SSL не проверяются. Задавайте это значение только для `false` на сайтах под вашим контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

# Example influxdb_retention_policy command from Ansible Playbooks
- name: Create 1 hour retention policy
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    duration: 1h
    replication: 1
    ssl: true
    validate_certs: true
    state: present

- name: Create 1 day retention policy with 1 hour shard group duration
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    duration: 1d
    replication: 1
    shard_group_duration: 1h
    state: present

- name: Create 1 week retention policy with 1 day shard group duration
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    duration: 1w
    replication: 1
    shard_group_duration: 1d
    state: present

- name: Create infinite retention policy with 1 week of shard group duration
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    duration: INF
    replication: 1
    ssl: false
    shard_group_duration: 1w
    state: present

- name: Create retention policy with complex durations
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    duration: 5d1h30m
    replication: 1
    ssl: false
    shard_group_duration: 1d10h30m
    state: present

- name: Drop retention policy
  community.general.influxdb_retention_policy:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    policy_name: test
    state: absent

Авторы

Kamil Szczygiel (@kamsz)

Ссылки на коллекцию

© 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/influxdb_retention_policy_module.html