community.general.jenkins_build 模块 – 管理 Jenkins 构建

注意

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

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

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

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

community.general 2.2.0 中的新功能

概要

  • 使用 Jenkins REST API 管理 Jenkins 构建。

要求

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

  • python-jenkins >= 0.4.12

参数

参数

注释

args

字典

要传递给构建的参数列表。

build_number

整数

一个整数，指定作业的构建。需要从队列中删除构建。

detach

布尔值

在 community.general 7.4.0 中添加

启用分离模式，不等待构建结束。

选择

  • false ←（默认）

  • true

name

字符串 / 必需

要构建的 Jenkins 作业的名称。

password

字符串

用于向 Jenkins 服务器进行身份验证的密码。

state

字符串

指定是否要创建、删除或停止构建的属性。

stopped 状态已在 community.general 3.3.0 中添加。

选择

  • "present" ←（默认）

  • "absent"

  • "stopped"

time_between_checks

整数

在 community.general 7.4.0 中添加

请求 Jenkins 服务器之间等待的时间（以秒为单位）。

此时间必须高于为作业配置的静默时间。

默认： 10

token

字符串

用于向 Jenkins 服务器进行身份验证的 API 令牌。

url

字符串

Jenkins 服务器的 URL。

默认： "https://:8080"

user

字符串

用于向 Jenkins 服务器进行身份验证的用户。

属性

属性

支持

描述

check_mode

支持：无

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

diff_mode

支持：无

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

示例

- name: Create a jenkins build using basic authentication
  community.general.jenkins_build:
    name: "test-check"
    args:
      cloud: "test"
      availability_zone: "test_az"
    state: present
    user: admin
    password: asdfg
    url: https://:8080

- name: Stop a running jenkins build anonymously
  community.general.jenkins_build:
    name: "stop-check"
    build_number: 3
    state: stopped
    url: https://:8080

- name: Delete a jenkins build using token authentication
  community.general.jenkins_build:
    name: "delete-experiment"
    build_number: 30
    state: absent
    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"

作者

  • Brett Milford (@brettmilford)

  • Tong He (@unnecessary-username)

  • Juan Casanova (@juanmcasanova)