tower_job_list - Список задач Ansible Tower.
Новая версия с 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Список задач Ansible Tower. Для обзора см. https://www.ansible.com/tower.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- ansible-tower-cli >= 3.0.2
Параметры
| параметр | обязательный | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| all_pages | нет | Получить все страницы и вернуть один результат. | ||
| page | нет | Номер страницы результатов для получения. | ||
| query | нет | Запрос для дальнейшей фильтрации списка задач. {"foo":"bar"} будет передано как ?foo=bar | ||
| status | нет |
| Отображать только задачи с этим статусом. | |
| tower_config_file | нет | Путь к файлу конфигурации Tower. См. Примечания. | ||
| tower_host | нет | URL вашего экземпляра Tower. | ||
| tower_password | нет | Пароль для вашего экземпляра Tower. | ||
| tower_username | нет | Имя пользователя для вашего экземпляра Tower. | ||
| tower_verify_ssl | нет | True | Отключить/разрешить небезопасные подключения к Tower. Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. |
Примеры
- name: List running jobs for the testing.yml playbook
tower_job_list:
status: running
query: {"playbook": "testing.yml"}
register: testing_jobs
tower_config_file: "~/tower_cli.cfg"
Возвращаемые значения
Общие значения возврата документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| название | описание | возвращаемое значение | тип | пример |
|---|---|---|---|---|
| count | Общее количество возвращенных объектов | успех | int | 51 |
| next | Следующая доступная страница для списка | успех | int | 3 |
| previous | Предыдущая доступная страница для списка | успех | int | 1 |
| results | Список объектов задач, представленных как словари | успех | список | [{'force_handlers': False, 'job_template': 5, 'ask_credential_on_launch': False, 'artifacts': {}, 'ask_job_type_on_launch': False, 'job_tags': '', 'job_type': 'run', 'allow_simultaneous': False, 'failed': False, 'finished': '2017-02-22T15:09:05.633942Z', 'ask_inventory_on_launch': False, 'inventory': 1, 'id': 2, 'forks': 0, 'job_explanation': ''}, '...'] |
Примечания
Примечание
- Если config_file не указан, мы попытаемся использовать значения по умолчанию библиотеки tower-cli для поиска информации о вашем хосте Tower.
- config_file должен содержать конфигурацию Tower в следующем формате: host=hostname username=username password=password
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Для помощи в разработке модулей, если у вас есть такие желания, пожалуйста, ознакомьтесь с Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/tower_job_list_module.html