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 |
| Атрибут, определяющий, нужно ли создать или удалить задачу. |
| 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 | Включена или выключена задача Jenkins. | успех | bool | True |
| name | Имя задачи Jenkins. | успех | строка | test-job |
| state | Состояние задачи Jenkins. | успех | строка | present |
| url | Адрес подключения к серверу Jenkins. | успех | строка | https://jenkins.mydomain.com |
| user | Пользователь для аутентификации. | успех | строка | admin |
Статус
Этот модуль помечен как превью, что означает отсутствие гарантии обратной совместимости интерфейса.
Для получения помощи в разработке модулей прочитайте Информацию сообщества и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/jenkins_job_module.html