jenkins_job_facts - Получение фактов о задачах Jenkins
Новое в версии 2.5.
Обзор
- Этот модуль может использоваться для запроса фактов о существующих задачах Jenkins.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 bool (добавлено в 2.6) |
| Если установлено значение False, сертификаты SSL не будут проверяться.Это следует устанавливать только в False используемых на контролируемых вами сайтах с самоподписанными сертификатами. |
Примеры
# Get all Jenkins jobs using basic auth
- jenkins_job_facts:
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get all Jenkins jobs using the token
- jenkins_job_facts:
user: admin
token: abcdefghijklmnop
register: my_jenkins_job_facts
# Get facts about a single job using basic auth
- jenkins_job_facts:
name: some-job-name
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about a single job in a folder using basic auth
- jenkins_job_facts:
name: some-folder-name/some-job-name
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about jobs matching a shell glob using basic auth
- jenkins_job_facts:
glob: some-job-*
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about all failing jobs using basic auth
- jenkins_job_facts:
color: red
user: admin
password: hunter2
register: my_jenkins_job_facts
# Get facts about passing jobs matching a shell glob using basic auth
- jenkins_job_facts:
name: some-job-*
color: blue
user: admin
password: hunter2
register: my_jenkins_job_facts
- name: Get the facts from custom URL with token and validate_certs=False
jenkins_job_facts:
user: admin
token: 126df5c60d66c66e3b75b11104a16a8a
url: https://jenkins.example.com
validate_certs: False
register: my_jenkins_job_facts
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| jobs список | успех | Все найденные задачи, соответствующие указанным критериям Пример: [{'name': 'тестовая-задача', 'fullname': 'папка-с-тестами/тестовая-задача', 'url': 'http://localhost:8080/job/тестовая-задача/', 'color': 'синий'}] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Поддержка и техническое обслуживание модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Chris St. Pierre (@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.6/modules/jenkins_job_facts_module.html