community.general.gitlab_user – Создаёт/обновляет/удаляет/блокирует/разблокирует пользователей GitLab

Примечание

Этот плагин входит в сборку community.general (версия 1.3.2).

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

Для использования в книге задач укажите: community.general.gitlab_user.

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

Обзор

Если пользователь не существует в GitLab, он будет создан.
Если пользователь существует и состояние=отсутствует, пользователь будет удалён.
Если пользователь существует и состояние=заблокирован, пользователь будет заблокирован.
Если вносятся изменения в данные пользователя, пользователь будет обновлён.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
модуль python-gitlab
права администратора на сервере GitLab

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_level строка	Варианты: guest ← reporter developer master maintainer owner	Уровень доступа к группе. Можно использовать один из следующих вариантов. guest reporter developer master (псевдоним для maintainer) maintainer owner
api_password строка		Пароль для аутентификации на API
api_token строка		Токен GitLab для входа.
api_url строка		Доступный конечный пункт для API
api_username строка		Имя пользователя для аутентификации на API
confirm логический тип	Варианты: no yes ←	Требуется подтверждение.
email строка		Электронный адрес пользователя. Требуется только если `state` установлено в `present`.
external логический тип	Варианты: no ← yes	Определить внешний параметр для этого пользователя.
group строка		ID или полный путь родительской группы в формате group/name. Добавить пользователя в качестве члена этой группы.
isadmin логический тип	Варианты: no ← yes	Предоставить пользователю права администратора.
name строка		Имя пользователя, которого вы хотите создать. Требуется только если `state` установлено в `present`.
password строка		Пароль пользователя. Сервер GitLab требует минимальную длину пароля 8 символов, установите значение не менее 8 символов. Требуется только если `state` установлено в `present`.
sshkey_file строка		Сам SSH-ключ.
sshkey_name строка		Имя SSH-ключа.
state строка	Варианты: present ← absent blocked unblocked	Создать, удалить или заблокировать пользователя.
username строка / обязательно		Имя пользователя.
validate_certs логический тип	Варианты: no yes ←	Выполнять ли проверку SSL-сертификатов при использовании https-адреса.

Примечания

Примечание

Начиная с community.general 0.2.0 и выше, имя, электронная почта и пароль необязательны при удалении пользователя.

Примеры

- name: "Delete GitLab User"
  community.general.gitlab_user:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    validate_certs: False
    username: myusername
    state: absent

- name: "Create GitLab User"
  community.general.gitlab_user:
    api_url: https://gitlab.example.com/
    validate_certs: True
    api_username: dj-wasabi
    api_password: "MySecretPassword"
    name: My Name
    username: myusername
    password: mysecretpassword
    email: me@example.com
    sshkey_name: MySSH
    sshkey_file: ssh-rsa AAAAB3NzaC1yc...
    state: present
    group: super_group/mon_group
    access_level: owner

- name: "Block GitLab User"
  community.general.gitlab_user:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    validate_certs: False
    username: myusername
    state: blocked

- name: "Unblock GitLab User"
  community.general.gitlab_user:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    validate_certs: False
    username: myusername
    state: unblocked

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

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

Ключ	Возвращаемое значение	Описание
error строка	failed	Сообщение об ошибке, возвращенное API GitLab Пример: 400: путь уже используется
msg строка	всегда	Сообщение об успехе или неудаче Пример: Успех
result словарь	всегда	Обработанный в формате json ответ сервера
user словарь	всегда	Объект API

Авторы

Werner Dijkerman (@dj-wasabi)
Guillaume Martinez (@Lunik)

© 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/general/gitlab_user_module.html