community.general.jenkins_job_info – Get information about Jenkins jobs
Note
This plugin is part of the community.general collection (version 3.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.jenkins_job_info
.
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 |
Comments |
---|---|
Only fetch jobs with the given status color. |
|
A shell glob of Jenkins job names to fetch information about. |
|
Exact name of the Jenkins job to fetch information about. |
|
Password to authenticate with the Jenkins server. This is mutually exclusive with token. |
|
API token used to authenticate with the Jenkins server. This is mutually exclusive with password. |
|
URL where the Jenkins server is accessible. Default: “http://localhost:8080” |
|
User to authenticate with the Jenkins server. |
|
If set to This should only set to Choices:
|
Examples
# 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
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 |
Description |
---|---|
All jobs found matching the specified criteria Returned: success Sample: [{“color”: “blue”, “fullname”: “test-folder/test-job”, “name”: “test-job”, “url”: “http://localhost:8080/job/test-job/”}] |
Authors
Chris St. Pierre (@stpierre)