community.general.influxdb_user (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Manage InfluxDB users.

Requirements

• influxdb >= 0.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a user on localhost using default login credentials
  community.general.influxdb_user:
    user_name: john
    user_password: s3cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
ssl:
    default: false
    description:
    - Use https instead of http to connect to InfluxDB server.
    type: bool

path:
    default: ''
    description:
    - The path on which InfluxDB server is accessible.
    - Only available when using python-influxdb >= 5.1.0.
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

port:
    default: 8086
    description:
    - The port on which InfluxDB server is listening.
    type: int

admin:
    default: false
    description:
    - Whether the user should be in the admin role or not.
    - Since version 2.8, the role will also be updated.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - State of the user.
    type: str

grants:
    description:
    - 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.
    elements: dict
    type: list

proxies:
    default: {}
    description:
    - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
    type: dict

retries:
    default: 3
    description:
    - Number of retries client will try before aborting.
    - V(0) indicates try until success.
    - Only available when using python-influxdb >= 4.1.0.
    type: int

timeout:
    description:
    - Number of seconds Requests will wait for client to establish a connection.
    type: int

use_udp:
    default: false
    description:
    - Use UDP to connect to InfluxDB server.
    type: bool

hostname:
    default: localhost
    description:
    - The hostname or IP address on which InfluxDB server is listening.
    type: str

password:
    aliases:
    - login_password
    default: root
    description:
    - Password that will be used to authenticate against InfluxDB server.
    type: str

udp_port:
    default: 4444
    description:
    - UDP port to connect to InfluxDB server.
    type: int

username:
    aliases:
    - login_username
    default: root
    description:
    - Username that will be used to authenticate against InfluxDB server.
    type: str

user_name:
    description:
    - Name of the user.
    required: true
    type: str

user_password:
    description:
    - Password to be set for the user.
    required: false
    type: str

validate_certs:
    default: true
    description:
    - If set to V(false), the SSL certificates will not be validated.
    - This should only set to V(false) used on personally controlled sites using self-signed
      certificates.
    type: bool