Docs4dev
Docs
ansible / latest / collections / community / general / jenkins_build_module.html

community.general.jenkins_build – Manage jenkins builds

Note

This plugin is part of the community.general collection (version 3.8.1).

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

Synopsis

  • Manage Jenkins builds with Jenkins REST API.

Requirements

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

  • python-jenkins >= 0.4.12

Parameters

Parameter Choices/Defaults Comments
args
dictionary
A list of parameters to pass to the build.
build_number
integer
An integer which specifies a build of a job. Is required to remove a build from the queue.
name
string / required
Name of the Jenkins job to build.
password
string
Password to authenticate with the Jenkins server.
state
string
    Choices:
  • present ←
  • absent
  • stopped
Attribute that specifies if the build is to be created, deleted or stopped.
The stopped state has been added in community.general 3.3.0.
token
string
API token used to authenticate with the Jenkins server.
url
string
Default:
"http://localhost:8080"
URL of the Jenkins server.
user
string
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 Returned Description
build_info
dictionary
success
Build info of the jenkins job.

name
string
success
Name of the jenkins job.

Sample:
test-job
state
string
success
State of the jenkins job.

Sample:
present
url
string
success
Url to connect to the Jenkins server.

Sample:
https://jenkins.mydomain.com
user
string
success
User used for authentication.

Sample:
admin


Authors

  • Brett Milford (@brettmilford)
  • Tong He (@unnecessary-username)

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