Spec-Zone.ru › Ansible 2.6

grafana_dashboard - Управление панелями Grafana

Новое в версии 2.5.

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
grafana_api_key
Ключ API Grafana.
Если задано, grafana_user и grafana_password будут проигнорированы.
grafana_password Значение по умолчанию:
"admin"
Пароль API Grafana.
grafana_url
обязательно
URL Grafana.
grafana_user Значение по умолчанию:
"admin"
Пользователь API Grafana.
message
Установите сообщение для истории версий.
Используется только тогда, когда state равно present.
org_id Значение по умолчанию:
1
Идентификатор организации Grafana, где панель будет импортирована/экспортирована.
Не используется, когда задан grafana_api_key, так как grafana_api_key относится только к одной организации.
overwrite
bool
    Варианты:
  • нет ←
  • да
Перезаписывать существующую панель, если состояние присутствует.
path
Путь к файлу json с панелью Grafana для импорта или экспорта.
slug
Идентификатор (slug) панели. Это имя панели для удобного URL.
Когда state равно present, этот параметр может переопределить slug в разделе метаданных файла json.
Если вы хотите импортировать json-панель, экспортированную непосредственно из интерфейса (а не из API), вам необходимо указать параметр slug, так как в экспортированном json нет раздела метаданных.
state
обязательно
    Варианты:
  • absent
  • экспорт
  • present ←
Состояние панели.
validate_certs
bool
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены.
Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Примеры

- name: Import Grafana dashboard foo
  grafana_dashboard:
    grafana_url: http://grafana.company.com
    grafana_api_key: XXXXXXXXXXXX
    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_api_key: XXXXXXXXXXXX
    state: export
    slug: foo
    path: /path/to/dashboards/foo.json

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
slug
строка
успех
Идентификатор (slug) созданной/удаленной/экспортированной панели.

Пример:
foo


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

  • Thierry Sallé (@tsalle)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/grafana_dashboard_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API