jenkins_script - Выполнение скрипта groovy в экземпляре jenkins
Новое в версии 2.3.
Обзор
- Модуль
jenkins_scriptпринимает скрипт и словарь значений для использования в скрипте и возвращает результат выполнения скрипта.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| args | нет | Словарь пар ключ-значение, используемый для форматирования скрипта с помощью string.Template (см. https://docs.python.org/2/library/string.html#template-strings). | ||
| password | нет | Пароль для подключения к серверу jenkins. | ||
| script | да | Скрипт groovy для выполнения. Он передается как строка Template, если args определен. | ||
| timeout (добавлено в 2.4)
| нет | 10 | Таймаут запроса в секундах | |
| url | нет | http://localhost:8080 | Сервер jenkins для выполнения скрипта. По умолчанию используется локальный экземпляр jenkins, который не проксируется через веб-сервер. | |
| user | нет | Имя пользователя для подключения к серверу jenkins. | ||
| validate_certs | нет | True | Если установлено значение no, сертификаты SSL не будут проверяться. Это значение следует устанавливать только на сайтах, контролируемых лично, с самоподписанными сертификатами, т.к. это позволяет избежать проверки источника сайта. |
Примеры
- name: Obtaining a list of plugins
jenkins_script:
script: 'println(Jenkins.instance.pluginManager.plugins)'
user: admin
password: admin
- name: Setting master using a variable to hold a more complicate script
vars:
setmaster_mode: |
import jenkins.model.*
instance = Jenkins.getInstance()
instance.setMode(${jenkins_mode})
instance.save()
- name: use the variable as the script
jenkins_script:
script: "{{ setmaster_mode }}"
args:
jenkins_mode: Node.Mode.EXCLUSIVE
- name: interacting with an untrusted HTTPS connection
jenkins_script:
script: "println(Jenkins.instance.pluginManager.plugins)"
user: admin
password: admin
url: https://localhost
validate_certs: no
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| output | Результат скрипта | успех | строка | Результат: true |
Примечания
Примечание
- Поскольку скрипт может выполнять любые действия, изменения не отслеживаются. Для того чтобы информация об изменениях была понятна в выводе Ansible, необходимо установить changed_when.
Статус
Этот модуль помечен как preview, что означает, что интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей обратитесь к Справочная информация по сообществу и вклад, Тестирование 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_script_module.html