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

Примечание

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

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

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

Для использования в playbook, укажите: community.grafana.grafana_user.

Новое в community.grafana 1.0.0

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

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

Создание/обновление/удаление пользователя Grafana через API пользователей и администратора.
Тестировалось с Grafana v6.4.3
Обновление пароля на данный момент не поддерживается

Параметры

Параметр	Комментарии
client_cert path	Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL. Этот файл также может включать ключ, и если ключ включен, client_key не требуется
client_key path	Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
email string	Электронная почта пользователя Grafana.
is_admin boolean	Пользователь Grafana является администратором. Варианты: `false` ← (по умолчанию) `true`
login string / required	Логин пользователя Grafana.
name string	Имя пользователя Grafana.
password string	Пароль пользователя Grafana. На данный момент это поле ещё не обновляется.
state string	Состояние, присутствует ли пользователь в Grafana или нет Варианты: `"present"` ← (по умолчанию) `"absent"`
url aliases: grafana_url string / required	URL Grafana.
url_password aliases: grafana_password string	Пароль Grafana для аутентификации API. По умолчанию: `"admin"`
url_username aliases: grafana_user string	Пользователь Grafana для аутентификации API. По умолчанию: `"admin"`
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он определен в переменной окружения на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `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 сложный	Информация о пользователе Возвращается: при состоянии 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/grafana/grafana_user_module.html