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 bool |
| Если установлено значение no, сертификаты SSL не будут проверяться. Это следует устанавливать только для сайтов под личным контролем с самозаверяющими сертификатами, поскольку это позволяет избежать проверки источника сайта. |
Примечания
Примечание
- Поскольку скрипт может выполнять любые действия, он не сообщает об изменениях. Зная, что скрипт выполняется, важно установить changed_when для ясного отображения в выводе ansible любых внесенных изменений.
Примеры
- 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. Подробнее см. поддержку и техническое обслуживание модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. в этом разделе.
Автор
- James Hogarth
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_script_module.html
