community.general.jenkins_build_info 模块 – 获取关于 Jenkins 构建的信息

注意

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

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

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

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

community.general 7.4.0 版本新增

概要 

使用 Jenkins REST API 获取关于 Jenkins 构建的信息。

要求 

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

python-jenkins >= 0.4.12

参数 

参数	注释
build_number 整数	一个整数，指定作业的构建。如果未指定，将返回上次构建信息。
name 字符串 / 必填	构建所属的 Jenkins 作业的名称。
password 字符串	用于向 Jenkins 服务器进行身份验证的密码。
token 字符串	用于向 Jenkins 服务器进行身份验证的 API 令牌。
url 字符串	Jenkins 服务器的 URL。默认值: `"https://:8080"`
user 字符串	用于向 Jenkins 服务器进行身份验证的用户。

属性 

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

示例 

- name: Get information about a jenkins build using basic authentication
  community.general.jenkins_build_info:
    name: "test-check"
    build_number: 1
    user: admin
    password: asdfg
    url: https://:8080

- name: Get information about a jenkins build anonymously
  community.general.jenkins_build_info:
    name: "stop-check"
    build_number: 3
    url: https://:8080

- name: Get information about a jenkins build using token authentication
  community.general.jenkins_build_info:
    name: "delete-experiment"
    build_number: 30
    user: Jenkins
    token: abcdefghijklmnopqrstuvwxyz123456
    url: https://:8080

返回值 

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

键	描述
build_info 字典	jenkins 作业的构建信息。返回: 成功
name 字符串	jenkins 作业的名称。返回: 成功示例: `"test-job"`
state 字符串	jenkins 作业的状态。返回: 成功示例: `"present"`
url 字符串	连接到 Jenkins 服务器的 URL。返回: 成功示例: `"https://jenkins.mydomain.com"`
user 字符串	用于身份验证的用户。返回: 成功示例: `"admin"`

作者

Juan Casanova (@juanmcasanova)