community.general.rundeck_acl_policy 模块 – 管理 Rundeck ACL 策略

注意

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

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

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

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

概要 

通过 HTTP API 创建、更新和删除 Rundeck ACL 策略。

参数 

参数	注释
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 字符串 / 必需	设置项目名称。
policy 字符串	设置 ACL 策略内容。 ACL 策略内容是 YAML 对象，如 http://rundeck.org/docs/man5/aclpolicy.html 中所述。它可以是 YAML 字符串或纯 Ansible 清单 YAML 对象。
project 字符串	设置接收 ACL 策略的项目。如果未设置，则为系统 ACL 策略。
state 字符串	创建或删除 Rundeck 项目。选择 `"present"` ←（默认） `"absent"`
url 字符串 / 必需	HTTP、HTTPS 或 FTP URL，格式为 (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
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` 指定，或者使用 GSSAPI 环境变量 `KRB5CCNAME` 指定自定义 Kerberos 凭据缓存。即使安装了 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	支持：无	当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: Create or update a rundeck ACL policy in project Ansible
  community.general.rundeck_acl_policy:
    name: "Project_01"
    api_version: 18
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: present
    project: "Ansible"
    policy:
      description: "my policy"
      context:
        application: rundeck
      for:
        project:
          - allow: read
      by:
        group: "build"

- name: Remove a rundeck system policy
  community.general.rundeck_acl_policy:
    name: "Project_01"
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: absent

返回值 

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

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

作者

Loic Blot (@nerzhul)