win_reboot – Перезагрузка компьютера с Windows

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

Описание

Перезагружает компьютер с 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/en-us/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 вещественное число	всегда	Количество секунд, затраченное на ожидание перезагрузки системы. Пример: 23.2
rebooted булево	всегда	True, если компьютер перезагрузился. Пример: True

Статус

Этот модуль гарантирует обратную совместимость будущих изменений интерфейса. [stableinterface]
Этот модуль поддерживается командой Ansible Core. [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.9/modules/win_reboot_module.html