community.grafana.grafana_dashboard lookup – list or search grafana dashboards

Note

This lookup plugin is part of the community.grafana collection (version 1.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.grafana.

To use it in a playbook, specify: community.grafana.grafana_dashboard.

Synopsis

  • This lookup returns a list of grafana dashboards with possibility to filter them by query.

Parameters

Parameter

Comments

grafana_api_key

string

Grafana API key.

When grafana_api_key is set, the options grafana_user, grafana_password and grafana_org_id are ignored.

Configuration:

  • Environment variable: GRAFANA_API_KEY

grafana_org_id

string

grafana organisation id.

Default: 1

Configuration:

  • Environment variable: GRAFANA_ORG_ID

grafana_password

string

grafana authentication password.

Default: “admin”

Configuration:

  • Environment variable: GRAFANA_PASSWORD

grafana_url

string

url of grafana.

Default: “http://127.0.0.1:3000”

Configuration:

  • Environment variable: GRAFANA_URL

grafana_user

string

grafana authentication user.

Default: “admin”

Configuration:

  • Environment variable: GRAFANA_USER

string

optional filter for dashboard search.

Configuration:

  • Environment variable: GRAFANA_DASHBOARD_SEARCH

Examples

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

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

Authors

  • Thierry Salle (@seuf)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.