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 boolean |
| Если установлено значение no, сертификаты SSL не будут проверены. Это следует устанавливать только в случае no, работая с сайтами, контролируемыми лично, с использованием самозаверяющих сертификатов, чтобы избежать проверки источника сайта. |
Примечания
Примечание
- Так как скрипт может делать всё, он не сообщает об изменениях. Для ясности в выводе ansible о внесённых изменениях важно установить changed_when.
Примеры
- 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 string | успех | Результат выполнения скрипта Пример: Результат: true |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- James Hogarth (@hogarthj)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/jenkins_script_module.html