win_reboot – Перезагрузка компьютера с Windows
Новая версия в версии 2.1.
Описание
- Перезагрузить компьютер с Windows, дождаться его выключения, включения и готовности к командам.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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отменит запланированное выключение и выполнит своё. - Для целевых систем, не являющихся Windows, используйте модуль reboot вместо этого.
- Пользователь соединения должен иметь разрешение
SeRemoteShutdownPrivilege, см. https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/force-shutdown-from-a-remote-system для получения дополнительной информации.
Примеры
# Unconditionally reboot the machine with all defaults
- win_reboot:
# Apply updates and reboot if necessary
- win_updates:
register: update_result
- win_reboot:
when: update_result.reboot_required
# Reboot a slow machine that might have lots of updates to apply
- win_reboot:
reboot_timeout: 3600
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| elapsed целое число | всегда | Количество секунд, затраченное на ожидание перезагрузки системы. Пример: 23 |
| 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.7/modules/win_reboot_module.html
