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

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: community.grafana.grafana_organization_user.

Новая функция в community.grafana 1.6.0

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

Описание

Добавление или удаление пользователей, изменение их ролей в организациях Grafana с помощью API org.
Пользователь должен существовать перед использованием этого модуля. См. https://docs.ansible.com/ansible/latest/collections/community/grafana/grafana_user_module.html.

Параметры

Параметр	Комментарии
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для проверки подлинности клиента SSL. Этот файл также может содержать ключ, и если ключ включён, client_key не требуется
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ, используемый для проверки подлинности клиента SSL. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
login строка / обязательно	Имя пользователя или адрес электронной почты.
org_id целое число	Идентификатор организации. Взаимоисключающий с `org_name`. По умолчанию: `1`
org_name строка	Имя организации. Взаимоисключающий с `org_id`.
role строка	Роль пользователя в организации. Варианты: `"viewer"` ← (по умолчанию) `"editor"` `"admin"`
state строка	Статус членства пользователя в организации. Варианты: `"present"` ← (по умолчанию) `"absent"`
url aliases: grafana_url строка / обязательно	URL Grafana.
url_password aliases: grafana_password строка	Пароль Grafana для аутентификации API. По умолчанию: `"admin"`
url_username aliases: grafana_user строка	Имя пользователя Grafana для аутентификации API. По умолчанию: `"admin"`
use_proxy логическое значение	Если `false`, прокси не будет использоваться, даже если она определена в переменной окружения на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Если `false`, сертификаты SSL не будут проверяться. Это следует устанавливать в значение `false` только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Варианты: `false` `true` ← (по умолчанию)

Примеры

---
- name: Add user to organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    role: admin

- name: Remove user from organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    state: absent

Значения возврата

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

Ключ	Описание
user сложный	Информация о пользователе организации Возвращается: при состоянии present
email строка	Электронный адрес пользователя Возвращается: всегда Пример: `"['foo.bar@example.com']"`
login строка	Логин пользователя Возвращается: всегда Пример: `"['batman']"`
name строка	Имя пользователя (совпадает с логином) Возвращается: всегда Пример: `"['batman']"`
orgId целое число	Идентификатор организации, к которой относится команда. Возвращается: всегда Пример: `[1]`
role строка	Роль пользователя в организации Возвращается: всегда Может возвращать только: `"Viewer"` `"Editor"` `"Admin"` Пример: `"['Viewer']"`

Авторы

Алиаксандр Мянжинский (@amenzhinsky)

Ссылки на сборку

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