pause – Остановка выполнения плейбука
Описание
- Приостанавливает выполнение плейбука на заданное время или до подтверждения запроса. Все параметры необязательны. По умолчанию используется запрос на паузу.
- Для приостановки/ожидания/сна на хост-уровне используйте модуль wait_for.
- Вы можете использовать
ctrl+cдля ускорения приостановки до окончания таймера или для полного прерывания выполнения плейбука. Для продолжения раньше нажмитеctrl+cи затемc. Для прерывания плейбука нажмитеctrl+cи затемa. - Модуль pause интегрируется в асинхронные/параллельные плейбуки без особых соображений (см. Инкрементные обновления). При использовании пауз с параметром плейбука
serial(как в инкрементных обновлениях), запрос появляется только один раз для текущей группы хостов. - Этот модуль также поддерживает целевые компьютеры Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| echo boolean добавлено в 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 boolean | всегда | Значение настройки echo Пример: True |
| start string | всегда | Время начала приостановки Пример: 2017-02-23 14:35:07.298862 |
| stdout string | всегда | Вывод модуля pause Пример: Приостановлено на 0.04 минуты |
| stop string | всегда | Время окончания приостановки Пример: 2017-02-23 14:35:09.552594 |
| user_input string | если не задано время ожидания | Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя |
Статус
- Для этого модуля гарантированы изменения интерфейса без обратной совместимости в будущем. [stableinterface]
- Этот модуль поддерживается командой Ansible Core Team. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat см. в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.7/modules/pause_module.html