pause - Приостановка выполнения плейбука

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Описание

Приостанавливает выполнение плейбука на заданный промежуток времени или до подтверждения запроса. Все параметры необязательны. По умолчанию используется приостановка с запросом.
Для приостановки/ожидания/сна на хост-уровне используйте модуль wait_for.
Вы можете использовать ctrl+c для ускорения приостановки до истечения установленного времени или для полного прерывания выполнения плейбука. Для продолжения досрочно нажмите ctrl+c и затем c. Для прерывания плейбука нажмите ctrl+c и затем a.
Модуль pause интегрируется в асинхронные/параллельные плейбуки без особых соображений (см. Плановые обновления). При использовании приостановок с параметром плейбука serial (как в плановых обновлениях) вы будете получать запрос только один раз для текущей группы хостов.
Этот модуль также поддерживается для целевых систем Windows.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
echo (добавлено в 2.5)	Варианты: да ← нет	Управляет отображением ввода с клавиатуры при вводе. Не оказывает влияния, если заданы значения 'seconds' или 'minutes'.
minutes	Значение по умолчанию: Нет	Положительное число минут для приостановки.
prompt	Значение по умолчанию: Нет	Необязательный текст для сообщения запроса.
seconds	Значение по умолчанию: Нет	Положительное число секунд для приостановки.

Примечания

Примечание

Начиная с версии 2.2, если вы укажете 0 или отрицательное значение для minutes или seconds, будет ожидаться 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 строка	всегда	Время приостановки в секундах Пример: 2
echo логическое значение	всегда	Значение параметра echo Пример: True
start строка	всегда	Время начала приостановки Пример: 2017-02-23 14:35:07.298862
stdout строка	всегда	Вывод модуля pause Пример: Приостановлено на 0.04 минут
stop строка	всегда	Время окончания приостановки Пример: 2017-02-23 14:35:09.552594
user_input строка	если время ожидания не задано	Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя

Статус

Этот модуль отмечен как stableinterface, что означает, что авторы гарантируют отсутствие несовместимых изменений интерфейса.

Поддержка

Для получения дополнительной информации о поддержке этого модуля 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.5/modules/pause_module.html