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

Примечание

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

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

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

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

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

Обзор

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

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
color строка	Получить только задачи с заданным цветом статуса.
glob строка	Шаблон оболочки для имён задач Jenkins, о которых требуется получить информацию.
name строка	Точное имя задачи Jenkins, о которой требуется получить информацию.
password строка	Пароль для аутентификации с сервером Jenkins. Этот параметр взаимоисключающий с `token`.
token строка	Токен API, используемый для аутентификации с сервером Jenkins. Этот параметр взаимоисключающий с `password`.
url строка	URL, по которому доступен сервер Jenkins. По умолчанию: `"http://localhost:8080"`
user строка	Пользователь для аутентификации с сервером Jenkins.
validate_certs логический	Если установлено в `false`, сертификаты SSL не будут проверены. Это нужно установить только в `false` для сайтов под собственным контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

# Get all Jenkins jobs anonymously
- community.general.jenkins_job_info:
    user: admin
  register: my_jenkins_job_info

# 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
  register: my_jenkins_job_info

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

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

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

Авторы

Chris St. Pierre (@stpierre)

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

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