Модуль community.grafana.grafana_dashboard — управление дашбордами Grafana

Примечание

Этот модуль входит в коллекцию community.grafana (версия 2.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.grafana.

Чтобы использовать её в плейбуке, укажите: community.grafana.grafana_dashboard.

Добавлено в community.grafana 1.0.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление, удаление и экспорт дашбордов Grafana через API.

Параметры

Параметр	Комментарии
client_cert path	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён в файл, параметр client_key не требуется
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
commit_message string	Задаёт сообщение коммита для истории версий. Используется только, если `state` имеет значение `present`.
dashboard_id string добавлено в community.grafana 1.0.0	Идентификатор публичного дашборда на Grafana.com для импорта
dashboard_revision string добавлено в community.grafana 1.0.0	Ревизия публичного дашборда Grafana для импорта По умолчанию: `"1"`
folder string добавлено в community.grafana 1.0.0	UID папки, в которой будет создан или импортирован дашборд. Обязателен, если задан `parent_folder`. По умолчанию: `"General"`
grafana_api_key string	Ключ API Grafana. Если задан, `url_username` и `url_password` будут проигнорированы.
org_id integer	Идентификатор организации Grafana, в которую будет импортирован дашборд, из которой он будет экспортирован или удалён. Не используется, если задан grafana_api_key, поскольку ключ grafana_api_key относится только к одной организации. Взаимоисключающий параметр с `org_name`. По умолчанию: `1`
org_name string	Название организации Grafana, в которую будет импортирован дашборд, из которой он будет экспортирован или удалён. Не используется, если задан grafana_api_key, поскольку ключ grafana_api_key относится только к одной организации. Взаимоисключающий параметр с `org_id`.
overwrite boolean	Перезаписывать существующий дашборд, если состояние — present. Варианты: `false` ← (по умолчанию) `true`
parent_folder string добавлено в community.grafana 2.2.0	UID родительской папки, ограничивающий область поиска указанного `folder`. Доступно при использовании функции подпапок в Grafana 11.
path псевдонимы: dashboard_url string	Путь к JSON-файлу с дашбордом Grafana для импорта или экспорта. Также принимается URL HTTP (начиная с версии 2.10). Обязателен, если `state` имеет значение `export` или `present`.
slug string	Устарел начиная с Grafana 5. Вместо него используйте UID дашборда Grafana. slug дашборда. Это удобочитаемое имя дашборда в URL. Если `state` имеет значение `present`, этот параметр может переопределить slug в разделе meta JSON-файла. Чтобы импортировать JSON дашборда, экспортированный непосредственно из интерфейса (не через API), необходимо указать параметр slug, поскольку в экспортированном JSON отсутствует раздел meta.
state string	Состояние дашборда. Варианты: `"absent"` `"export"` `"present"` ← (по умолчанию)
uid string добавлено в community.grafana 1.0.0	Используется для идентификации дашборда, если `state` имеет значение `export` или `absent`. Если `state` имеет значение `present`, этот параметр можно использовать для задания UID при создании дашборда.
url псевдонимы: grafana_url string / обязательный	URL Grafana.
url_password псевдонимы: grafana_password string	Пароль Grafana для аутентификации через API. По умолчанию: `"admin"`
url_username псевдонимы: grafana_user string	Пользователь Grafana для аутентификации через API. По умолчанию: `"admin"`
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте это значение в `false` только для сайтов под личным контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Import Grafana dashboard foo
  community.grafana.grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_api_key: "{{ grafana_api_key }}"
    state: present
    commit_message: Updated by ansible
    overwrite: true
    path: /path/to/dashboards/foo.json

- name: Import Grafana dashboard Zabbix
  community.grafana.grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_api_key: "{{ grafana_api_key }}"
    folder: zabbix
    dashboard_id: 6098
    dashboard_revision: 1

- name: Import Grafana dashboard zabbix
  community.grafana.grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_api_key: "{{ grafana_api_key }}"
    folder: public
    dashboard_url: https://grafana.com/api/dashboards/6098/revisions/1/download

- name: Import Grafana dashboard zabbix in a subfolder
  community.grafana.grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_api_key: "{{ grafana_api_key }}"
    parent_folder: public
    folder: myteam
    dashboard_url: https://grafana.com/api/dashboards/6098/revisions/1/download

- name: Export dashboard
  community.grafana.grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_user: "admin"
    grafana_password: "{{ grafana_password }}"
    org_id: 1
    state: export
    uid: "000000653"
    path: "/path/to/dashboards/000000653.json"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
uid string	uid или slug созданного, удалённого или экспортированного дашборда. Возвращается: при успехе Пример: `"51"`

Авторы

Thierry Sallé (@seuf)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/grafana/grafana_dashboard_module.html