grafana_dashboard – Управление панелями Grafana
Новое в версии 2.5.
Обзор
- Создание, обновление, удаление, экспорт панелей Grafana через API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| client_cert - добавлен в 2.7 | Файл цепочки сертификатов в формате PEM для аутентификации SSL клиента. Этот файл также может содержать ключ, и если ключ включён, параметр client_key не требуется | |
| client_key - добавлен в 2.7 | Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации SSL клиента. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется | |
| grafana_api_key - | Ключ API Grafana. Если задан, параметры grafana_user и grafana_password будут игнорироваться. | |
| message - | Установите сообщение для истории версий. Используется только при state present. | |
| org_id - | По умолчанию: 1 | Идентификатор организации Grafana, в которую импортируется/экспортируется панель. Не используется, когда задан параметр grafana_api_key, так как grafana_api_key принадлежит только одной организации. |
| overwrite boolean |
| Перезаписать существующую панель при наличии состояния. |
| path - | Путь к файлу json с панелью Grafana для импорта или экспорта. | |
| slug - | Устарело начиная с Grafana 5. Используйте вместо него grafana dashboard uid. Идентификатор панели. Это понятное имя URL-адреса панели. Когда state present, этот параметр может переопределить идентификатор в разделе метаданных файла json.Если вы хотите импортировать панель json, экспортированную непосредственно из интерфейса (а не из API), вам необходимо указать параметр slug, так как в экспортированном json нет раздела метаданных. | |
| state - / обязательно |
| Состояние панели. |
| uid - добавлен в 2.7 | uid панели для экспорта, когда state export или absent. | |
| url - / обязательно добавлен в 2.7 | URL Grafana. псевдонимы: grafana_url | |
| url_password - добавлен в 2.7 | По умолчанию: "admin" | Пароль API Grafana. псевдонимы: grafana_password |
| url_username - добавлен в 2.7 | По умолчанию: "admin" | Пользователь API Grafana. псевдонимы: grafana_user |
| use_proxy boolean добавлен в 2.7 |
| Логическое значение, указывающее, использовать ли прокси. |
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены.Это следует использовать только на сайтах, находящихся под вашим контролем, использующих самозаверенные сертификаты. |
Примеры
- hosts: localhost
connection: local
tasks:
- name: Import Grafana dashboard foo
grafana_dashboard:
grafana_url: http://grafana.company.com
grafana_api_key: "{{ grafana_api_key }}"
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_user: "admin"
grafana_password: "{{ grafana_password }}"
org_id: 1
state: export
uid: "000000653"
path: "/path/to/dashboards/000000653.json"
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| uid строка | успех | uid или slug созданной/удаленной/экспортированной панели мониторинга. Пример: 51 |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Thierry Sallé (@seuf)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/grafana_dashboard_module.html
