community.general.gitlab_project_access_token 模块 – 管理 GitLab 项目访问令牌

注意

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

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

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

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

community.general 8.4.0 中的新增功能

概要

  • 创建和撤销项目访问令牌。

要求

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

参数

参数

注释

access_level

字符串

访问令牌的访问级别。

选项

  • "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

字符串

具有 API 权限的 GitLab 访问令牌。

api_url

字符串

API 的可解析端点。

api_username

字符串

用于对 API 进行身份验证的用户名。

ca_path

字符串

community.general 8.1.0 中新增

用于验证 GitLab 服务器证书的 CA 证书包。

expires_at

字符串 / 必需

访问令牌的过期日期，格式为 YYYY-MM-DD。

确保在 YAML 中用引号引起来此值，以确保将其保留为字符串，而不是解释为 YAML 日期。

name

字符串 / 必需

访问令牌的名称。

project

字符串 / 必需

项目的 ID 或完整路径，格式为 group/name。

recreate

字符串

如果访问令牌已存在，是否会重新创建。

当 never 时，令牌永远不会重新创建。

当 always 时，令牌将始终重新创建。

当 state_change 时，如果期望状态和实际状态之间存在差异，则将重新创建令牌。

选项

  • "never" ← (默认)

  • "always"

  • "state_change"

scopes

别名：scope

列表 / 元素=字符串 / 必需

访问令牌的范围。

选项

  • "api"

  • "read_api"

  • "read_registry"

  • "write_registry"

  • "read_repository"

  • "write_repository"

  • "create_runner"

  • "ai_features"

  • "k8s_proxy"

state

字符串

当 present 时，如果访问令牌不存在，则将其添加到项目中。

当 absent 时，如果它存在，则将其从项目中删除。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

提供 HTTPS 端点时是否验证 SSL 证书。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 模式下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

处于 diff 模式时，将返回有关已更改内容（或可能需要在 check_mode 模式下更改的内容）的详细信息。

备注

注意

  • 访问令牌无法更改。如果需要更改参数，则必须重新创建访问令牌。是否重新创建令牌由 recreate 选项控制，其默认值为 never。

  • 只有在创建或重新创建访问令牌时，令牌字符串才会包含在结果中。之后无法获取它。

  • 令牌匹配是通过比较 name 选项来完成的。

示例

- name: "Creating a project access token"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    access_level: developer
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: present

- name: "Revoking a project access token"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: absent

- name: "Change (recreate) existing token if its actual state is different than desired state"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    recreate: state_change
    state: present

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

access_token

字典

API 对象。

只有在创建或重新创建令牌时才包含令牌的值。

返回：成功且 state=present

作者

  • Zoran Krleza (@pixslx)