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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.grafana.

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

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

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

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

Создание, обновление и удаление пользователей Grafana с помощью API пользователей и администраторов.
Проверено с Grafana v6.4.3
Обновление пароля пока не поддерживается

Параметры

Параметр	Комментарии
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для SSL-аутентификации клиента. Этот файл также может содержать ключ; если ключ включён в файл, параметр client_key не требуется
client_key путь	Файл в формате PEM, содержащий закрытый ключ, используемый для SSL-аутентификации клиента. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
email строка	Адрес электронной почты пользователя Grafana.
is_admin логический	Является ли пользователь Grafana администратором. Варианты: `false` ← (по умолчанию) `true`
login строка / обязательный	Имя входа пользователя Grafana.
name строка	Имя пользователя Grafana.
password строка	Пароль пользователя Grafana. На данный момент это поле ещё не обновляется.
state строка	Должен ли пользователь присутствовать в Grafana Варианты: `"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` ← (по умолчанию)

Примечания

Примечание

В отличие от других модулей коллекции, этот модуль не поддерживает тип аутентификации grafana_api_key. Для конечной точки API Grafana, управляющей пользователями, требуются базовая аутентификация и права администратора.

Примеры

---
- name: Create or update a Grafana user
  community.grafana.grafana_user:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    name: "Bruce Wayne"
    email: batman@gotham.city
    login: batman
    password: robin
    is_admin: true
    state: present

- name: Delete a Grafana user
  community.grafana.grafana_user:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    login: batman
    state: absent

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

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

Ключ	Описание
user составной	Информация о пользователе Возвращается: если state имеет значение present
email строка	Адрес электронной почты пользователя Возвращается: всегда Пример: `"['foo.bar@example.com']"`
id целое число	Идентификатор пользователя Возвращается: всегда Пример: `[42]`
isDisabled логический	Состояние учётной записи Grafana Возвращается: всегда Пример: `[false]`
isExternal логический	Информация об учётной записи Grafana во внешнем поставщике пользователей Возвращается: всегда Пример: `[false]`
isGrafanaAdmin логический	Права пользователя Grafana администратора Возвращается: всегда Пример: `[false]`
login строка	Имя входа пользователя Возвращается: всегда Пример: `"['batman']"`
orgId целое число	Идентификатор организации, к которой относится команда. Возвращается: всегда Пример: `[1]`
theme строка	Тема Grafana Возвращается: всегда Пример: `"['light']"`

Авторы

Antoine Tanzilli (@Tailzip)
Hong Viet LE (@pomverte)
Julien Alexandre (@jual)
Marc Cyprien (@LeFameux)

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

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