community.general.rundeck_project 模块 – 管理 Rundeck 项目

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。

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

概要 

通过 HTTP API 创建和删除 Rundeck 项目。

参数 

参数	注释
api_token 别名：token 字符串 / 必需	设置用于对 Rundeck API 进行身份验证的令牌。
api_version 整数	要使用的 Rundeck API 版本。 API 版本必须至少为 14。默认值： `39`
client_cert 路径在 community.general 0.2.0 中添加	PEM 格式的证书链文件，用于 SSL 客户端身份验证。此文件也可以包含密钥，如果包含密钥，则不需要 `client_key`。
client_key 路径在 community.general 0.2.0 中添加	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 `client_cert` 同时包含证书和密钥，则此选项不是必需的。
force 布尔值在 community.general 0.2.0 中添加	如果 `yes`，则不获取缓存副本。选项 `false` ←（默认值） `true`
force_basic_auth 布尔值在 community.general 0.2.0 中添加	使用 `url_username` 和 `url_password` 指定的凭据应在 HTTP 标头中传递。选项 `false` ←（默认值） `true`
http_agent 字符串在 community.general 0.2.0 中添加	要标识为的标头，通常出现在 Web 服务器日志中。默认值： `"ansible-httpget"`
name 字符串 / 必需	设置项目名称。
state 字符串	创建或删除 Rundeck 项目。选项 `"present"` ←（默认值） `"absent"`
url 字符串 / 必需	形式为 (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path 的 HTTP、HTTPS 或 FTP URL
url_password 字符串在 community.general 0.2.0 中添加	用于 HTTP 基本身份验证的密码。如果未指定 `url_username` 参数，则不会使用 `url_password` 参数。
url_username 字符串在 community.general 0.2.0 中添加	用于 HTTP 基本身份验证的用户名。此参数可以在允许空密码的站点上不使用 `url_password` 的情况下使用
use_gssapi 布尔值在 ansible-core 2.11 中添加	使用 GSSAPI 执行身份验证，通常用于 Kerberos 或通过协商身份验证的 Kerberos。需要安装 Python 库 gssapi。 GSSAPI 的凭据可以使用 `url_username`/`url_password` 或指定自定义 Kerberos 凭据缓存的 GSSAPI 环境变量 `KRB5CCNAME` 来指定。即使已安装 NTLM 的 GSSAPI 机制，也不支持 NTLM 身份验证。选项 `false` ←（默认值） `true`
use_proxy 布尔值在 community.general 0.2.0 中添加	如果为 `no`，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。选项 `false` `true` ←（默认值）
validate_certs 布尔值在 community.general 0.2.0 中添加	如果为 `no`，则不会验证 SSL 证书。这应仅用于使用自签名证书的个人控制站点。选项 `false` `true` ←（默认值）

属性 

属性	支持	描述
check_mode	支持：完全	可以在 `check_mode` 中运行，并返回更改的状态预测，而无需修改目标。
diff_mode	支持: 无	当处于差异模式时，将返回已更改（或在 `check_mode` 中可能需要更改）的详细信息。

示例 

- name: Create a rundeck project
  community.general.rundeck_project:
    name: "Project_01"
    label: "Project 01"
    description: "My Project 01"
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    state: present

- name: Remove a rundeck project
  community.general.rundeck_project:
    name: "Project_01"
    url: "https://rundeck.example.org"
    api_token: "mytoken"
    state: absent

返回值 

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

键	描述
after 字典	包含修改后项目信息的字典返回: 成功
before 字典	包含修改前项目信息的字典返回: 成功
rundeck_response 字符串	发生故障时 Rundeck 的响应返回: 失败

作者

Loic Blot (@nerzhul)