community.general.influxdb_query (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Query data points from InfluxDB.

Requirements

• influxdb >= 0.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query connections
  community.general.influxdb_query:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    query: "select mean(value) from connections"
  register: connection

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print results from the query
  ansible.builtin.debug:
    var: connection.query_results

Inputs

    
ssl:
    default: false
    description:
    - Use https instead of http to connect to InfluxDB server.
    type: bool

path:
    default: ''
    description:
    - The path on which InfluxDB server is accessible.
    - Only available when using python-influxdb >= 5.1.0.
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

port:
    default: 8086
    description:
    - The port on which InfluxDB server is listening.
    type: int

query:
    description:
    - Query to be executed.
    required: true
    type: str

proxies:
    default: {}
    description:
    - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
    type: dict

retries:
    default: 3
    description:
    - Number of retries client will try before aborting.
    - V(0) indicates try until success.
    - Only available when using python-influxdb >= 4.1.0.
    type: int

timeout:
    description:
    - Number of seconds Requests will wait for client to establish a connection.
    type: int

use_udp:
    default: false
    description:
    - Use UDP to connect to InfluxDB server.
    type: bool

hostname:
    default: localhost
    description:
    - The hostname or IP address on which InfluxDB server is listening.
    type: str

password:
    aliases:
    - login_password
    default: root
    description:
    - Password that will be used to authenticate against InfluxDB server.
    type: str

udp_port:
    default: 4444
    description:
    - UDP port to connect to InfluxDB server.
    type: int

username:
    aliases:
    - login_username
    default: root
    description:
    - Username that will be used to authenticate against InfluxDB server.
    type: str

database_name:
    description:
    - Name of the database.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If set to V(false), the SSL certificates will not be validated.
    - This should only set to V(false) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

query_results:
  description: Result from the query
  returned: success
  sample:
  - mean: 1245.5333333333333
    time: '1970-01-01T00:00:00Z'
  type: list