Spec-Zone.ru › Ansible 2.5

jenkins_script - Выполняет скрипт groovy в экземпляре jenkins

Новое в версии 2.3.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус
    • Автор

Описание

  • Модуль jenkins_script принимает скрипт и словарь значений для использования в скрипте и возвращает результат выполнения скрипта.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
args Значение по умолчанию:
None
Словарь пар ключ-значение, используемых для форматирования скрипта с помощью string.Template (см. https://docs.python.org/2/library/string.html#template-strings).
password Значение по умолчанию:
None
Пароль для подключения к серверу jenkins.
script
обязательно
Значение по умолчанию:
None
Скрипт groovy для выполнения. Он передается как строка Template, если args определен.
timeout
(добавлено в 2.4)
Значение по умолчанию:
10
Таймаут запроса в секундах
url Значение по умолчанию:
http://localhost:8080
Сервер jenkins, к которому выполняется скрипт. По умолчанию - локальный экземпляр jenkins, не проксируемый через веб-сервер.
user Значение по умолчанию:
None
Имя пользователя для подключения к серверу jenkins.
validate_certs Значение по умолчанию:
да
Если установлено значение 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


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется совместимым с предыдущими версиями.

Автор

  • 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.5/modules/jenkins_script_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API