community.grafana.grafana_user 模块 – 管理 Grafana 用户

注意

此模块是 community.grafana 集合 (版本 2.1.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.grafana。

要在 playbook 中使用它，请指定：community.grafana.grafana_user。

community.grafana 1.0.0 中的新增功能

概要 

通过用户和管理员 API 创建/更新/删除 Grafana 用户。
已在 Grafana v6.4.3 上测试
目前不支持密码更新

参数 

参数	注释
client_cert 路径	PEM 格式的证书链文件，用于 SSL 客户端身份验证。此文件也可以包含密钥，如果包含密钥，则不需要 client_key
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 client_cert 包含证书和密钥，则不需要此选项。
email 字符串	Grafana 用户的邮箱。
is_admin 布尔值	Grafana 用户是管理员。选项 `false` ← (默认) `true`
login 字符串 / 必需	Grafana 用户的登录名。
name 字符串	Grafana 用户的姓名。
password 字符串	Grafana 用户的密码。目前，此字段尚未更新。
state 字符串	用户是否应该存在于 Grafana 中的状态选项 `"present"` ← (默认) `"absent"`
url 别名：grafana_url 字符串 / 必需	Grafana URL。
url_password 别名：grafana_password 字符串	用于 API 身份验证的 Grafana 密码。默认值： `"admin"`
url_username 别名：grafana_user 字符串	用于 API 身份验证的 Grafana 用户。默认值： `"admin"`
use_proxy 布尔值	如果 `false`，即使目标主机上的环境变量中定义了代理，它也不会使用代理。选项 `false` `true` ← (默认)
validate_certs 布尔值	如果 `false`，则不会验证 SSL 证书。只有在使用自签名证书的个人控制站点上才应将其设置为 `false`。选项 `false` `true` ← (默认)

备注 

注意

与该集合中的其他模块不同，此模块不支持 grafana_api_key 身份验证类型。Grafana 用户管理的 API 端点需要基本身份验证和管理员权限。

示例 

---
- name: Create or update a Grafana user
  community.grafana.grafana_user:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    name: "Bruce Wayne"
    email: batman@gotham.city
    login: batman
    password: robin
    is_admin: true
    state: present

- name: Delete a Grafana user
  community.grafana.grafana_user:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    login: batman
    state: absent

返回值 

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
user 复杂类型	关于用户的信息返回：当 state 为 present 时
email 字符串	用户的邮箱地址返回：始终返回示例： `"['foo.bar@example.com']"`
id 整数	用户的 ID 返回：始终返回示例： `[42]`
isDisabled 布尔值	Grafana 账户状态返回：始终返回示例： `[false]`
isExternal 布尔值	Grafana 账户关于外部用户提供商的信息返回：始终返回示例： `[false]`
isGrafanaAdmin 布尔值	Grafana 用户的管理员权限返回：始终返回示例： `[false]`
login 字符串	用户的登录名返回：始终返回示例： `"['batman']"`
orgId 整数	团队所属的组织 ID。返回：始终返回示例： `[1]`
theme 字符串	Grafana 主题返回：始终返回示例： `"['light']"`

作者

Antoine Tanzilli (@Tailzip)
洪越黎 (@pomverte)
Julien Alexandre (@jual)
Marc Cyprien (@LeFameux)