tower_job_wait - Ожидание завершения задачи Ansible Tower.
Новая версия с 2.3.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Ожидание завершения задачи Ansible Tower и отчет о результате (успех или ошибка). См. https://www.ansible.com/tower для общего обзора.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- ansible-tower-cli >= 3.0.2
Параметры
| параметр | обязательно | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| job_id | да | ID задачи для мониторинга. | ||
| max_interval | нет | 30 | Максимальный интервал в секундах для запроса обновления от Tower. | |
| min_interval | нет | 1 | Минимальный интервал в секундах для запроса обновления от Tower. | |
| timeout | нет | Максимальное время в секундах ожидания завершения задачи. | ||
| tower_config_file | нет | Путь к конфигурационному файлу Tower. См. примечания. | ||
| tower_host | нет | URL вашего экземпляра Tower. | ||
| tower_password | нет | Пароль для вашего экземпляра Tower. | ||
| tower_username | нет | Имя пользователя для вашего экземпляра Tower. | ||
| tower_verify_ssl | нет | True | Разрешить/запретить небезопасные соединения с Tower. Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, с самозаверенными сертификатами. |
Примеры
- name: Launch a job
tower_job_launch:
job_template: "My Job Template"
register: job
- name: Wait for job max 120s
tower_job_wait:
job_id: job.id
timeout: 120
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| elapsed | общее время в секундах выполнения задачи | успех | float | 10.879 |
| finished | время завершения выполнения задачи | успех | строка | 2017-03-01T17:04:04.078782Z |
| id | id задачи, которая ожидает завершения | успех | целое число | 99 |
| started | время начала выполнения задачи | успех | строка | 2017-03-01T17:03:53.200234Z |
| status | текущий статус задачи | успех | строка | успешно |
Примечания
Примечание
- Если 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_wait_module.html
