community.general.influxdb_query – Query data points from InfluxDB¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.influxdb_query
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
influxdb >= 0.9
Parameters¶
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 | Returned | Description |
---|---|---|
query_results
list
/ elements=string
|
success |
Result from the query
Sample:
[{'mean': 1245.5333333333333, 'time': '1970-01-01T00:00:00Z'}]
|
Authors¶
René Moser (@resmo)