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

Примечание

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

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

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

Для использования в playbook, укажите: 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) прокси для использования Requests для подключения к серверу InfluxDB. Значение по умолчанию: `{}`
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	Поддержка: нет	Возвратит подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании режима diff.

Примеры

# 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/influxdb_database_module.html