Spec-Zone.ru › Ansible 2.9

jenkins_job_info – Получение информации о задачах Jenkins

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

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

Описание

  • Этот модуль можно использовать для запроса информации о существующих задачах Jenkins.
  • Этот модуль назывался jenkins_job_info до Ansible 2.9. Способ использования не изменился.

Псевдонимы: jenkins_job_facts

Требования

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

  • python-jenkins >= 0.4.12

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
color
-
Получить только задачи с заданным цветом статуса.
glob
-
Шаблон командной оболочки для имен задач Jenkins, о которых нужно получить информацию.
name
-
Точное имя задачи Jenkins, о которой нужно получить информацию.
password
-
Пароль для аутентификации на сервере Jenkins.
Этот параметр обязателен, если token не указан.
token
-
Токен API, используемый для аутентификации на сервере Jenkins.
Этот параметр обязателен, если password не указан.
url
-
Значение по умолчанию:
"http://localhost:8080"
URL сервера Jenkins.
user
-
Пользователь для аутентификации на сервере Jenkins.
validate_certs
boolean
Добавлен в 2.6
    Варианты:
  • нет
  • да ←
Если установлено False, сертификаты SSL не будут проверены.
Это следует установить только в False на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.

Примеры

# Get all Jenkins jobs using basic auth
- jenkins_job_info:
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get all Jenkins jobs using the token
- jenkins_job_info:
    user: admin
    token: abcdefghijklmnop
  register: my_jenkins_job_info

# Get info about a single job using basic auth
- jenkins_job_info:
    name: some-job-name
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about a single job in a folder using basic auth
- jenkins_job_info:
    name: some-folder-name/some-job-name
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about jobs matching a shell glob using basic auth
- jenkins_job_info:
    glob: some-job-*
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about all failing jobs using basic auth
- jenkins_job_info:
    color: red
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about passing jobs matching a shell glob using basic auth
- jenkins_job_info:
    name: some-job-*
    color: blue
    user: admin
    password: hunter2
  register: my_jenkins_job_info

- name: Get the info from custom URL with token and validate_certs=False
  jenkins_job_info:
    user: admin
    token: 126df5c60d66c66e3b75b11104a16a8a
    url: https://jenkins.example.com
    validate_certs: False
  register: my_jenkins_job_info

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

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

Ключ Возвращаемое значение Описание
jobs
список
успешно
Все найденные задачи, соответствующие заданным критериям

Пример:
[{'name': 'тестовая-задача', 'fullname': 'папка-с-тестами/тестовая-задача', 'url': 'http://localhost:8080/job/тестовая-задача/', 'color': 'синий'}]


Статус

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

Авторы

  • Крис Сент-Пьер (@stpierre)

Подсказка

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

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

Spec-Zone.ru

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