community.general.gitlab_project_members 模块 – 在 GitLab 服务器上管理项目成员

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，有关详细信息，请参阅需求。

要在 playbook 中使用它，请指定：community.general.gitlab_project_members。

community.general 2.2.0 中的新增功能

概要 

此模块允许向 GitLab 项目添加和删除成员，或更改项目中成员的访问级别。

需求 

执行此模块的主机需要以下需求。

GitLab 服务器上项目的拥有者或维护者权限
python-gitlab python 模块 <= 1.15.0
requests (Python 库 https://pypi.ac.cn/project/requests/)

参数 

参数	注释
access_level 字符串	用户的访问级别。如果 `state=present`，用户状态设置为 present，则为必填。选项 `"guest"` `"reporter"` `"developer"` `"maintainer"`
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 字符串	具有 API 权限的 GitLab 访问令牌。
api_url 字符串	API 的可解析端点。
api_username 字符串	用于针对 API 进行身份验证的用户名。
ca_path 字符串 community.general 8.1.0 中新增	用于验证 GitLab 服务器证书的 CA 证书捆绑包。
gitlab_user 列表 / 元素=字符串	要添加到/从 GitLab 项目中删除的用户名或用户名列表。与 `gitlab_users_access` 互斥。
gitlab_users_access 列表 / 元素=字典 community.general 3.7.0 中新增	提供用户到访问级别映射的列表。此列表中的每个字典都指定一个用户（按用户名）以及用户应具有的访问级别。与 `gitlab_user` 和 `access_level` 互斥。与 `purge_users` 一起使用，以删除此处未指定的项目中的所有用户。
access_level 字符串 / 必填	用户的访问级别。如果 `state=present`，用户状态设置为 present，则为必填。选项 `"guest"` `"reporter"` `"developer"` `"maintainer"`
name 字符串 / 必填	要添加到/从 GitLab 项目中删除的用户名或用户名列表。
project 字符串 / 必填	添加或删除成员的 GitLab 项目的名称（或完整路径）。
purge_users 列表 / 元素=字符串 community.general 3.7.0 中新增	添加/删除给定 access_level 的用户以匹配给定的 `gitlab_user`/`gitlab_users_access` 列表。如果省略，则不清除孤立的成员。仅在 `state=present` 时使用。选项 `"guest"` `"reporter"` `"developer"` `"maintainer"`
state 字符串	项目中成员的状态。在 `present` 上，它将用户添加到 GitLab 项目。在 `absent` 上，它将用户从 GitLab 项目中删除。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	是否在提供 HTTPS 端点时验证 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 模式下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在 diff 模式下，将返回关于已更改内容（或在 `check_mode` 模式下可能需要更改的内容）的详细信息。

示例 

- name: Add a user to a GitLab Project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    validate_certs: true
    project: projectname
    gitlab_user: username
    access_level: developer
    state: present

- name: Remove a user from a GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_user: username
    state: absent

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

- name: Add a list of Users with Dedicated Access Levels to A GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    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_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_user: username
    access_level: developer
    purge_users: developer
    state: present

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

作者

Sergey Mikhaltsov (@metanovii)
Zainab Alsaffar (@zanssa)