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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 целое число	Идентификатор организации Grafana, в которой должна быть создана папка. Не используется, когда `grafana_api_key` задан, так как папка принадлежит только одной организации. Взаимоисключительно с `org_name`. По умолчанию: `1`
org_name строка	Имя организации Grafana, в которой должна быть создана папка. Не используется, когда `grafana_api_key` задан, так как папка принадлежит только одной организации. Взаимоисключительно с `org_id`.
skip_version_check логическое значение добавлено в community.grafana 1.2.0	Пропустить проверку версии Grafana и попытаться получить доступ к конечной точке API независимо от версии. Этот параметр может быть полезен, если вы включили `hide_version` в grafana.ini. Варианты: `false` ← (по умолчанию) `true`
state строка	Удалить членов, отсутствующих в параметрах `members`, из списка членов, найденных в папке. Варианты: `"present"` ← (по умолчанию) `"absent"`
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]`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/grafana/grafana_folder_module.html