grafana_dashboard - Управление панелями Grafana
Новое в версии 2.5.
Описание
- Создание, обновление, удаление, экспорт панелей Grafana через API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| grafana_api_key | Ключ API Grafana. Если задан, grafana_user и grafana_password будут проигнорированы. | |
| grafana_password | Значение по умолчанию: admin | Пароль API Grafana. |
| grafana_url обязательно | URL Grafana. | |
| grafana_user | Значение по умолчанию: admin | Пользователь API Grafana. |
| message | Установите сообщение для истории коммитов. Используется только тогда, когда state равно present. | |
| org_id | Значение по умолчанию: 1 | ID организации Grafana, куда будет импортирована/экспортирована панель. Не используется, когда задан grafana_api_key, поскольку ключ API Grafana принадлежит только одной организации. |
| overwrite |
| Перезаписывать существующую панель, если состояние присутствует. |
| path | Путь к файлу json с панелью Grafana для импорта или экспорта. | |
| slug | Идентификатор (slug) панели. Это имя панели с дружественным URL. Когда state равно present, этот параметр может перезаписать идентификатор (slug) в разделе meta файла json.Если вы хотите импортировать панель json, экспортированную напрямую из интерфейса (а не из API), вам необходимо указать параметр slug, так как в экспортированном json нет раздела meta. | |
| state обязательно |
| Состояние панели. |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. |
Примеры
- name: Import Grafana dashboard foo
grafana_dashboard:
grafana_url: http://grafana.company.com
grafana_api_key: XXXXXXXXXXXX
state: present
message: Updated by ansible
overwrite: yes
path: /path/to/dashboards/foo.json
- name: Export dashboard
grafana_dashboard:
grafana_url: http://grafana.company.com
grafana_api_key: XXXXXXXXXXXX
state: export
slug: foo
path: /path/to/dashboards/foo.json
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| slug строка | успешно | Идентификатор (slug) созданной/удаленной/экспортированной панели. Пример: foo |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- Thierry Sallé (@tsalle)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/grafana_dashboard_module.html
