jenkins_job – Управление заданиями Jenkins

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

Описание

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

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
config -		Конфигурация в формате XML. Требуется, если задание еще не существует. Взаимоисключающее с `enabled`. Рассматривается, если `state=present`.
enabled boolean	Варианты: no yes	Включить или выключить задание. Взаимоисключающее с `config`. Рассматривается, если `state=present`.
name - / обязательно		Имя задания Jenkins.
password -		Пароль для аутентификации на сервере Jenkins.
state -	Варианты: present ← absent	Атрибут, определяющий, нужно ли создать или удалить задание.
token -		Токен API для аутентификации вместо пароля.
url -	По умолчанию: "http://localhost:8080"	URL для доступа к серверу 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 boolean	success	Включено ли задание Jenkins. Пример: True
name string	success	Имя задания Jenkins. Пример: test-job
state string	success	Состояние задания Jenkins. Пример: present
url string	success	URL для подключения к серверу Jenkins. Пример: https://jenkins.mydomain.com
user string	success	Пользователь, используемый для аутентификации. Пример: admin

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/jenkins_job_module.html