community.grafana.grafana_team 模块 – 管理 Grafana 团队

注意

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

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

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

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

community.grafana 1.0.0 中的新功能

概要 

通过 Teams API 创建/更新/删除 Grafana 团队。
还允许在团队中添加成员（如果成员存在）。

要求 

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

Teams API 仅从 Grafana 5 开始可用，如果服务器版本低于版本 5，模块将失败。

参数 

参数	注释
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式的证书链文件。此文件还可以包含密钥，如果包含密钥，则不需要 client_key
client_key 路径	PEM 格式的文件，其中包含用于 SSL 客户端身份验证的私钥。如果 client_cert 同时包含证书和密钥，则不需要此选项。
email 字符串 / 必需	与团队关联的邮件地址。
enforce_members 布尔值	从团队中找到的成员列表中删除未在 `members` 参数中找到的成员。团队的成员列表。选项 `false` ←（默认） `true`
grafana_api_key 字符串	Grafana API 密钥。如果设置，将忽略 `url_username` 和 `url_password`。
members 列表 / 元素=字符串	团队成员列表（电子邮件）。可以使用 `enforce_members` 参数强制执行该列表。
name 字符串 / 必需	Grafana 团队的名称。
skip_version_check 布尔值在 community.grafana 1.2.0 中添加	跳过 Grafana 版本检查，并尝试访问 api 端点。如果在 grafana.ini 中启用了 `hide_version`，则此参数可能很有用选项 `false` ←（默认） `true`
state 字符串	从团队中找到的成员列表中删除未在 `members` 参数中找到的成员。团队的成员列表。选项 `"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: Create a team
  community.grafana.grafana_team:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      name: "grafana_working_group"
      email: "[email protected]"
      state: present

- name: Create a team with members
  community.grafana.grafana_team:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      name: "grafana_working_group"
      email: "[email protected]"
      members:
          - [email protected]
          - [email protected]
      state: present

- name: Create a team with members and enforce the list of members
  community.grafana.grafana_team:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      name: "grafana_working_group"
      email: "[email protected]"
      members:
          - [email protected]
          - [email protected]
      enforce_members: true
      state: present

- name: Delete a team
  community.grafana.grafana_team:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      name: "grafana_working_group"
      email: "[email protected]"
      state: absent

返回值 

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

键	描述
team 复杂	有关团队的信息已返回：成功时
avatarUrl 字符串	Grafana 服务器上团队头像的 URL 已返回：始终示例： `"['/avatar/a7440323a684ea47406313a33156e5e9']"`
email 字符串	团队电子邮件地址已返回：始终示例： `"['[email protected]']"`
id 整数	团队电子邮件地址已返回：始终示例： `[42]`
memberCount 整数	团队成员数已返回：始终示例： `[42]`
members 列表 / 元素=字符串	团队成员列表已返回：始终示例： `[["[email protected]"]]`
name 字符串	团队的名称。已返回：始终示例： `"['grafana_working_group']"`
orgId 整数	团队所属的组织 ID。已返回：始终示例： `[1]`

作者

Rémi REY (@rrey)