gitlab_group – Создаёт/обновляет/удаляет группы GitLab
Описание
- Если группы нет в GitLab, она будет создана.
- Если группа существует, и значение state=absent, группа будет удалена.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- python-gitlab модуль python <= 1.12.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль для аутентификации с API | |
| api_token строка | Токен GitLab для входа. псевдонимы: login_token | |
| api_url строка | Доступный конечный пункт API | |
| api_username строка | Имя пользователя для аутентификации с API | |
| description строка добавлено в 2.7 | Описание группы. | |
| login_password строка | Пароль GitLab для login_user | |
| login_user строка | Имя пользователя GitLab. | |
| name строка / обязательно | Имя группы, которую вы хотите создать. | |
| parent строка добавлено в 2.8 | Разрешить создание подгрупп Идентификатор или полный путь родительской группы в формате group/name | |
| path строка | Путь группы, которую вы хотите создать, это будет server_url/group_path Если не указано, будет использовано имя группы. | |
| server_url строка | URL сервера GitLab с протоколом (например, http или https). | |
| state строка |
| создать или удалить группу. Возможные значения: present и absent. |
| validate_certs булево |
| Требовать проверку сертификатов SSL при использовании https-адреса. |
| visibility строка добавлено в 2.8 |
| Видимость группы по умолчанию |
Примеры
- name: "Delete GitLab Group"
gitlab_group:
server_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
name: my_first_group
state: absent
- name: "Create GitLab Group"
gitlab_group:
server_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi
api_password: "MySecretPassword"
name: my_first_group
path: my_first_group
state: present
# The group will by created at https://gitlab.dj-wasabi.local/super_parent/parent/my_first_group
- name: "Create GitLab SubGroup"
gitlab_group:
server_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi
api_password: "MySecretPassword"
name: my_first_group
path: my_first_group
state: present
parent: "super_parent/parent"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| error строка | failed | сообщение об ошибке, возвращённое API GitLab Пример: 400: путь уже используется |
| group словарь | всегда | объект API |
| msg строка | всегда | Успех или сообщение об ошибке Пример: Успех |
| result словарь | всегда | Обработанный ответ сервера в формате JSON |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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_group_module.html
