community.general.influxdb_user 模块 – 管理 InfluxDB 用户

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.general.influxdb_user。

概要

  • 管理 InfluxDB 用户。

要求

在执行此模块的主机上需要以下要求。

  • influxdb >= 0.9

参数

参数

注释

admin

boolean

用户是否应具有管理员角色。

自版本 2.8 起，角色也会被更新。

选项

  • false ← (默认)

  • true

grants

list / elements=dictionary

授予此用户的权限。

接受包含“database”和“privilege”键的字典列表。

如果未提供此参数，则当前授权将保持不变。

如果提供空列表，则将删除该用户的所有授权。

hostname

string

InfluxDB 服务器正在侦听的主机名或 IP 地址。

默认: "localhost"

password

别名: login_password

string

将用于向 InfluxDB 服务器进行身份验证的密码。

默认: "root"

path

string

在 community.general 0.2.0 中添加

InfluxDB 服务器可访问的路径。

仅在使用 python-influxdb >= 5.1.0 时可用。

默认: ""

port

integer

InfluxDB 服务器正在侦听的端口。

默认: 8086

proxies

dictionary

用于连接到 InfluxDB 服务器的 HTTP(S) 代理。

默认: {}

retries

integer

客户端在中止之前将尝试的重试次数。

0 表示尝试直到成功。

仅在使用 python-influxdb >= 4.1.0 时可用。

默认: 3

ssl

boolean

使用 https 而不是 http 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

state

string

用户的状态。

选项

  • "absent"

  • "present" ← (默认)

timeout

integer

Requests 将等待客户端建立连接的秒数。

udp_port

integer

用于连接到 InfluxDB 服务器的 UDP 端口。

默认: 4444

use_udp

boolean

使用 UDP 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

user_name

string / required

用户的名称。

user_password

string

要为用户设置的密码。

username

别名: login_username

string

将用于向 InfluxDB 服务器进行身份验证的用户名。

默认: "root"

validate_certs

boolean

如果设置为 false，则不会验证 SSL 证书。

只有在使用自签名证书的个人控制站点上才应将其设置为 false。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完整

可以在 check_mode 中运行并返回已更改的状态预测，而无需修改目标。

diff_mode

支持: 无

在差异模式下，将返回已更改（或可能需要在 check_mode 中进行更改）的详细信息。

示例

- 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

作者

  • Vitaliy Zhhuta (@zhhuta)