community.grafana.grafana_organization_user 模块 – 管理 Grafana 组织用户。

注意

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

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

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

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

community.grafana 1.6.0 中的新增功能

概要

• 通过组织 API 添加或删除用户或更改他们在 Grafana 组织中的角色。

• 在使用此模块之前，用户必须存在。请参阅 https://docs.ansible.org.cn/ansible/latest/collections/community/grafana/grafana_user_module.html。

参数

参数	注释
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式证书链文件。 此文件也可以包含密钥，如果包含密钥，则不需要client_key
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。 如果client_cert同时包含证书和密钥，则不需要此选项。
login 字符串 / 必需	用户名或电子邮件。
org_id 整数	组织 ID。 与org_name互斥。 默认值：1
org_name 字符串	组织名称。 与org_id互斥。
role 字符串	用户在组织中的角色。 选项 "viewer" ← (默认) "editor" "admin"
state 字符串	用户组织成员身份的状态。 选项 "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 ← (默认)

示例

---
- name: Add user to organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    role: admin

- name: Remove user from organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    state: absent

返回值

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

键	描述
user 复杂	关于组织用户的资料 返回：当状态为 present 时
email 字符串	用户的电子邮件地址 返回：始终 示例："['[email protected]']"
login 字符串	用户的登录名 返回：始终 示例："['batman']"
name 字符串	用户名（与登录名相同） 返回：始终 示例："['batman']"
orgId 整数	团队所属的组织 ID。 返回：始终 示例：[1]
role 字符串	用户在组织中的角色 返回：始终 只能返回 "Viewer" "Editor" "Admin" 示例："['Viewer']"

作者

• Aliaksandr Mianzhynski (@amenzhinsky)

集合链接

• 问题追踪器
• 主页
• 代码库 (源码)