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

布尔值

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

从 2.8 版本开始，该角色也会被更新。

选择

  • false ← (默认)

  • true

grants

列表 / 元素=字典

授予此用户的权限。

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

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

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

hostname

字符串

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

默认值： "localhost"

password

别名：login_password

字符串

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

默认值： "root"

path

字符串

在 community.general 0.2.0 中添加

可以访问 InfluxDB 服务器的路径。

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

默认值： ""

port

整数

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

默认值： 8086

proxies

字典

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

默认值： {}

retries

整数

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

0 表示尝试直到成功。

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

默认值： 3

ssl

布尔值

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

选择

  • false ← (默认)

  • true

state

字符串

用户的状态。

选择

  • "absent"

  • "present" ← (默认)

timeout

整数

请求等待客户端建立连接的秒数。

udp_port

整数

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

默认值： 4444

use_udp

布尔值

使用 UDP 连接到 InfluxDB 服务器。

选择

  • false ← (默认)

  • true

user_name

字符串 / 必需

用户的名称。

user_password

字符串

要为用户设置的密码。

username

别名：login_username

字符串

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

默认值： "root"

validate_certs

布尔值

如果设置为 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)