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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

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

Авторы

René Moser (@resmo)

Ссылки на коллекцию

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