pause – Остановка выполнения плейбука
Обзор
- Останавливает выполнение плейбука на заданное время или до подтверждения запроса. Все параметры необязательны. По умолчанию происходит пауза с запросом.
- Для приостановки/ожидания/сна по хостам используйте модуль wait_for.
- Вы можете использовать
ctrl+cдля ускорения паузы или полного прерывания выполнения плейбука. Чтобы продолжить раньше, нажмитеctrl+cи затемc. Чтобы прервать плейбук, нажмитеctrl+cи затемa. - Модуль паузы интегрируется в асинхронные/параллельные плейбуки без особых соображений (см. Распределенные обновления). При использовании пауз с параметром плейбука
serial(как в распределенных обновлениях) вы получаете запрос только один раз для текущей группы хостов. - Этот модуль также поддерживается для целевых систем Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| echo boolean добавлено в 2.5 |
| Управляет отображением клавиатурного ввода при наборе. Не имеет эффекта, если заданы 'seconds' или 'minutes'. |
| minutes - | Положительное число минут для паузы. | |
| prompt - | Необязательный текст для сообщения запроса. | |
| seconds - | Положительное число секунд для паузы. |
Примечания
Примечание
- Начиная с версии 2.2, если вы укажете 0 или отрицательное значение для минут или секунд, будет ожидаться 1 секунда. Ранее ожидалось неопределенное время.
- Этот модуль также поддерживается для целевых систем Windows.
- Ввод пользователя не сохраняется и не отображается, независимо от настройки echo, когда заданы minutes или seconds.
Примеры
# 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 | всегда | Вывод модуля паузы Пример: Остановлено на 0.04 минут |
| stop string | всегда | Время окончания паузы Пример: 2017-02-23 14:35:09.552594 |
| user_input string | если время ожидания не задано | Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя |
Статус
- Этот модуль гарантирует совместимость интерфейса в будущем. [stableinterface]
- Этот модуль поддерживается командой разработчиков Ansible. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в статье Базы знаний 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.9/modules/pause_module.html
