community.general.influxdb_user module – Manage InfluxDB users
Note
This module is part of the community.general collection (version 8.6.4).
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_user
.
Synopsis
Manage InfluxDB users.
Aliases: database.influxdb.influxdb_user
Requirements
The below requirements are needed on the host that executes this module.
influxdb >= 0.9
Parameters
Parameter |
Comments |
---|---|
Whether the user should be in the admin role or not. Since version 2.8, the role will also be updated. Choices:
|
|
Privileges to grant to this user. Takes a list of dicts containing the “database” and “privilege” keys. If this argument is not provided, the current grants will be left alone. If an empty list is provided, all grants for the user will be removed. |
|
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:
|
|
State of the user. 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:
|
|
Name of the user. |
|
Password to be set for the user. |
|
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
- name: Create a user on localhost using default login credentials
community.general.influxdb_user:
user_name: john
user_password: s3cr3t
- name: Create a user on localhost using custom login credentials
community.general.influxdb_user:
user_name: john
user_password: s3cr3t
login_username: "{{ influxdb_username }}"
login_password: "{{ influxdb_password }}"
- name: Create an admin user on a remote host using custom login credentials
community.general.influxdb_user:
user_name: john
user_password: s3cr3t
admin: true
hostname: "{{ influxdb_hostname }}"
login_username: "{{ influxdb_username }}"
login_password: "{{ influxdb_password }}"
- name: Create a user on localhost with privileges
community.general.influxdb_user:
user_name: john
user_password: s3cr3t
login_username: "{{ influxdb_username }}"
login_password: "{{ influxdb_password }}"
grants:
- database: 'collectd'
privilege: 'WRITE'
- database: 'graphite'
privilege: 'READ'
- name: Destroy a user using custom login credentials
community.general.influxdb_user:
user_name: john
login_username: "{{ influxdb_username }}"
login_password: "{{ influxdb_password }}"
state: absent