Модуль community.general.jenkins_job — управление заданиями Jenkins

Примечание

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

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

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

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

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

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

Управление заданиями Jenkins с помощью REST API Jenkins.

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
config строка	Конфигурация в формате XML. Обязателен, если задание ещё не существует. Несовместим с `enabled`. Учитывается, если `state=present`.
enabled логический	Должно ли задание быть включено или отключено. Несовместим с `config`. Учитывается, если `state=present`. Варианты: `false` `true`
name строка / обязательный	Имя задания Jenkins.
password строка	Пароль для аутентификации на сервере Jenkins.
state строка	Атрибут, указывающий, нужно ли создать или удалить задание. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка	Токен API для аутентификации вместо пароля.
url строка	URL-адрес, по которому доступен сервер Jenkins. По умолчанию: `"http://localhost:8080"`
user строка	Пользователь для аутентификации на сервере Jenkins.
validate_certs логический добавлен в community.general 2.3.0	Если задано значение `false`, SSL-сертификаты не проверяются. Устанавливайте значение `false` только для подконтрольных вам сайтов, использующих самоподписанные сертификаты, поскольку это отключает проверку исходного сайта. Библиотека `python-jenkins` поддерживает эту возможность только через переменную среды `PYTHONHTTPSVERIFY`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create a jenkins job using basic authentication
  community.general.jenkins_job:
    config: "{{ lookup('file', 'templates/test.xml') }}"
    name: test
    password: admin
    url: http://localhost:8080
    user: admin

- name: Create a jenkins job using the token
  community.general.jenkins_job:
    config: "{{ lookup('template', 'templates/test.xml.j2') }}"
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    url: http://localhost:8080
    user: admin

- name: Delete a jenkins job using basic authentication
  community.general.jenkins_job:
    name: test
    password: admin
    state: absent
    url: http://localhost:8080
    user: admin

- name: Delete a jenkins job using the token
  community.general.jenkins_job:
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    state: absent
    url: http://localhost:8080
    user: admin

- name: Disable a jenkins job using basic authentication
  community.general.jenkins_job:
    name: test
    password: admin
    enabled: false
    url: http://localhost:8080
    user: admin

- name: Disable a jenkins job using the token
  community.general.jenkins_job:
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    enabled: false
    url: http://localhost:8080
    user: admin

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

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

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

Авторы

Sergio Millan Rodriguez (@sermilrod)

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

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