tower_job_wait — Ожидание завершения задачи Ansible Tower.
Новая в версии 2.3.
Обзор
- Ожидание завершения задачи Ansible Tower и отчет об успехе или ошибке. Для обзора см. https://www.ansible.com/tower.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible-tower-cli >= 3.0.2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| job_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 bool |
| Разрешить/запретить небезопасные подключения к Tower. Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, и использующих самозаверяемые сертификаты. |
Примечания
Примечание
- Если не указан файл config_file, мы попытаемся использовать значения по умолчанию для библиотеки tower-cli, чтобы найти информацию о вашем хосте Tower.
- config_file должен содержать конфигурацию Tower в следующем формате: host=hostname username=username password=password
Примеры
- 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 целое число | успех | идентификатор задачи, за которым ожидается результат Пример: 99 |
| started строка | успех | время начала выполнения задачи Пример: 2017-03-01T17:03:53.200234Z |
| status строка | успех | текущий статус задачи Пример: успешно |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместимым с предыдущими версиями.
Техническое сопровождение
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее об обслуживании модулей см. в разделе Поддержка модулей и техническое обслуживание.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Wayne Witzel III (@wwitzel3)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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/tower_job_wait_module.html