community.general.influxdb_query module – Query data points from InfluxDB
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.influxdb_query
.
Synopsis
Query data points from InfluxDB.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
influxdb >= 0.9
Parameters
Parameter |
Comments |
---|---|
Name of the database. |
|
The hostname or IP address on which InfluxDB server is listening. Since Ansible 2.5, defaulted to localhost. Default: |
|
Password that will be used to authenticate against InfluxDB server. Alias Default: |
|
The path on which InfluxDB server is accessible Only available when using python-influxdb >= 5.1.0 Default: |
|
The port on which InfluxDB server is listening Default: |
|
HTTP(S) proxy to use for Requests to connect to InfluxDB server. Default: |
|
Query to be executed. |
|
Number of retries client will try before aborting.
Only available when using python-influxdb >= 4.1.0 Default: |
|
Use https instead of http to connect to InfluxDB server. Choices:
|
|
Number of seconds Requests will wait for client to establish a connection. |
|
UDP port to connect to InfluxDB server. Default: |
|
Use UDP to connect to InfluxDB server. Choices:
|
|
Username that will be used to authenticate against InfluxDB server. Alias Default: |
|
If set to This should only set to Choices:
|
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Result from the query Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication