community.general.jenkins_script – Выполняет скрипт Groovy в экземпляре Jenkins

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.jenkins_script.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
args словарь		Словарь пар ключ-значение, используемый для форматирования скрипта с помощью string.Template (см. https://docs.python.org/2/library/string.html#template-strings).
password строка		Пароль для подключения к серверу Jenkins.
script строка / обязательно		Скрипт Groovy для выполнения. Он передается как строка Template, если определен параметр args.
timeout целое число	По умолчанию: 10	Таймаут запроса в секундах
url строка	По умолчанию: "http://localhost:8080"	Сервер Jenkins, на котором будет выполняться скрипт. По умолчанию используется локальный экземпляр Jenkins, не проксируемый через веб-сервер.
user строка		Имя пользователя для подключения к серверу Jenkins.
validate_certs логическое значение	Варианты: нет да ←	Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в случае работы с лично контролируемыми сайтами, использующими самозаверяющие сертификаты, так как это позволяет избежать проверки источника сайта.

Примечания

Примечание

Поскольку скрипт может выполнять любые действия, он не сообщает о внесенных изменениях. Для того, чтобы было ясно, какие изменения были внесены при помощи Ansible, важно установить changed_when.

Примеры

- name: Obtaining a list of plugins
  community.general.jenkins_script:
    script: 'println(Jenkins.instance.pluginManager.plugins)'
    user: admin
    password: admin

- name: Setting master using a variable to hold a more complicate script
  ansible.builtin.set_fact:
    setmaster_mode: |
        import jenkins.model.*
        instance = Jenkins.getInstance()
        instance.setMode(${jenkins_mode})
        instance.save()

- name: Use the variable as the script
  community.general.jenkins_script:
    script: "{{ setmaster_mode }}"
    args:
      jenkins_mode: Node.Mode.EXCLUSIVE

- name: Interacting with an untrusted HTTPS connection
  community.general.jenkins_script:
    script: "println(Jenkins.instance.pluginManager.plugins)"
    user: admin
    password: admin
    url: https://localhost
    validate_certs: no

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
output строка	успех	Результат выполнения скрипта Пример: Результат: true

Авторы

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.10/collections/community/general/jenkins_script_module.html