gitlab_user – Создаёт/обновляет/удаляет пользователей GitLab
Описание
- Если пользователь не существует в GitLab, он будет создан.
- Если пользователь существует и значение state=absent, пользователь будет удалён.
- Если вносятся изменения в пользователя, пользователь будет обновлён.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- python-gitlab python module <= 1.12.1
- права администратора на сервере GitLab
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_level строка |
| Уровень доступа к группе. Можно использовать одно из следующих значений. guest reporter developer master (псевдоним для maintainer) maintainer owner |
| api_password строка | Пароль для аутентификации по API | |
| api_token строка | Токен GitLab для входа. псевдонимы: login_token | |
| api_url строка | Адрес конечной точки API | |
| api_username строка | Имя пользователя для аутентификации по API | |
| confirm логическое добавлено в 2.4 |
| Требовать подтверждения. |
| email строка / обязательно | Электронный адрес пользователя. | |
| external логическое добавлено в 2.8 |
| Определить внешний параметр для этого пользователя |
| group строка | ID или полный путь родительской группы в формате group/name Добавить пользователя в качестве члена этой группы. | |
| isadmin логическое добавлено в 2.8 |
| Предоставление административных привилегий пользователю |
| login_password строка | Пароль GitLab для входа в систему | |
| login_user строка | Имя пользователя GitLab. | |
| name строка / обязательно | Имя пользователя, которое нужно создать | |
| password строка / обязательно | Пароль пользователя. Сервер GitLab требует минимальную длину пароля 8 символов, установите значение не менее 8 символов. | |
| server_url строка | URL сервера GitLab с протоколом (например, http или https). | |
| sshkey_file строка | Сам SSH-ключ. | |
| sshkey_name строка | Имя SSH-ключа | |
| state строка |
| создание или удаление группы. Возможные значения: present и absent. |
| username строка / обязательно | Имя пользователя. | |
| validate_certs логическое |
| Требовать валидацию SSL-сертификатов при использовании https-адреса. |
Примеры
- name: "Delete GitLab User"
gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
username: myusername
state: absent
delegate_to: localhost
- name: "Create GitLab User"
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
delegate_to: localhost
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| error строка | неудачно | сообщение об ошибке, возвращённое API GitLab Пример: 400: путь уже используется |
| msg строка | всегда | Сообщение об успехе или неудаче Пример: Успешно |
| result словарь | всегда | ответ от сервера в формате json |
| user словарь | всегда | объект API |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gitlab_user_module.html
