community.general.influxdb_write – Write data points into InfluxDB

From Get docs
Ansible/docs/2.10/collections/community/general/influxdb write module


community.general.influxdb_write – Write data points into InfluxDB

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.influxdb_write.


Synopsis

  • Write data points into InfluxDB.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • influxdb >= 0.9

Parameters

Parameter Choices/Defaults Comments

data_points

list / elements=dictionary / required

Data points as dict to write into the database.

database_name

string / required

Name of the database.

hostname

string

Default:

"localhost"

The hostname or IP address on which InfluxDB server is listening.

Since Ansible 2.5, defaulted to localhost.

password

string

Default:

"root"

Password that will be used to authenticate against InfluxDB server.

Alias login_password added in Ansible 2.5.


aliases: login_password

path

string

added in 0.2.0 of community.general

The path on which InfluxDB server is accessible

Only available when using python-influxdb >= 5.1.0

port

integer

Default:

8086

The port on which InfluxDB server is listening

proxies

dictionary

HTTP(S) proxy to use for Requests to connect to InfluxDB server.

retries

integer

Default:

3

Number of retries client will try before aborting.

0 indicates try until success.

Only available when using python-influxdb >= 4.1.0

ssl

boolean

  • no

  • yes

Use https instead of http to connect to InfluxDB server.

timeout

integer

Number of seconds Requests will wait for client to establish a connection.

udp_port

integer

Default:

4444

UDP port to connect to InfluxDB server.

use_udp

boolean

  • no

  • yes

Use UDP to connect to InfluxDB server.

username

string

Default:

"root"

Username that will be used to authenticate against InfluxDB server.

Alias login_username added in Ansible 2.5.


aliases: login_username

validate_certs

boolean

  • no
  • yes

If set to no, the SSL certificates will not be validated.

This should only set to no used on personally controlled sites using self-signed certificates.



Examples

- name: Write points into database
  community.general.influxdb_write:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      data_points:
        - measurement: connections
          tags:
            host: server01
            region: us-west
          time: "{{ ansible_date_time.iso8601 }}"
          fields:
            value: 2000
        - measurement: connections
          tags:
            host: server02
            region: us-east
          time: "{{ ansible_date_time.iso8601 }}"
          fields:
            value: 3000

Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/influxdb_write_module.html