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

Примечание

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

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

Атрибуты

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

Примечания

Примечание

Поскольку скрипт может выполнять любые действия, сведения об изменениях не предоставляются. Так как скрипт будет запущен, важно задать changed_when, чтобы вывод 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/jenkins_script_module.html