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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 / required	Имя базы данных.
default boolean	Устанавливает политику хранения в качестве политики хранения по умолчанию. Варианты: `false` ← (default) `true`
duration string	Определяет, как долго InfluxDB должен хранить данные. Если указано, должно быть `INF` или как минимум один час. Если не указано, предполагается `INF` . Поддерживает сложные выражения длительности с несколькими единицами. Требуется только если `state` установлено в `present`.
hostname string	Имя хоста или IP-адрес, на котором прослушивает сервер InfluxDB. По умолчанию: `"localhost"`
password aliases: login_password string	Пароль, который будет использоваться для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
path string добавлено в community.general 0.2.0	Путь, по которому доступен сервер InfluxDB. Доступно только при использовании python-influxdb >= 5.1.0. По умолчанию: `""`
policy_name string / required	Имя политики хранения.
port integer	Порт, на котором прослушивает сервер InfluxDB. По умолчанию: `8086`
proxies dictionary	HTTP(S) прокси для использования запросами для подключения к серверу 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` ← (default) `true`
state string добавлено в community.general 3.1.0	Состояние политики хранения. Варианты: `"absent"` `"present"` ← (default)
timeout integer	Количество секунд, в течение которых Requests будет ждать установления соединения клиентом.
udp_port integer	UDP-порт для подключения к серверу InfluxDB. По умолчанию: `4444`
use_udp boolean	Использовать UDP для подключения к серверу InfluxDB. Варианты: `false` ← (default) `true`
username aliases: login_username string	Имя пользователя, которое будет использоваться для аутентификации на сервере InfluxDB. По умолчанию: `"root"`

validate_certs

boolean

Если установлено в false, сертификаты SSL не будут проверены.

Это следует устанавливать только в false на сайтах, контролируемых вами лично, которые используют самоподписанные сертификаты.

Варианты:

false
true ← (по умолчанию)

Атрибуты

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