community.general.jenkins_job модуль — Управление задачами jenkins

Примечание

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

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

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

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

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

Описание

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

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
config строка	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	Поддержка: полная	Возвращает подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда используется режим diff.

Примеры

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

Авторы

Sergio Millan Rodriguez (@sermilrod)

Ссылки на сборку

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