Spec-Zone.ru › Ansible 2.9

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

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

Описание

  • Модуль 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
  • да ←
Если установлено в 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. [community]

Авторы

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

Spec-Zone.ru

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