Spec-Zone.ru › Ansible 2.8

jenkins_job – Управление заданиями jenkins

Новая версия с 2.2.

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

Обзор

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

Требования

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

  • python-jenkins >= 0.4.12
  • lxml >= 3.3.3

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
config
-
Конфигурация в формате XML.
Требуется, если задание еще не существует.
Взаимоисключающие с enabled.
Рассматривается, если state=present.
enabled
boolean
    Варианты:
  • нет
  • да
Включено или выключено задание.
Взаимоисключающие с config.
Рассматривается, если state=present.
name
- / обязательно
Имя задания Jenkins.
password
-
Пароль для аутентификации на сервере Jenkins.
state
-
    Варианты:
  • present ←
  • отсутствует
Атрибут, указывающий, нужно ли создать или удалить задание.
token
-
Токен API для аутентификации, как альтернатива паролю.
url
-
По умолчанию:
"http://localhost:8080"
URL сервера Jenkins.
user
-
Пользователь для аутентификации на сервере Jenkins.

Примеры

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

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

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

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

# Disable a jenkins job using basic authentication
- jenkins_job:
    name: test
    password: admin
    enabled: False
    url: http://localhost:8080
    user: admin

# Disable a jenkins job using the token
- jenkins_job:
    name: test
    token: asdfasfasfasdfasdfadfasfasdfasdfc
    enabled: False
    url: http://localhost:8080
    user: admin

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

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

Ключ Возвращаемое Описание
enabled
boolean
успех
Включено или выключено задание jenkins.

Пример:
True
name
строка
успех
Имя задания jenkins.

Пример:
test-job
state
строка
успех
Состояние задания jenkins.

Пример:
present
url
строка
успех
URL для подключения к серверу Jenkins.

Пример:
https://jenkins.mydomain.com
user
строка
успех
Пользователь, используемый для аутентификации.

Пример:
admin


Статус

  • Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Sergio Millan Rodriguez (@sermilrod)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/jenkins_job_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API