community.general.influxdb_query – Запрос значений данных из InfluxDB
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.influxdb_query.
Описание
- Запрос значений данных из InfluxDB.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- influxdb >= 0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. | |
| query строка / обязательно | Запрос, который нужно выполнить. | |
| retries целое число | Значение по умолчанию: 3 | Количество попыток, которые клиент предпримет, прежде чем прервать выполнение. 0 означает попытки до успеха.Доступно только при использовании python-influxdb >= 4.1.0 |
| ssl булево |
| Использовать https вместо http для подключения к серверу InfluxDB. |
| 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 не будут проверены.Это следует установить только в no для сайтов, находящихся под личным контролем, использующих самозаверенные сертификаты. |
Примеры
- name: Query connections
community.general.influxdb_query:
hostname: "{{ influxdb_ip_address }}"
database_name: "{{ influxdb_database_name }}"
query: "select mean(value) from connections"
register: connection
- name: Query connections with tags filters
community.general.influxdb_query:
hostname: "{{ influxdb_ip_address }}"
database_name: "{{ influxdb_database_name }}"
query: "select mean(value) from connections where region='zue01' and host='server01'"
register: connection
- name: Print results from the query
ansible.builtin.debug:
var: connection.query_results
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращенное | Описание |
|---|---|---|
| query_results список / элементы=строка | успех | Результат запроса Пример: [{'среднее': 1245.5333333333333, 'время': '1970-01-01T00:00:00Z'}] |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/influxdb_query_module.html
