community.general.jenkins_build – Manage jenkins builds
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_build
.
New in version 2.2.0: of community.general
Requirements
The below requirements are needed on the host that executes this module.
python-jenkins >= 0.4.12
Parameters
Parameter |
Comments |
---|---|
A list of parameters to pass to the build. |
|
An integer which specifies a build of a job. Is required to remove a build from the queue. |
|
Name of the Jenkins job to build. |
|
Password to authenticate with the Jenkins server. |
|
Attribute that specifies if the build is to be created, deleted or stopped. The Choices:
|
|
API token used to authenticate with the Jenkins server. |
|
URL of the Jenkins server. Default: “http://localhost:8080” |
|
User to authenticate with the Jenkins server. |
Examples
- name: Create a jenkins build using basic authentication
community.general.jenkins_build:
name: "test-check"
args:
cloud: "test"
availability_zone: "test_az"
state: present
user: admin
password: asdfg
url: http://localhost:8080
- name: Stop a running jenkins build anonymously
community.general.jenkins_build:
name: "stop-check"
build_number: 3
state: stopped
url: http://localhost:8080
- name: Delete a jenkins build using token authentication
community.general.jenkins_build:
name: "delete-experiment"
build_number: 30
state: absent
user: Jenkins
token: abcdefghijklmnopqrstuvwxyz123456
url: http://localhost:8080
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build info of the jenkins job. Returned: success |
|
Name of the jenkins job. Returned: success Sample: “test-job” |
|
State of the jenkins job. Returned: success Sample: “present” |
|
User used for authentication. Returned: success Sample: “admin” |
Authors
Brett Milford (@brettmilford)
Tong He (@unnecessary-username)