community.general.jenkins_job – Управление задачами Jenkins

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в playbook, укажите: community.general.jenkins_job.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Управление задачами Jenkins с использованием Jenkins REST API.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python-jenkins >= 0.4.12

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
config строка		конфигурация в формате XML. Требуется, если задача еще не существует. Взаимоисключающий с `enabled`. Рассматривается, если `state=present`.
enabled булево	Варианты: нет да	Включить или отключить задачу. Взаимоисключающий с `config`. Рассматривается, если `state=present`.
name строка / обязательный		Имя задачи Jenkins.
password строка		Пароль для аутентификации на сервере Jenkins.
state строка	Варианты: present ← absent	Атрибут, определяющий, должна ли задача создаваться или удаляться.
token строка		Токен API для аутентификации вместо пароля.
url строка	Значение по умолчанию: "http://localhost:8080"	URL сервера Jenkins.
user строка		Пользователь для аутентификации на сервере Jenkins.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ	Возвращаемое значение	Описание
enabled булево	success	Включена ли задача Jenkins. Пример: True
name строка	success	Имя задачи Jenkins. Пример: test-job
state строка	success	Состояние задачи Jenkins. Пример: present
url строка	success	URL для подключения к серверу Jenkins. Пример: https://jenkins.mydomain.com
user строка	success	Пользователь, используемый для аутентификации. Пример: admin

Авторы

Sergio Millan Rodriguez (@sermilrod)

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