Модуль community.general.jenkins_build — управление сборками Jenkins

Примечание

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

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

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

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

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

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

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

Управление сборками Jenkins с помощью REST API Jenkins.

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
args dictionary	Список параметров, передаваемых сборке.
build_number integer	Целое число, указывающее сборку задания. Требуется для удаления сборки из очереди.
detach boolean добавлен в community.general 7.4.0	Включить отсоединённый режим, чтобы не дожидаться завершения сборки. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя задания Jenkins для сборки.
password string	Пароль для аутентификации на сервере Jenkins.
state string	Атрибут, указывающий, нужно ли создать, удалить или остановить сборку. Состояние `stopped` добавлено в community.general 3.3.0. Варианты: `"present"` ← (по умолчанию) `"absent"` `"stopped"`
time_between_checks integer добавлен в community.general 7.4.0	Время ожидания в секундах между запросами к серверу Jenkins. Это время должно быть больше заданного времени ожидания для задания. По умолчанию: `10`
token string	Токен API для аутентификации на сервере Jenkins.
url string	URL-адрес сервера Jenkins. По умолчанию: `"http://localhost:8080"`
user string	Пользователь для аутентификации на сервере Jenkins.

Атрибуты

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

Примеры

- name: Create a jenkins build using basic authentication
  community.general.jenkins_build:
    name: "test-check"
    args:
      cloud: "test"
      availability_zone: "test_az"
    state: present
    user: admin
    password: asdfg
    url: http://localhost:8080

- name: Stop a running jenkins build anonymously
  community.general.jenkins_build:
    name: "stop-check"
    build_number: 3
    state: stopped
    url: http://localhost:8080

- name: Trigger Jenkins build in detached mode
  community.general.jenkins_build:
    name: "detached-build"
    state: present
    user: admin
    token: abcdefghijklmnopqrstuvwxyz123456
    url: http://localhost:8080
    detach: true
    time_between_checks: 20

- name: Delete a jenkins build using token authentication
  community.general.jenkins_build:
    name: "delete-experiment"
    build_number: 30
    state: absent
    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"`

Авторы

Brett Milford (@brettmilford)
Tong He (@unnecessary-username)
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_module.html