Модуль community.general.influxdb_database — управление базами данных InfluxDB

Примечание

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

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

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

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

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

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

Управление базами данных InfluxDB.

Требования

Следующие требования необходимы на хосте, выполняющем этот модуль.

influxdb >= 0.9
requests

Параметры

Параметр	Комментарии
database_name string / обязательный	Имя базы данных.
hostname string	Имя хоста или IP-адрес, на котором прослушивает запросы сервер InfluxDB. По умолчанию: `"localhost"`
password псевдонимы: login_password string	Пароль для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
path string добавлено в community.general 0.2.0	Путь, по которому доступен сервер InfluxDB. Доступно только при использовании python-influxdb >= 5.1.0. По умолчанию: `""`
port integer	Порт, на котором прослушивает запросы сервер InfluxDB. По умолчанию: `8086`
proxies dictionary	HTTP(S)-прокси для подключения к серверу InfluxDB с помощью Requests. По умолчанию: `{}`
retries integer	Количество повторных попыток, выполняемых клиентом перед прекращением работы. Значение `0` означает, что попытки будут продолжаться до успеха. Доступно только при использовании `python-influxdb` >= 4.1.0. По умолчанию: `3`
ssl boolean	Использовать https вместо http для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
state string	Определяет, следует ли создать или удалить базу данных. Варианты: `"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_database command from Ansible Playbooks
- name: Create database
  community.general.influxdb_database:
    hostname: "{{influxdb_ip_address}}"
    database_name: "{{influxdb_database_name}}"

- name: Destroy database
  community.general.influxdb_database:
    hostname: "{{influxdb_ip_address}}"
    database_name: "{{influxdb_database_name}}"
    state: absent

- name: Create database using custom credentials
  community.general.influxdb_database:
    hostname: "{{influxdb_ip_address}}"
    username: "{{influxdb_username}}"
    password: "{{influxdb_password}}"
    database_name: "{{influxdb_database_name}}"
    ssl: true
    validate_certs: true

Авторы

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