community.general.influxdb_database – Управление базами данных InfluxDB
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в книге задач укажите: community.general.influxdb_database
Обзор
- Управление базами данных InfluxDB.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- influxdb >= 0.9
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| database_name строка / обязательно | Имя базы данных. | |
| hostname строка | Значение по умолчанию: "localhost" | Имя хоста или IP-адрес, на котором прослушивается сервер InfluxDB. С Ansible 2.5, значение по умолчанию установлено на localhost. |
| password строка | Значение по умолчанию: "root" | Пароль, который будет использоваться для аутентификации на сервере InfluxDB. Псевдоним login_password добавлен в Ansible 2.5.псевдонимы: login_password |
| path строка добавлен в 0.2.0 community.general | Путь к серверу InfluxDB. Доступно только при использовании python-influxdb >= 5.1.0 | |
| port целое число | Значение по умолчанию: 8086 | Порт, на котором прослушивается сервер InfluxDB. |
| proxies словарь | Прокси-сервер HTTP(S) для подключения к серверу InfluxDB. | |
| retries целое число | Значение по умолчанию: 3 | Количество попыток подключения перед прерыванием. 0 означает продолжение попыток до успеха.Доступно только при использовании python-influxdb >= 4.1.0 |
| ssl логическое значение |
| Использовать https вместо http для подключения к серверу InfluxDB. |
| state строка |
| Определяет, должна ли быть создана или удалена база данных. |
| timeout целое число | Количество секунд, которое Requests будет ожидать подключения. | |
| udp_port целое число | Значение по умолчанию: 4444 | Порт UDP для подключения к серверу InfluxDB. |
| use_udp логическое значение |
| Использовать UDP для подключения к серверу InfluxDB. |
| username строка | Значение по умолчанию: "root" | Имя пользователя для аутентификации на сервере InfluxDB. Псевдоним login_username добавлен в Ansible 2.5.псевдонимы: login_username |
| validate_certs логическое значение |
| Если установлено no, сертификаты SSL не будут проверены.Это следует использовать только на сайтах, контролируемых пользователем, с самозаверенными сертификатами. |
Примеры
# 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: yes
validate_certs: yes
Авторы
- Kamil Szczygiel (@kamsz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/influxdb_database_module.html