community.general.rundeck_job_executions_info 模块 – 查询 Rundeck 作业的执行情况

注意

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

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

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

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

community.general 3.8.0 中的新增功能

概要

  • 此模块获取指定 Rundeck 作业的执行列表。

参数

参数

注释

api_token

字符串 / 必需

Rundeck 用户 API 令牌。

api_version

整数

要使用的 Rundeck API 版本。

API 版本必须至少为 14。

默认值： 39

client_cert

路径

用于 SSL 客户端身份验证的 PEM 格式的证书链文件。

此文件也可以包含密钥，如果包含密钥，则不需要 client_key。

client_key

路径

PEM 格式的文件，其中包含用于 SSL 客户端身份验证的私钥。

如果 client_cert 同时包含证书和密钥，则不需要此选项。

force

布尔值

如果为 yes，则不获取缓存副本。

选项

  • false ← (默认)

  • true

force_basic_auth

布尔值

使用 url_username 和 url_password 指定的凭据应在 HTTP 标头中传递。

选项

  • false ← (默认)

  • true

http_agent

字符串

要标识的标头，通常出现在 Web 服务器日志中。

默认值： "ansible-httpget"

job_id

字符串 / 必需

作业的唯一 ID。

max

整数

要返回的最大结果数。

默认值： 20

offset

整数

返回结果的起始点。

默认值： 0

status

字符串

要过滤的作业状态。

选项

  • "succeeded"

  • "failed"

  • "aborted"

  • "running"

url

字符串 / 必需

Rundeck 实例 URL。

url_password

字符串

用于 HTTP 基本身份验证的密码。

如果未指定 url_username 参数，则不会使用 url_password 参数。

url_username

字符串

用于 HTTP 基本身份验证的用户名。

此参数可以在没有 url_password 的情况下用于允许空密码的站点。

use_gssapi

布尔值

在 ansible-core 2.11 中添加

使用 GSSAPI 执行身份验证，通常用于 Kerberos 或通过 Negotiate 身份验证的 Kerberos。

需要安装 Python 库 gssapi。

可以使用 url_username/url_password 或 GSSAPI 环境变量 KRB5CCNAME 来指定 GSSAPI 的凭据，该环境变量指定了自定义的 Kerberos 凭据缓存。

即使安装了 NTLM 的 GSSAPI 机制，也不支持 NTLM 身份验证。

选项

  • false ← (默认)

  • true

use_proxy

布尔值

如果设置为 no，则即使目标主机上的环境变量中定义了代理，也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果设置为 no，则不会验证 SSL 证书。

这应该仅在个人控制的使用自签名证书的站点上使用。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完全

此操作不会修改状态。

可以在 check_mode 中运行并返回已更改的状态预测，而无需修改目标。

diff_mode

支持: 不适用

此操作不会修改状态。

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

示例

- name: Get Rundeck job executions info
  community.general.rundeck_job_executions_info:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
  register: rundeck_job_executions_info

- name: Show Rundeck job executions info
  ansible.builtin.debug:
    var: rundeck_job_executions_info.executions

返回值

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

键

描述

executions

列表 / 元素=字典

作业执行列表。

返回: 总是

示例: [{"argstring": "-exit_code 0", "date-ended": {"date": "2021-10-06T13:05:18Z", "unixtime": 1633525518386}, "date-started": {"date": "2021-10-06T13:05:15Z", "unixtime": 1633525515026}, "description": "Plugin[com.batix.rundeck.plugins.AnsiblePlaybookInlineWorkflowStep, nodeStep: false]", "executionType": "user", "href": "https://rundeck.example.org/api/39/execution/1", "id": 1, "job": {"averageDuration": 6381, "description": "", "group": "", "href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "name": "Test", "options": {"exit_code": "0"}, "permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "project": "myproject"}, "permalink": "https://rundeck.example.org/project/myproject/execution/show/1", "project": "myproject", "serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068", "status": "succeeded", "user": "admin"}]

paging

字典

结果分页信息。

返回: 成功

示例: {"count": 20, "max": 20, "offset": 0, "total": 100}

count

整数

响应中的结果数。

返回: 成功

max

整数

每页的最大结果数。

返回: 成功

offset

整数

从所有结果的第一个的偏移量。

返回: 成功

total

整数

结果总数。

返回: 成功

作者

  • Phillipe Smith (@phsmith)