win_reboot – Перезагрузка компьютера Windows
Новое в версии 2.1.
Описание
- Перезагружает компьютер с Windows, ожидает его выключения, включения и готовности к командам.
- Для целевых систем, отличных от Windows, используйте модуль reboot.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| connect_timeout целое число | По умолчанию: 5 | Максимальное время (в секундах) ожидания успешного TCP-соединения с конечной точкой WinRM перед повторной попыткой. Псевдонимы: connect_timeout_sec |
| msg строка | По умолчанию: "Перезагрузка инициирована Ansible" | Сообщение для отображения пользователям. |
| post_reboot_delay целое число добавлено в 2.4 | По умолчанию: 0 | Время ожидания (в секундах) после успешной перезагрузки перед проверкой успешного перезапуска системы. Это полезно, если нужно дождаться завершения каких-либо процессов, несмотря на то, что соединение уже работает. Псевдонимы: post_reboot_delay_sec |
| pre_reboot_delay целое число | По умолчанию: 2 | Время ожидания (в секундах) перед перезагрузкой. Передается в качестве параметра команде перезагрузки. Псевдонимы: pre_reboot_delay_sec |
| reboot_timeout целое число | По умолчанию: 600 | Максимальное время (в секундах) ожидания возвращения машины в сеть и ответа на тестовую команду. Этот таймаут оценивается отдельно как для проверки перезагрузки, так и для успешного выполнения тестовой команды, поэтому максимальное время составляет фактически дважды это значение. Псевдонимы: reboot_timeout_sec |
| shutdown_timeout целое число | По умолчанию: 600 | Максимальное время (в секундах) ожидания завершения выключения. Увеличьте этот таймаут для очень медленного оборудования, больших обновлений и т. д. Этот параметр был удален начиная с Ansible 2.5, так как поведение win_reboot изменилось. Псевдонимы: shutdown_timeout_sec |
| test_command строка | По умолчанию: "whoami" | Команда, выполнение которой ожидают для определения готовности машины к управлению. |
Примечания
Примечание
- Если на системе уже запланировано выключение,
win_rebootпрервёт запланированное выключение и выполнит собственное выключение. - Обратите внимание, что при возвращении
win_rebootсистема Windows может не стабилизироваться, а некоторые основные службы могут находиться в подвешенном состоянии. Это может привести к неожиданному поведению. Обратитесь к примерам для устранения этого. - Пользователь соединения должен иметь включенный привилегий
SeRemoteShutdownPrivilege, см. https://docs.microsoft.com/ru-ru/windows/security/threat-protection/security-policy-settings/force-shutdown-from-a-remote-system для получения дополнительной информации.
См. также
См. также
- reboot – Перезагрузка машины
- Официальная документация модуля reboot.
Примеры
- name: Reboot the machine with all defaults
win_reboot:
- name: Reboot a slow machine that might have lots of updates to apply
win_reboot:
reboot_timeout: 3600
# Install a Windows feature and reboot if necessary
- name: Install IIS Web-Server
win_feature:
name: Web-Server
register: iis_install
- name: Reboot when Web-Server feature requires it
win_reboot:
when: iis_install.reboot_required
# One way to ensure the system is reliable, is to set WinRM to a delayed startup
- name: Ensure WinRM starts when the system has settled and is ready to work reliably
win_service:
name: WinRM
start_mode: delayed
# Additionally, you can add a delay before running the next task
- name: Reboot a machine that takes time to settle after being booted
win_reboot:
post_reboot_delay: 120
# Or you can make win_reboot validate exactly what you need to work before running the next task
- name: Validate that the netlogon service has started, before running the next task
win_reboot:
test_command: 'exit (Get-Service -Name Netlogon).Status -ne "Running"'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| elapsed float | всегда | Количество секунд, затраченное на ожидание перезагрузки системы. Пример: 23.2 |
| rebooted boolean | всегда | True, если машина была перезагружена. Пример: True |
Статус
- Этот модуль гарантированно не будет иметь изменений в обратной совместимости в дальнейшем. [stableinterface]
- Этот модуль поддерживается основной командой Ansible. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Matt Davis (@nitzmahone)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/win_reboot_module.html