pause - Остановка выполнения книги задач
Обзор
- Приостанавливает выполнение книги задач на заданное количество времени или до получения подтверждения запроса. Все параметры являются необязательными. По умолчанию выполняется приостановка с запросом.
- Для приостановки/ожидания/сна на уровне хоста используйте модуль wait_for.
- Вы можете использовать
ctrl+c, если хотите ускорить приостановку до её истечения или прервать выполнение книги задач полностью. Чтобы продолжить раньше, нажмитеctrl+cи затемc. Чтобы прервать выполнение книги задач, нажмитеctrl+cи затемa. - Модуль приостановки интегрируется в асинхронные/параллельные книги задач без особых соображений (см. Поэтапное обновление). При использовании приостановок с параметром книги задач
serial(как в поэтапных обновлениях) вам будет предложено подтверждение только один раз для текущей группы хостов. - Этот модуль также поддерживается для целевых платформ Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| echo bool (добавлен в 2.5) |
| Управляет отображением ввода с клавиатуры при наборе. Не имеет эффекта, если заданы параметры 'seconds' или 'minutes'. |
| minutes | Положительное число минут для приостановки. | |
| prompt | Необязательный текст для сообщения запроса. | |
| seconds | Положительное число секунд для приостановки. |
Примечания
Примечание
- Начиная с версии 2.2, если вы укажете 0 или отрицательное значение для минут или секунд, будет ожидать 1 секунду, в предыдущих версиях ожидание было неограниченным.
- Этот модуль также поддерживается для целевых платформ Windows.
- Ввод пользователя не регистрируется и не отображается, независимо от значения параметра echo, когда заданы значения минут или секунд.
Примеры
# Pause for 5 minutes to build app cache.
- pause:
minutes: 5
# Pause until you can verify updates to an application were successful.
- pause:
# A helpful reminder of what to look out for post-update.
- pause:
prompt: "Make sure org.foo.FooOverload exception is not present"
# Pause to get some sensitive input.
- pause:
prompt: "Enter a secret"
echo: no
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| delta string | всегда | Время приостановки в секундах Пример: 2 |
| echo bool | всегда | Значение параметра echo Пример: True |
| start string | всегда | Время начала приостановки Пример: 2017-02-23 14:35:07.298862 |
| stdout string | всегда | Вывод модуля приостановки Пример: Приостановлено на 0.04 минут |
| stop string | всегда | Время окончания приостановки Пример: 2017-02-23 14:35:09.552594 |
| user_input string | если время ожидания не задано | Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя |
Статус
Этот модуль помечен как stableinterface, что означает, что сотрудники, ответственные за этот модуль, гарантируют, что не будут внесены несовместимые изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как core, что означает, что он поддерживается командой Ansible Core Team. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых командой Ansible Core Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat, см. в этой статье базы знаний
Автор
- Tim Bielawa (@tbielawa)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/pause_module.html