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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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`).

Примеры

# 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/jenkins_job_info_module.html