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. Используйте uid панели Grafana вместо этого. Идентификатор (slug) панели. Это имя дружественного URL панели. Если state равно present, этот параметр может перезаписать slug в разделе meta файла json.Если вы хотите импортировать панель json, экспортированную непосредственно из интерфейса (не из API), вам необходимо указать параметр slug, так как в экспортированном json нет раздела meta. | |
| 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.8/modules/grafana_dashboard_module.html
