Модуль community.general.gitlab_group_members — управление участниками группы на сервере GitLab

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.gitlab_group_members.

Добавлено в community.general 1.2.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

Этот модуль позволяет добавлять и удалять участников группы, а также изменять уровень доступа участника в группе на GitLab.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

права администратора на сервере GitLab
модуль Python python-gitlab <= 1.15.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
access_level string	Уровень доступа пользователя. Обязателен, если `state=present`, а состояние пользователя установлено в present. Взаимоисключающий параметр с `gitlab_users_access`. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"` `"owner"`
api_job_token string добавлено в community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token string добавлено в community.general 4.2.0	Токен OAuth GitLab для входа.
api_password string	Пароль для аутентификации в API.
api_token string	Токен доступа GitLab с разрешениями API.
api_url string	Доступная конечная точка API.
api_username string	Имя пользователя для аутентификации в API.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
gitlab_group string / обязательный	`full_path` группы GitLab, в которую добавляется участник или из которой он удаляется. Использование значения `name` или `path` запрещено начиная с community.general 6.0.0. Вместо этого используйте `full_path`.
gitlab_user list / элементы=string	Имя пользователя или список имён пользователей для добавления в группу GitLab или удаления из неё. Взаимоисключающий параметр с `gitlab_users_access`.
gitlab_users_access list / элементы=dictionary добавлено в community.general 3.6.0	Укажите список соответствий пользователей и уровней доступа. Каждый словарь в этом списке задаёт пользователя (по имени пользователя) и уровень доступа, который должен быть ему назначен. Взаимоисключающий параметр с `gitlab_user` и `access_level`. Используйте вместе с `purge_users`, чтобы удалить из группы всех пользователей, не указанных здесь.
access_level string / обязательный	Уровень доступа пользователя. Обязателен, если `state=present`, а состояние пользователя установлено в present. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"` `"owner"`
name string / обязательный	Имя пользователя или список имён пользователей для добавления в группу GitLab или удаления из неё.
purge_users list / элементы=string добавлено в community.general 3.6.0	Добавляет или удаляет пользователей с указанным access_level, чтобы привести список к заданному `gitlab_user`/`gitlab_users_access`. Если параметр не указан, лишние участники не удаляются. Используется только при `state=present`. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"` `"owner"`
state string	Состояние участника в группе. При значении `present` пользователь добавляется в группу GitLab. При значении `absent` пользователь удаляется из группы GitLab. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли сертификаты SSL при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `check_mode`).

Примеры

- name: Add a user to a GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user: username
    access_level: developer
    state: present

- name: Remove a user from a GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user: username
    state: absent

- name: Add a list of Users to A GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user:
      - user1
      - user2
    access_level: developer
    state: present

- name: Add a list of Users with Dedicated Access Levels to A GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_users_access:
      - name: user1
        access_level: developer
      - name: user2
        access_level: maintainer
    state: present

- name: Add a user, remove all others which might be on this access level
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user: username
    access_level: developer
    pruge_users: developer
    state: present

- name: Remove a list of Users with Dedicated Access Levels to A GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_users_access:
      - name: user1
        access_level: developer
      - name: user2
        access_level: maintainer
    state: absent

Авторы

Zainab Alsaffar (@zanssa)

Ссылки на коллекцию

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