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 строка | всегда | Время паузы в секундах Пример: 2 |
| echo boolean | всегда | Значение настройки echo Пример: True |
| start строка | всегда | Время начала паузы Пример: 2017-02-23 14:35:07.298862 |
| stdout строка | всегда | Вывод модуля паузы Пример: Остановлено на 0.04 минут |
| stop строка | всегда | Время окончания паузы Пример: 2017-02-23 14:35:09.552594 |
| user_input строка | если время ожидания не задано | Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя |
Статус
- Данный модуль гарантированно не будет иметь обратных несовместимых изменений интерфейса в будущем. [stableinterface]
- Этот модуль поддерживается командой Ansible Core. [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.8/modules/pause_module.html
