community.grafana.grafana_user – Управление пользователем Grafana
Примечание
Этот плагин входит в коллекцию community.grafana (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install community.grafana.
Для использования в книге задач укажите: community.grafana.grafana_user.
В версии 1.0.0: коллекции community.grafana
Обзор
- Создание/обновление/удаление пользователя Grafana через API пользователей и администраторов.
- Проверено с Grafana v6.4.3
- Обновление пароля в настоящее время не поддерживается
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| client_cert путь | Файл цепочки сертификатов в формате PEM, используемый для проверки подлинности клиента SSL. Этот файл также может содержать ключ, и если ключ включён, параметр client_key не требуется. | |
| client_key путь | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для проверки подлинности клиента SSL. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется. | |
| email строка | Электронная почта пользователя Grafana. | |
| is_admin булево |
| Пользователь Grafana является администратором. |
| login строка / обязательно | Логин пользователя Grafana. | |
| name строка | Имя пользователя Grafana. | |
| password строка | Пароль пользователя Grafana. В данный момент это поле ещё не обновлено. | |
| state строка |
| Состояние, определяющее, должен ли пользователь присутствовать в Grafana. |
| url строка / обязательно | URL Grafana. Псевдонимы: grafana_url | |
| url_password строка | Значение по умолчанию: "admin" | Пароль Grafana для аутентификации API. Псевдонимы: grafana_password |
| url_username строка | Значение по умолчанию: "admin" | Имя пользователя Grafana для аутентификации API. Псевдонимы: grafana_user |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверяться.Это должно быть установлено только для сайтов, используемых на лично контролируемых сайтах с самозаверенными сертификатами. |
Примеры
---
- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/grafana/grafana_user_module.html
