community.general.jenkins_build модуль – Управление сборками jenkins

Примечание

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

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

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

Для использования в playbook, укажите: community.general.jenkins_build.

Новая в community.general 2.2.0

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

Описание

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

Требования

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

python-jenkins >= 0.4.12

Параметры

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

Атрибуты

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

Примеры

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

Авторы

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