influxdb_user – Manage InfluxDB users
New in version 2.5.
Synopsis
- Manage InfluxDB users
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- influxdb >= 0.9
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
admin boolean |
| Whether the user should be in the admin role or not. |
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 | 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 | Use https instead of http to connect to InfluxDB server. | |
state - |
| State of the user. |
timeout - added in 2.5 | 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 | Use UDP to connect to InfluxDB server. | |
user_name - / required | Name of the user. | |
user_password - | Password to be set for the user. | |
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
- name: Create a user on localhost using default login credentials influxdb_user: user_name: john user_password: s3cr3t - name: Create a user on localhost using custom login credentials 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 influxdb_user: user_name: john user_password: s3cr3t admin: yes hostname: "{{ influxdb_hostname }}" login_username: "{{ influxdb_username }}" login_password: "{{ influxdb_password }}" - name: Destroy a user using custom login credentials influxdb_user: user_name: john login_username: "{{ influxdb_username }}" login_password: "{{ influxdb_password }}" state: absent
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Vitaliy Zhhuta (@zhhuta)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/influxdb_user_module.html