You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.jenkins_job – Manage 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.

Synopsis

• Manage Jenkins jobs by using Jenkins REST API.

Requirements

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

• python-jenkins >= 0.4.12

Parameters

Parameter	Comments
config string	config in XML format. Required if job does not yet exist. Mutually exclusive with enabled. Considered if state=present.
enabled boolean	Whether the job should be enabled or disabled. Mutually exclusive with config. Considered if state=present. Choices: no yes
name string / required	Name of the Jenkins job.
password string	Password to authenticate with the Jenkins server.
state string	Attribute that specifies if the job has to be created or deleted. Choices: present ← (default) absent
token string	API token used to authenticate alternatively to password.
url string	URL where the Jenkins server is accessible. Default: “http://localhost:8080”
user string	User to authenticate with the Jenkins server.
validate_certs boolean added in 2.3.0 of community.general	If set to no, the SSL certificates will not be validated. This should only set to no used on personally controlled sites using self-signed certificates as it avoids verifying the source site. The python-jenkins library only handles this by using the environment variable PYTHONHTTPSVERIFY. Choices: no yes ← (default)

Examples

- name: Create a jenkins job using basic authentication
  community.general.jenkins_job:
    config: "{{ lookup('file', 'templates/test.xml') }}"
    name: test
    password: admin
    url: http://localhost:8080
    user: admin

- name: Create a jenkins job using the token
  community.general.jenkins_job:
    config: "{{ lookup('template', 'templates/test.xml.j2') }}"
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    url: http://localhost:8080
    user: admin

- name: Delete a jenkins job using basic authentication
  community.general.jenkins_job:
    name: test
    password: admin
    state: absent
    url: http://localhost:8080
    user: admin

- name: Delete a jenkins job using the token
  community.general.jenkins_job:
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    state: absent
    url: http://localhost:8080
    user: admin

- name: Disable a jenkins job using basic authentication
  community.general.jenkins_job:
    name: test
    password: admin
    enabled: False
    url: http://localhost:8080
    user: admin

- name: Disable a jenkins job using the token
  community.general.jenkins_job:
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    enabled: False
    url: http://localhost:8080
    user: admin

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
enabled boolean	Whether the jenkins job is enabled or not. Returned: success Sample: true
name string	Name of the jenkins job. Returned: success Sample: “test-job”
state string	State of the jenkins job. Returned: success Sample: “present”
url string	Url to connect to the Jenkins server. Returned: success Sample: “https://jenkins.mydomain.com”
user string	User used for authentication. Returned: success Sample: “admin”

Authors

• Sergio Millan Rodriguez (@sermilrod)