community.grafana.grafana_folder 模块 – 管理 Grafana 文件夹

注意

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

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

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

要在剧本中使用它，请指定：community.grafana.grafana_folder。

community.grafana 1.0.0 中的新增功能

概要 

通过文件夹 API 创建/更新/删除 Grafana 文件夹。

要求 

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

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

参数 

参数	注释
client_cert path	用于 SSL 客户端身份验证的 PEM 格式证书链文件。此文件也可以包含密钥，如果包含密钥，则不需要 _client_key_
client_key path	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 _client_cert_ 包含证书和密钥，则不需要此选项。
grafana_api_key 字符串	Grafana API 密钥。如果设置，则将忽略 `url_username` 和 `url_password`。
name 别名：title 字符串 / 必需	Grafana 文件夹的标题。
org_id 整数	应该在其中创建数据源的 Grafana 组织 ID。设置 `grafana_api_key` 时不使用，因为 `grafana_api_key` 仅属于一个组织。与 `org_name` 互斥。默认值： `1`
org_name 字符串	应该在其中创建数据源的 Grafana 组织名称。设置 `grafana_api_key` 时不使用，因为 `grafana_api_key` 仅属于一个组织。与 `org_id` 互斥。
parent_uid 字符串	父文件夹 UID。 Grafana 11 的子文件夹功能可用。
skip_version_check 布尔值 community.grafana 1.2.0 中添加	跳过 Grafana 版本检查并尝试访问 api 端点。如果您在 grafana.ini 中启用了 `hide_version`，则此参数很有用选项 `false` ← (默认) `true`
state 字符串	删除在 `members` 参数中找不到的成员，这些成员来自在文件夹上找到的成员列表。选项 `"present"` ← (默认) `"absent"`
uid 字符串	文件夹 UID。
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 folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: present

- name: Delete a folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: absent

返回值 

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

键	描述
文件夹复杂	关于文件夹的信息返回：成功时
canAdmin 布尔值	布尔值，指定当前用户是否可以管理文件夹返回：始终示例： `[false]`
canEdit 布尔值	布尔值，指定当前用户是否可以编辑文件夹返回：始终示例： `[false]`
canSave 布尔值	布尔值，指定当前用户是否可以保存文件夹返回：始终示例： `[false]`
created 字符串	文件夹创建时间返回：始终示例： `"['2018-01-31T17:43:12+01:00']"`
createdBy 字符串	创建文件夹的用户名称返回：始终示例： `"['admin']"`
hasAcl 布尔值	布尔值，指定文件夹是否具有访问控制列表 (ACL) 返回：始终示例： `[false]`
id 整数	文件夹标识符返回：始终示例： `[42]`
orgId 整数	组织 ID 返回：始终示例： `[1]`
parentUid 字符串	父文件夹的唯一标识符 (UID) 返回：作为子文件夹始终返回示例： `"['76HjcBH2']"`
title 字符串	文件夹标题返回：始终示例： `"['Department ABC']"`
uid 字符串	文件夹唯一标识符 (UID) 返回：始终示例： `"['nErXDvCkzz']"`
updated 字符串	文件夹最后更新日期返回：始终示例： `"['2018-01-31T17:43:12+01:00']"`
updatedBy 字符串	最后更新文件夹的用户名称返回：始终示例： `"['admin']"`
url 字符串	文件夹 URL 返回：始终示例： `"['/dashboards/f/nErXDvCkzz/department-abc']"`
version 整数	文件夹版本返回：始终示例： `[1]`

作者

Rémi REY (@rrey)