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 вместо этого. Идентификатор панели. Это имя дружественного 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.9/modules/grafana_dashboard_module.html
