grafana.grafana.dashboard 模块 – 管理 Grafana 中的仪表盘

注意

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

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

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

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

grafana.grafana 0.0.1 中的新增功能

概要 

使用 Ansible 创建、更新和删除仪表盘。

要求 

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

requests >= 1.0.0

参数 

参数	注释
dashboard 字典 / 必需	仪表盘的 JSON 源代码。
grafana_api_key 字符串 / 必需	用于使用 Grafana Cloud 进行身份验证的 Grafana API 密钥。
grafana_url 字符串 / 必需	Grafana 实例的 URL。
state 字符串	Grafana 仪表盘的状态。选择 `"present"` ← (默认) `"absent"`

注释 

注意

不支持 check_mode。
不支持 Idempotency。

示例 

- name: Create/Update a dashboard
  grafana.grafana.dashboard:
    dashboard: "{{ lookup('ansible.builtin.file', 'dashboard.json') }}"
    grafana_url: "{{ grafana_url }}"
    grafana_api_key: "{{ grafana_api_key }}"
    state: present

- name: Delete dashboard
  grafana.grafana.dashboard:
    dashboard: "{{ lookup('ansible.builtin.file', 'dashboard.json') }}"
    grafana_url: "{{ grafana_url }}"
    grafana_api_key: "{{ grafana_api_key }}"
    state: absent

返回值 

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

键	描述
输出字典	包含文件夹信息的字典对象。返回：成功时
id 整数	仪表盘的 ID。返回：成功时示例： `17`
消息字符串	在仪表盘上执行操作后返回的消息。返回：状态为 absent 和成功时示例： `"仪表盘 Ansible 集成测试已删除"`
slug 字符串	仪表盘的 slug。返回：状态为 present 和成功时示例： `"ansible-integration-test"`
状态字符串	仪表盘的状态。返回：状态为 present 和成功时示例： `"success"`
标题字符串	仪表盘的名称。返回：状态为 absent 和成功时示例： `"Ansible 集成测试"`
uid 字符串	仪表盘的 UID。返回：状态为 present 和成功时示例： `"test1234"`
url 字符串	仪表盘的端点。返回：状态为 present 和成功时示例： `"/d/test1234/ansible-integration-test"`
版本整数	仪表盘的版本。返回：状态为 present 和成功时示例： `2`

作者

Ishan Jain (@ishanjainn)