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
set_fact:
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. [сообщество]
Авторы
- Джеймс Хогард (@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.8/modules/jenkins_script_module.html