community.general.influxdb_database module – Manage InfluxDB databases
Note
This module is part of the community.general collection (version 9.4.0).
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_database
.
Synopsis
Manage InfluxDB databases.
Requirements
The below requirements are needed on the host that executes this module.
influxdb >= 0.9
requests
Parameters
Parameter |
Comments |
---|---|
Name of the database. |
|
The hostname or IP address on which InfluxDB server is listening. Default: |
|
Password that will be used to authenticate against InfluxDB server. 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: |
|
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:
|
|
Determines if the database should be created or destroyed. 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. Default: |
|
If set to This should only set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
# Example influxdb_database command from Ansible Playbooks
- name: Create database
community.general.influxdb_database:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
- name: Destroy database
community.general.influxdb_database:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
state: absent
- name: Create database using custom credentials
community.general.influxdb_database:
hostname: "{{influxdb_ip_address}}"
username: "{{influxdb_username}}"
password: "{{influxdb_password}}"
database_name: "{{influxdb_database_name}}"
ssl: true
validate_certs: true