jenkins_job - Управление задачами Jenkins

Новая версия 2.2.

Обзор
- Требования
Параметры
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Требования

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

python-jenkins >= 0.4.12
lxml >= 3.3.3

Параметры

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

Примеры

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

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

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

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

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

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

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Автор

Sergio Millan Rodriguez (@sermilrod)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/jenkins_job_module.html