jenkins_job - Управление задачами Jenkins
Новое в версии 2.2.
Обзор
- Управление задачами Jenkins с помощью API Jenkins REST.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python-jenkins >= 0.4.12
- lxml >= 3.3.3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| config | config в формате XML. Требуется, если задача еще не существует. Взаимоисключающее с enabled. Учитывается, если state=present. | |
| enabled | Включить или отключить задачу. Взаимоисключающее с config.Учитывается, если state=present. | |
| name обязательно | Имя задачи Jenkins. | |
| password | Пароль для аутентификации на сервере Jenkins. | |
| state |
| Атрибут, указывающий, должна ли задача создаваться или удаляться. |
| 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 |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительная информация представлена в разделе Техническое обслуживание модулей и поддержка.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/jenkins_job_module.html
