W3cubDocs

/Ansible 2.10

community.general.jenkins_job_facts – Get information about Jenkins jobs

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.jenkins_job_facts.

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

This module can be used to query information about which Jenkins jobs which already exists.
This module was called jenkins_job_info before Ansible 2.9. The usage did not change.

Requirements

The below requirements are needed on the host that executes this module.

python-jenkins >= 0.4.12

Parameters

Parameter	Choices/Defaults	Comments
color string		Only fetch jobs with the given status color.
glob string		A shell glob of Jenkins job names to fetch information about.
name string		Exact name of the Jenkins job to fetch information about.
password string		Password to authenticate with the Jenkins server. This is a required parameter, if `token` is not provided.
token string		API token used to authenticate with the Jenkins server. This is a required parameter, if `password` is not provided.
url string	Default: "http://localhost:8080"	URL where the Jenkins server is accessible.
user string		User to authenticate with the Jenkins server.
validate_certs boolean	Choices: no yes ←	If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.

Examples

# 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
    validate_certs: False
  register: my_jenkins_job_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
jobs list / elements=string	success	All jobs found matching the specified criteria Sample: [{'color': 'blue', 'fullname': 'test-folder/test-job', 'name': 'test-job', 'url': 'http://localhost:8080/job/test-job/'}]

Authors

Chris St. Pierre (@stpierre)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/jenkins_job_facts_module.html