community.grafana.grafana_dashboard 查询 – 列出或搜索 Grafana 仪表板

注意

此查询插件是 community.grafana 集合 (版本 2.1.0) 的一部分。

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

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

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

概要

  • 此查询返回 Grafana 仪表板列表，并可以选择通过查询进行过滤。

关键字参数

此部分描述查询的关键字参数。这些是在以下示例中的值 key1=value1、key2=value2 等：lookup('community.grafana.grafana_dashboard', key1=value1, key2=value2, ...) 和 query('community.grafana.grafana_dashboard', key1=value1, key2=value2, ...)

参数

注释

ca_path

字符串

文件系统路径字符串，用于验证的 CA 证书包。

grafana_api_key

字符串

Grafana API 密钥。

当设置 grafana_api_key 时，选项 grafana_user、grafana_password 和 grafana_org_id 将被忽略。

配置

grafana_org_id

字符串

Grafana 组织 ID。

默认值： 1

配置

grafana_password

字符串

Grafana 身份验证密码。

默认值： "admin"

配置

grafana_url

字符串

Grafana 的 URL。

默认值： "http://127.0.0.1:3000"

配置

grafana_user

字符串

Grafana 身份验证用户名。

默认值： "admin"

配置

字符串

仪表板搜索的可选过滤器。

配置

validate_certs

布尔值

用于控制 SSL 证书验证的标志

选项

  • false

  • true ← (默认)

示例

- name: get project foo grafana dashboards
  set_fact:
    grafana_dashboards: "{{ lookup('grafana_dashboard', 'grafana_url=https://grafana.org.cnpany.com grafana_user=admin grafana_password=admin search=foo') }}"

- name: get all grafana dashboards
  set_fact:
    grafana_dashboards: "{{ lookup('grafana_dashboard', 'grafana_url=https://grafana.org.cnpany.com grafana_api_key=' ~ grafana_api_key) }}"

- name: get project foo grafana dashboards (validate SSL certificates of the instance with custom CA Certificate Bundle)
  set_fact:
    grafana_dashboards: |
        {{
            lookup(
              'grafana_dashboard',
              'grafana_url=https://grafana.org.cnpany.com grafana_user=admin grafana_password=admin search=foo',
              validate_certs=true,
              ca_path='/path/to/chain.crt'
            )
        }}

作者

  • Thierry Salle (@seuf)

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。