Модуль community.general.jenkins_build_info — получение информации о сборках Jenkins

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.jenkins_build_info.

Добавлено в community.general 7.4.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Получение информации о сборках Jenkins с помощью REST API Jenkins.

Требования

На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
build_number integer	Целое число, указывающее сборку задания. Если параметр не указан, возвращается информация о последней сборке.
name string / обязательный	Имя задания Jenkins, к которому относится сборка.
password string	Пароль для аутентификации на сервере Jenkins.
token string	Токен API для аутентификации на сервере Jenkins.
url string	URL-адрес сервера Jenkins. По умолчанию: `"http://localhost:8080"`
user string	Пользователь для аутентификации на сервере Jenkins.

Атрибуты

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

Примеры

- name: Get information about a jenkins build using basic authentication
  community.general.jenkins_build_info:
    name: "test-check"
    build_number: 1
    user: admin
    password: asdfg
    url: http://localhost:8080

- name: Get information about a jenkins build anonymously
  community.general.jenkins_build_info:
    name: "stop-check"
    build_number: 3
    url: http://localhost:8080

- name: Get information about a jenkins build using token authentication
  community.general.jenkins_build_info:
    name: "delete-experiment"
    build_number: 30
    user: Jenkins
    token: abcdefghijklmnopqrstuvwxyz123456
    url: http://localhost:8080

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

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

Ключ	Описание
build_info dictionary	Информация о сборке задания Jenkins. Возвращается: при успешном выполнении
name string	Имя задания Jenkins. Возвращается: при успешном выполнении Пример: `"test-job"`
state string	Состояние задания Jenkins. Возвращается: при успешном выполнении Пример: `"present"`
url string	URL-адрес для подключения к серверу Jenkins. Возвращается: при успешном выполнении Пример: `"https://jenkins.mydomain.com"`
user string	Пользователь, используемый для аутентификации. Возвращается: при успешном выполнении Пример: `"admin"`

Авторы

Juan Casanova (@juanmcasanova)

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

© 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_build_info_module.html