community.grafana.grafana_folder – Управление папками Grafana

Примечание

Этот плагин входит в коллекцию community.grafana (версия 1.1.0).

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

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

Новое в версии 1.0.0: из community.grafana

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

Описание

Создание/обновление/удаление папок Grafana через API папок.
API папок доступен только начиная с Grafana 5, и модуль завершится ошибкой, если версия сервера ниже 5.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
client_cert путь		Файл цепочки сертификатов в формате PEM для аутентификации клиента по SSL. Этот файл также может содержать ключ, и если ключ включён, client_key не требуется
client_key путь		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации клиента по SSL. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется.
grafana_api_key строка		Ключ API Grafana. Если задано, `url_username` и `url_password` будут проигнорированы.
name строка / обязательно		Название папки Grafana. псевдонимы: title
state строка	Варианты: present ← absent	Удалить членов, отсутствующих в параметрах `members`, из списка членов, найденных в папке.
url строка / обязательно		URL Grafana. псевдонимы: grafana_url
url_password строка	По умолчанию: "admin"	Пароль Grafana для аутентификации по API. псевдонимы: grafana_password
url_username строка	По умолчанию: "admin"	Имя пользователя Grafana для аутентификации по API. псевдонимы: grafana_user
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать только для `no` используемых на сайтах, контролируемых лично, использующих самозаверенные сертификаты.

Примеры

---
- name: Create a folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: present

- name: Delete a folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: absent

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

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

Ключ		Возвращаемое значение	Описание
folder сложный		При успехе	Информация о папке
	canAdmin булево	всегда	Булево значение, указывающее, может ли текущий пользователь управлять папкой Пример: [False]
	canEdit булево	всегда	Булево значение, указывающее, может ли текущий пользователь редактировать папку Пример: [False]
	canSave булево	всегда	Булево значение, указывающее, может ли текущий пользователь сохранять в папке Пример: [False]
	created строка	всегда	Дата создания папки Пример: ['2018-01-31T17:43:12+01:00']
	createdBy строка	всегда	Имя пользователя, создавшего папку Пример: ['admin']
	hasAcl булево	всегда	Булево значение, указывающее, имеет ли папка политику доступа Пример: [False]
	id целое	всегда	Идентификатор папки Пример: [42]
	title строка	всегда	Название папки Пример: ['Отдел ABC']
	uid строка	всегда	uid папки Пример: ['nErXDvCkzz']
	updated строка	всегда	Дата последнего обновления папки Пример: ['2018-01-31T17:43:12+01:00']
	updatedBy строка	всегда	Имя пользователя, который последний раз обновил папку Пример: ['admin']
	url строка	всегда	URL папки Пример: ['/dashboards/f/nErXDvCkzz/department-abc']
	version целое	всегда	Версия папки Пример: [1]

Авторы

Rémi REY (@rrey)

© 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_folder_module.html