gitlab_group – Создаёт/обновляет/удаляет группы Gitlab

Новая версия 2.1.

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

Описание

Если группы в 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 Если не указано, будет использоваться group_name.
server_url строка		URL сервера GitLab с протоколом (например, http или https).
state строка	Варианты: present ← absent	создание или удаление группы. Возможные значения: present и absent.
validate_certs булево	Варианты: no yes ←	Требуется ли проверка SSL-сертификатов при использовании https-адреса.
visibility строка добавлено в 2.8	Варианты: private ← internal public	Видимость группы по умолчанию

Примеры

- name: "Delete Gitlab Group"
  gitlab_group:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    validate_certs: False
    name: my_first_group
    state: absent

- name: "Create Gitlab Group"
  gitlab_group:
    api_url: https://gitlab.example.com/
    validate_certs: True
    api_usersername: 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:
    api_url: https://gitlab.example.com/
    validate_certs: True
    api_usersername: dj-wasabi
    api_password: "MySecretPassword"
    name: my_first_group
    path: my_first_group
    state: present
    parent: "super_parent/parent"

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

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

Ключ	Возвращено	Описание
error строка	неудачно	сообщение об ошибке, возвращённое 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.8/modules/gitlab_group_module.html