Documentation

influxdb_database - Manage InfluxDB databases

New in version 2.1.

Synopsis

  • Manage InfluxDB databases.

Requirements

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

  • python >= 2.6
  • influxdb >= 0.9
  • requests

Parameters

Parameter
Choices/Defaults
Comments
database_name
required
Name of the database.
hostname
Default:
localhost
The hostname or IP address on which InfluxDB server is listening.
Since version 2.5, defaulted to localhost.
password
Default:
root
Password that will be used to authenticate against InfluxDB server.
Alias login_password added in version 2.5.

aliases: login_password
port
Default:
8086
The port on which InfluxDB server is listening
proxies
(added in 2.5)
Default:
None
HTTP(S) proxy to use for Requests to connect to InfluxDB server.
retries
(added in 2.5)
Default:
3
Number of retries client will try before aborting.
0 indicates try until success.
ssl
(added in 2.5)
Default:
no
Use https instead of http to connect to InfluxDB server.
state
    Choices:
  • present ←
  • absent
Determines if the database should be created or destroyed.
timeout
(added in 2.5)
Default:
None
Number of seconds Requests will wait for client to establish a connection.
udp_port
(added in 2.5)
Default:
4444
UDP port to connect to InfluxDB server.
use_udp
(added in 2.5)
Default:
no
Use UDP to connect to InfluxDB server.
username
Default:
root
Username that will be used to authenticate against InfluxDB server.
Alias login_username added in version 2.5.

aliases: login_username
validate_certs
(added in 2.5)
Default:
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

# Example influxdb_database command from Ansible Playbooks
- name: Create database
  influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"

- name: Destroy database
  influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      state: absent

- name: Create database using custom credentials
  influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      username: "{{influxdb_username}}"
      password: "{{influxdb_password}}"
      database_name: "{{influxdb_database_name}}"
      ssl: yes
      validate_certs: yes

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Kamil Szczygiel (@kamsz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.