New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
color |
Only fetch jobs with the given status color.
|
|
glob |
A shell glob of Jenkins job names to fetch facts about.
|
|
name |
Exact name of the Jenkins job to fetch facts about.
|
|
password |
Password to authenticate with the Jenkins server.
|
|
token |
API token used to authenticate alternatively to
password . |
|
url |
Default: http://localhost:8080
|
Url where the Jenkins server is accessible.
|
user |
User to authenticate with the Jenkins server.
|
# Get all Jenkins jobs using basic auth
- jenkins_job_facts:
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get all Jenkins jobs using the token
- jenkins_job_facts:
user: admin
token: abcdefghijklmnop
register: my_jenkins_job_facts
# Get facts about a single job using basic auth
- jenkins_job_facts:
name: some-job-name
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about a single job in a folder using basic auth
- jenkins_job_facts:
name: some-folder-name/some-job-name
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about jobs matching a shell glob using basic auth
- jenkins_job_facts:
glob: some-job-*
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about all failing jobs using basic auth
- jenkins_job_facts:
color: red
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about passing jobs matching a shell glob using basic auth
- jenkins_job_facts:
name: some-job-*
color: blue
user: admin
password: hunter2
register: my_jenkins_job_facts
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
jobs
list
|
success |
All jobs found matching the specified criteria
Sample:
[{'name': 'test-job', 'fullname': 'test-folder/test-job', 'url': 'http://localhost:8080/job/test-job/', 'color': 'blue'}, '...']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.