Модуль community.grafana.grafana_folder — управление папками Grafana

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.grafana. Для использования этого модуля также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.grafana.grafana_folder.

Добавлено в community.grafana 1.0.0

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление и удаление папок 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 псевдонимы: title строка / обязательный	Название папки Grafana.
org_id целое число	ID организации Grafana, в которой следует создать источник данных. Не используется, если задан `grafana_api_key`, поскольку `grafana_api_key` относится только к одной организации. Не может использоваться вместе с `org_name`. По умолчанию: `1`
org_name строка	Название организации Grafana, в которой следует создать источник данных. Не используется, если задан `grafana_api_key`, поскольку `grafana_api_key` относится только к одной организации. Не может использоваться вместе с `org_id`.
parent_uid строка	UID родительской папки. Доступно при использовании функции вложенных папок в Grafana 11.
skip_version_check логическое значение добавлено в community.grafana 1.2.0	Пропустить проверку версии Grafana и в любом случае попробовать обратиться к конечной точке API. Этот параметр может быть полезен, если в grafana.ini включен `hide_version`. Варианты: `false` ← (по умолчанию) `true`
state строка	Удалить участников, не указанных в параметрах `members`, из списка участников папки. Варианты: `"present"` ← (по умолчанию) `"absent"`
uid строка	UID папки.
url псевдонимы: grafana_url строка / обязательный	URL Grafana.
url_password псевдонимы: grafana_password строка	Пароль Grafana для аутентификации через API. По умолчанию: `"admin"`
url_username псевдонимы: grafana_user строка	Имя пользователя Grafana для аутентификации через API. По умолчанию: `"admin"`
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Если `false`, SSL-сертификаты проверяться не будут. Задавайте значение `false` только для контролируемых вами сайтов, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примеры

---
- 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 логическое значение	Логическое значение, указывающее, настроен ли для папки ACL Возвращается: всегда Пример: `[false]`
id целое число	Идентификатор папки Возвращается: всегда Пример: `[42]`
orgId целое число	ID организации Возвращается: всегда Пример: `[1]`
parentUid строка	UID родительской папки Возвращается: всегда для вложенной папки Пример: `"['76HjcBH2']"`
title строка	Название папки Возвращается: всегда Пример: `"['Department 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/grafana/grafana_folder_module.html