ansible.builtin.pause – Приостановка выполнения playbook

Примечание

Этот модуль является частью ansible-base и включен во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля pause даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать FQCN для лёгкой ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь то же имя модуля.

Добавлен в версии 0.8: of ansible.builtin

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Примечание

Этот модуль имеет соответствующий плагин действия.

Параметры

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

Примечания

Примечание

Начиная с версии 2.2, если вы укажете 0 или отрицательное значение для минут или секунд, он будет ожидать 1 секунду, в предыдущих версиях он ожидал неопределённое время.
Этот модуль также поддерживается для Windows-целей.
Ввод пользователя не сохраняется и не отображается, независимо от настроек echo, когда заданы minutes или seconds.

Примеры

- name: Pause for 5 minutes to build app cache
  pause:
    minutes: 5

- name: Pause until you can verify updates to an application were successful
  pause:

- name: A helpful reminder of what to look out for post-update
  pause:
    prompt: "Make sure org.foo.FooOverload exception is not present"

- name: 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	если время ожидания не задано	Ввод пользователя из интерактивной консоли Пример: Пример ввода пользователя

Авторы

Tim Bielawa (@tbielawa)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/pause_module.html