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 boolean добавлено в 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': 'test-job', 'fullname': 'test-folder/test-job', 'url': 'http://localhost:8080/job/test-job/', 'color': 'blue'}] |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/jenkins_job_facts_module.html