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

Примечание

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

У вас, возможно, эта коллекция уже установлена, если вы используете пакет 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-gitlab модуль python <= 1.15.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

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

Атрибуты

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_group_members_module.html