From 31924e62a24159a595d51a64a090c248ba61ecc7 Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Tue, 30 Apr 2019 10:55:26 -0400 Subject: [PATCH] Clarify documentation an reboot delay paramaters --- lib/ansible/modules/system/reboot.py | 6 +++--- lib/ansible/modules/windows/win_reboot.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/ansible/modules/system/reboot.py b/lib/ansible/modules/system/reboot.py index c22969678a94ad..cb901e5caebcfc 100644 --- a/lib/ansible/modules/system/reboot.py +++ b/lib/ansible/modules/system/reboot.py @@ -23,21 +23,21 @@ options: pre_reboot_delay: description: - - Seconds for shutdown to wait before requesting reboot. + - Seconds to wait before reboot. Passed as a parameter to the reboot command. - On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it will be set to 0. - On Solaris and FreeBSD, this will be seconds. type: int default: 0 post_reboot_delay: description: - - Seconds to wait after the reboot was successful and the connection was re-established. + - Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully. - This is useful if you want wait for something to settle despite your connection already working. type: int default: 0 reboot_timeout: description: - Maximum seconds to wait for machine to reboot and respond to a test command. - - This timeout is evaluated separately for both network connection and test command success so the + - This timeout is evaluated separately for both reboot verification and test command success so the maximum execution time for the module is twice this amount. type: int default: 600 diff --git a/lib/ansible/modules/windows/win_reboot.py b/lib/ansible/modules/windows/win_reboot.py index 4354b67a9c3c7e..b252c927b6b246 100644 --- a/lib/ansible/modules/windows/win_reboot.py +++ b/lib/ansible/modules/windows/win_reboot.py @@ -18,13 +18,13 @@ options: pre_reboot_delay: description: - - Seconds for shutdown to wait before requesting reboot. + - Seconds to wait before reboot. Passed as a parameter to the reboot command. type: int default: 2 aliases: [ pre_reboot_delay_sec ] post_reboot_delay: description: - - Seconds to wait after the reboot was successful and the connection was re-established. + - Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully. - This is useful if you want wait for something to settle despite your connection already working. type: int default: 0 @@ -41,7 +41,7 @@ reboot_timeout: description: - Maximum seconds to wait for machine to re-appear on the network and respond to a test command. - - This timeout is evaluated separately for both network appearance and test command success (so maximum clock time is actually twice this value). + - This timeout is evaluated separately for both reboot verification and test command success so maximum clock time is actually twice this value. type: int default: 600 aliases: [ reboot_timeout_sec ]