Модуль community.grafana.grafana_dashboard — Управление панелями Grafana

Примечание

Этот модуль входит в коллекцию community.grafana (версия 1.9.1).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.grafana.

Для использования в плейбуке укажите: community.grafana.grafana_dashboard.

Новая функция в community.grafana 1.0.0

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Создание, обновление, удаление, экспорт панелей Grafana через API.

Параметры

Параметр	Комментарии
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL клиента. В этом файле также может быть указан ключ, и если ключ указан, параметр client_key не требуется.
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации SSL клиента. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
commit_message псевдонимы: message строка	Установите сообщение для истории версий. Используется только когда `state` равно `present`. Псевдоним `message` устарел в Ansible 2.10, так как используется внутренне Ansible Core Engine.
dashboard_id строка добавлен в community.grafana 1.0.0	Идентификатор публичной панели Grafana.com для импорта
dashboard_revision строка добавлен в community.grafana 1.0.0	Ревизия публичной панели grafana для импорта Значение по умолчанию: `"1"`
folder строка добавлен в community.grafana 1.0.0	Папка Grafana, в которую будет импортирована панель. Значение по умолчанию: `"General"`
grafana_api_key строка	Ключ API Grafana. Если задан, параметры `url_username` и `url_password` будут игнорироваться.
org_id целое число	Идентификатор организации Grafana, где панель будет импортирована/экспортирована/удалена. Не используется при установке grafana_api_key, так как grafana_api_key принадлежит только одной организации. Исключает возможность использования `org_name`. Значение по умолчанию: `1`
org_name строка	Имя организации Grafana, где будет импортирована/экспортирована/удалена панель. Не используется при установке grafana_api_key, так как grafana_api_key принадлежит только одной организации. Исключает возможность использования `org_id`.
overwrite булево	Перезаписать существующую панель при наличии состояния. Варианты: `false` ← (по умолчанию) `true`
path псевдонимы: dashboard_url строка	Путь к файлу json, содержащему панель Grafana для импорта или экспорта. Также принимается http URL (с версии 2.10). Требуется, если `state` равно `export` или `present`.
slug строка	Устарело с Grafana 5. Используйте uid панели Grafana вместо этого. slug панели. Это имя дружественного URL для панели. Если `state` равно `present`, этот параметр может переопределить slug в разделе meta файла json. Если вы хотите импортировать панель json, экспортированную напрямую из интерфейса (не из api), вам нужно указать параметр slug, так как в экспортированном json нет раздела meta.
state строка	Состояние панели. Варианты: `"absent"` `"export"` `"present"` ← (по умолчанию)
uid строка добавлен в community.grafana 1.0.0	uid панели для экспорта, когда `state` равно `export` или `absent`.
url псевдонимы: grafana_url строка / обязательно	URL Grafana.
url_password псевдонимы: grafana_password строка	Пароль Grafana для аутентификации API. Значение по умолчанию: `"admin"`
url_username псевдонимы: grafana_user строка	Имя пользователя Grafana для аутентификации API. Значение по умолчанию: `"admin"`

END_OF_DOCUMENT_MARKER

use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать только в `false` на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примеры

- 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: true
    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
    dashboard_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 string	uid или slug созданного/удаленного/экспортированного дашборда. Возвращается: успех Пример: `"51"`

Авторы

Thierry Sallé (@seuf)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/grafana/grafana_dashboard_module.html