Модуль community.general.jenkins_script – Выполняет скрипт groovy в экземпляре Jenkins

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: 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 строка	Сервер Jenkins для выполнения скрипта. По умолчанию используется локальный экземпляр Jenkins, не проксируемый через веб-сервер. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к серверу Jenkins.
validate_certs логическое	Если установлено в `false`, сертификаты SSL не будут проверены. Это следует устанавливать только в `false` на контролируемых сайтах с самозаверенными сертификатами, поскольку это предотвращает проверку источника сайта. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в `check_mode` и возвращать предсказание статуса изменения без модификации целевого объекта.
diff_mode	Поддержка: нет	Возвратит подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда используется режим diff.

Примечания

Примечание

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

Примеры

- 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: false  # only do this when you trust the network!

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

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

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

Авторы

James Hogarth (@hogarthj)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/jenkins_script_module.html