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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 целое число	Целое число, определяющее сборку задачи. Если не указано, будет возвращена информация о последней сборке.
name строка / обязательно	Имя задачи Jenkins, к которой принадлежит сборка.
password строка	Пароль для аутентификации на сервере Jenkins.
token строка	Токен API, используемый для аутентификации на сервере Jenkins.
url строка	URL сервера Jenkins. По умолчанию: `"http://localhost:8080"`
user строка	Пользователь для аутентификации на сервере Jenkins.

Атрибуты

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

Примеры

- 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 словарь	Информация о сборке задачи jenkins. Возвращается при: успехе
name строка	Имя задачи jenkins. Возвращается при: успехе Пример: `"test-job"`
state строка	Состояние задачи jenkins. Возвращается при: успехе Пример: `"present"`
url строка	URL для подключения к серверу Jenkins. Возвращается при: успехе Пример: `"https://jenkins.mydomain.com"`
user строка	Пользователь, используемый для аутентификации. Возвращается при: успехе Пример: `"admin"`

Авторы

Хуан Касанова (@juanmcasanova)

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

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