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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

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

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

Обзор

Если группа не существует в GitLab, она будет создана.
Если группа существует и state=absent, группа будет удалена.

Требования

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

python >= 2.7
модуль python-gitlab

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_password строка		Пароль для аутентификации с API
api_token строка		Токен GitLab для входа.
api_url строка		Доступный конечный пункт API.
api_username строка		Имя пользователя для аутентификации с API.
description строка		Описание группы.
name строка / обязательно		Имя группы, которую вы хотите создать.
parent строка		Разрешить создание подгрупп ID или полный путь родительской группы в формате group/name
path строка		Путь группы, которую вы хотите создать, он будет api_url/group_path. Если не указано, будет использовано group_name.
state строка	Варианты: present ← absent	создание или удаление группы. Возможные значения: present и absent.
validate_certs логическое	Варианты: no yes ←	Требовать проверку SSL-сертификатов при использовании https-точек входа.
visibility строка	Варианты: private ← internal public	Видимость группы по умолчанию

Примеры

- name: "Delete GitLab Group"
  community.general.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"
  community.general.gitlab_group:
    api_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"
  community.general.gitlab_group:
    api_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 от сервера

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gitlab_group_module.html