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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

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

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

Обзор

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

Требования

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

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 логическое	Варианты: нет да ←	Если установлено `False`, сертификаты SSL не будут проверены. Это следует устанавливать только в случае использования на лично контролируемых сайтах с самозаверяющимися сертификатами.

Примеры

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

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

# Get info about a single job using basic auth
- community.general.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
- community.general.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
- community.general.jenkins_job_info:
    glob: some-job-*
    user: admin
    password: hunter2
  register: my_jenkins_job_info

# Get info about all failing jobs using basic auth
- community.general.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
- community.general.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
  community.general.jenkins_job_info:
    user: admin
    token: 126df5c60d66c66e3b75b11104a16a8a
    url: https://jenkins.example.com
    validate_certs: False
  register: my_jenkins_job_info

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

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

Ключ	Возвращаемое значение	Описание
jobs список / элементы=строка	успех	Все найденные задачи, соответствующие заданным критериям Пример: [{'color': 'синий', 'fullname': 'test-folder/test-job', 'name': 'test-job', 'url': 'http://localhost:8080/job/test-job/'}]

Авторы

Chris St. Pierre (@stpierre)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/jenkins_job_info_module.html