community.general.jenkins_job_info 模块 – 获取 Jenkins 作业的信息

注意

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

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

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

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

概要

  • 此模块可用于查询有关已存在的 Jenkins 作业的信息。

要求

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

  • python-jenkins >= 0.4.12

参数

参数

注释

color

字符串

仅获取具有给定状态颜色的作业。

glob

字符串

要获取信息的 Jenkins 作业名称的 shell glob。

name

字符串

要获取信息的 Jenkins 作业的确切名称。

password

字符串

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

这与 token 互斥。

token

字符串

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

这与 password 互斥。

url

字符串

可以访问 Jenkins 服务器的 URL。

默认： "https://127.0.0.1:8080"

user

字符串

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← （默认）

属性

属性

支持

描述

check_mode

支持：完整

此操作不修改状态。

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

diff_mode

支持： 不适用

此操作不修改状态。

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

示例

# Get all Jenkins jobs anonymously
- community.general.jenkins_job_info:
    user: admin
  register: my_jenkins_job_info

# Get all Jenkins jobs using basic auth
- community.general.jenkins_job_info:
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get all Jenkins jobs using the token
- community.general.jenkins_job_info:
    user: admin
    token: abcdefghijklmnop
  register: my_jenkins_job_info

# Get info about a single job using basic auth
- community.general.jenkins_job_info:
    name: some-job-name
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about a single job in a folder using basic auth
- community.general.jenkins_job_info:
    name: some-folder-name/some-job-name
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about jobs matching a shell glob using basic auth
- community.general.jenkins_job_info:
    glob: some-job-*
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about all failing jobs using basic auth
- community.general.jenkins_job_info:
    color: red
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about passing jobs matching a shell glob using basic auth
- community.general.jenkins_job_info:
    name: some-job-*
    color: blue
    user: admin
    password: hunter2
  register: my_jenkins_job_info

- name: Get the info from custom URL with token and validate_certs=False
  community.general.jenkins_job_info:
    user: admin
    token: 126df5c60d66c66e3b75b11104a16a8a
    url: https://jenkins.example.com
  register: my_jenkins_job_info

返回值

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

键

描述

jobs

列表 / 元素=字符串

找到的符合指定条件的所有作业

返回：成功

示例： [{"color": "blue", "fullname": "test-folder/test-job", "name": "test-job", "url": "https://127.0.0.1:8080/job/test-job/"}]

作者

  • Chris St. Pierre (@stpierre)