community.grafana.grafana_dashboard – Управление панелями Grafana
Примечание
Этот плагин входит в коллекцию community.grafana (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install community.grafana.
Для использования в playbook, укажите: community.grafana.grafana_dashboard.
Новое в версии 1.0.0: из community.grafana
Описание
- Создание, обновление, удаление, экспорт панелей Grafana через API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| client_cert путь | Файл цепочки сертификатов в формате PEM, используемый для проверки SSL клиента. Этот файл также может содержать ключ, и если ключ включен, client_key не требуется | |
| client_key путь | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для проверки SSL клиента. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется. | |
| commit_message строка | Установите сообщение коммита для истории версий. Используется только тогда, когда state равно present.message псевдоним устарел в Ansible 2.10, так как он используется внутренне ядром Ansible.Псевдонимы: сообщение | |
| dashboard_id строка добавлено в 1.0.0 от community.grafana | Идентификатор публичной панели Grafana.com для импорта | |
| dashboard_revision строка добавлено в 1.0.0 от community.grafana | По умолчанию: 1 | Ревизия публичной панели grafana для импорта |
| folder строка добавлено в 1.0.0 от community.grafana | По умолчанию: "General" | Папка Grafana, в которую будет импортирована данная панель. |
| grafana_api_key строка | Ключ API Grafana. Если задан, url_username и url_password будут проигнорированы. | |
| org_id целое число | По умолчанию: 1 | Идентификатор организации Grafana, в которую будет импортирована/экспортирована панель. Не используется, когда установлен grafana_api_key, потому что grafana_api_key относится только к одной организации. |
| overwrite булево |
| Перезаписывать существующую панель при наличии состояния. |
| path строка | Путь к файлу json, содержащему панель Grafana для импорта или экспорта. Также принимается http URL (с версии 2.10). Требуется, если state равно export или present.Псевдонимы: dashboard_url | |
| slug строка | Устарело с Grafana 5. Используйте uid панели Grafana вместо этого. Имя панели. Это имя дружественного URL панели. Когда state равно present, этот параметр может переопределить slug в разделе метаданных файла json.Если вы хотите импортировать json-панель, экспортированную непосредственно из интерфейса (а не из API), вам нужно указать параметр slug, так как в экспортированном json-файле нет раздела метаданных. | |
| state строка |
| Состояние панели. |
| uid строка добавлено в 1.0.0 от community.grafana | uid панели для экспорта, когда state равно export или absent. | |
| url строка / обязательно | URL Grafana. Псевдонимы: grafana_url | |
| url_password строка | По умолчанию: "admin" | Пароль Grafana для аутентификации API. Псевдонимы: grafana_password |
| url_username строка | По умолчанию: "admin" | Пользователь Grafana для аутентификации API. Псевдонимы: grafana_user |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены.Это следует установить только в no на сайтах с собственными сертификатами, которыми вы управляете. |
Примеры
- hosts: localhost
connection: local
tasks:
- 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: yes
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
dashbord_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: 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 строка | успех | uid или slug созданной/удаленной/экспортированной панели. Пример: 51 |
Авторы
- Thierry Sallé (@seuf)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/grafana/grafana_dashboard_module.html
