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. This is a required parameter, if token is not provided. | |
token | API token used to authenticate with the Jenkins server. This is a required parameter, if password is not provided. | |
url | Default: http://localhost:8080 | URL where the Jenkins server is accessible. |
user | User to authenticate with the Jenkins server. | |
validate_certs bool (added in 2.6) |
| 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. |
# 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 - name: Get the facts from custom URL with token and validate_certs=False jenkins_job_facts: user: admin token: 126df5c60d66c66e3b75b11104a16a8a url: https://jenkins.example.com validate_certs: False 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: [{'url': 'http://localhost:8080/job/test-job/', 'color': 'blue', 'fullname': 'test-folder/test-job', 'name': 'test-job'}] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/jenkins_job_facts_module.html