Модуль community.general.influxdb_query – Запрос точек данных из InfluxDB

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.influxdb_query.

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

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

Запрос точек данных из InfluxDB.

Требования

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

influxdb >= 0.9

Параметры

Параметр	Комментарии
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. Значение по умолчанию: `{}`
query string / обязательный	Запрос для выполнения.
retries integer	Количество попыток, которые клиент предпримет перед прерыванием. `0` указывает на попытку до успеха. Доступно только при использовании python-influxdb >= 4.1.0. Значение по умолчанию: `3`
ssl boolean	Использовать https вместо http для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
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.

Примеры

- 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 список / элементы=строка	Результат запроса Возвращено: успех Пример: `[{"mean": 1245.5333333333333, "time": "1970-01-01T00:00:00Z"}]`

Авторы

René Moser (@resmo)

Ссылки на сборку

© 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_query_module.html