ansible.builtin.reboot – Перезагрузка машины

Примечание

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

Добавлен в версии 2.7: из ansible.builtin

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

Обзор

Перезагрузите машину, дождитесь её выключения, последующего включения и готовности к командам.
Для целевых систем Windows используйте модуль ansible.windows.win_reboot вместо этого.

Примечание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
boot_time_command строка добавлен в 2.10 из ansible.builtin	Значение по умолчанию: "cat /proc/sys/kernel/random/boot_id"	Команда, которая возвращает уникальную строку, указывающую последний запуск системы. Установка команды, которая каждый раз возвращает разный результат, приведёт к ошибке задачи.
connect_timeout целое число		Максимальное время (в секундах) ожидания успешного подключения к управляемым хостам перед повторной попыткой. Если не указано, используется значение по умолчанию для плагина подключения.
msg строка	Значение по умолчанию: "Перезагрузка инициирована Ansible"	Сообщение для отображения пользователям перед перезагрузкой.
post_reboot_delay целое число	Значение по умолчанию: 0	Время ожидания (в секундах) после успешного выполнения команды перезагрузки перед проверкой успешной перезагрузки системы. Это полезно, если нужно подождать, пока что-то стабилизируется, даже если подключение уже работает.
pre_reboot_delay целое число	Значение по умолчанию: 0	Время ожидания (в секундах) перед перезагрузкой. Передаётся как параметр в команду перезагрузки. В Linux, macOS и OpenBSD это преобразуется в минуты и округляется вниз. Если меньше 60, оно устанавливается в 0. В Solaris и FreeBSD это будет секунды.
reboot_command строка добавлен в 2.11 из ansible.builtin	Значение по умолчанию: "[определяется на основе ОС цели]"	Команда для перезагрузки системы, включая любые передаваемые параметры. Может быть абсолютным путём к команде или просто именем команды. Если абсолютный путь к команде не задан, будет произведён поиск в `search_paths` на целевой системе. Это приведет к тому, что `pre_reboot_delay`, `post_reboot_delay`, и `msg` будут проигнорированы.
reboot_timeout целое число	Значение по умолчанию: 600	Максимальное время (в секундах) ожидания перезагрузки машины и ответа на тестовую команду. Этот таймаут оценивается отдельно для проверки перезагрузки и успешного выполнения тестовой команды, поэтому максимальное время выполнения модуля — это удвоенное значение.
search_paths список / элементы=строка добавлен в 2.8 из ansible.builtin	Значение по умолчанию: ["/sbin", "/bin", "/usr/sbin", "/usr/bin", "/usr/local/sbin"]	Пути для поиска на удалённой машине команды `shutdown`. Только эти пути будут использованы для поиска команды `shutdown`. `PATH` игнорируется на удалённом узле при поиске команды `shutdown`.
test_command строка	Значение по умолчанию: "whoami"	Команда для выполнения на перезагруженном узле и ожидание успеха, чтобы определить, что машина готова к дальнейшим задачам.

Примечания

Примечание

PATH игнорируется на удаленном узле при поиске команды shutdown. Используйте search_paths для указания мест поиска, если пути по умолчанию не работают.

См. также

ansible.windows.win_reboot: Официальная документация по модулю ansible.windows.win_reboot.

Примеры

- name: Unconditionally reboot the machine with all defaults
  reboot:

- name: Reboot a slow machine that might have lots of updates to apply
  reboot:
    reboot_timeout: 3600

- name: Reboot a machine with shutdown command in unusual place
  reboot:
    search_paths:
     - '/lib/molly-guard'

- name: Reboot machine using a custom reboot command
  reboot:
    reboot_command: launchctl reboot userspace
    boot_time_command: uptime | cut -d ' ' -f 5

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
elapsed целое число	всегда	Количество секунд, затраченное на ожидание перезагрузки системы. Пример: 23
rebooted булево	всегда	true, если машина перезагрузилась Пример: True

Авторы

Matt Davis (@nitzmahone)
Sam Doran (@samdoran)

© 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/reboot_module.html