Модуль community.grafana.grafana_organization_user — управление пользователями организаций Grafana.
Примечание
Этот модуль входит в коллекцию community.grafana (версия 2.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 организации.
- Перед использованием этого модуля пользователь должен существовать. См. 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 строка | Название организации. Взаимоисключающий параметр с |
role строка | Роль пользователя в организации. Варианты:
|
state строка | Состояние членства пользователя в организации. Варианты:
|
url псевдонимы: grafana_url строка / обязательный | URL-адрес Grafana. |
url_password псевдонимы: grafana_password строка | Пароль Grafana для аутентификации через API. По умолчанию: |
url_username псевдонимы: grafana_user строка | Имя пользователя Grafana для аутентификации через API. По умолчанию: |
use_proxy логический | Если Варианты:
|
validate_certs логический | Если Устанавливайте значение Варианты:
|
Примеры
---
- 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 сложный тип | Сведения о пользователе организации Возвращается: если state имеет значение present |
|
строка |
Адрес электронной почты пользователя Возвращается: всегда Пример: |
|
login строка |
Логин пользователя Возвращается: всегда Пример: |
|
name строка |
Имя пользователя (совпадает с логином) Возвращается: всегда Пример: |
|
orgId целое число |
Идентификатор организации, к которой относится команда. Возвращается: всегда Пример: |
|
role строка |
Роль пользователя в организации Возвращается: всегда Возможные значения:
Пример: |
Ссылки на коллекцию
© 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_organization_user_module.html