diff options
author | Sam Doran <sdoran@redhat.com> | 2019-05-06 11:05:51 -0400 |
---|---|---|
committer | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2019-05-06 10:05:50 -0500 |
commit | ac416f00caf60e2955f0cbaf95c0beb401af8b0e (patch) | |
tree | 14999eaed676df70493c7acde959cb397a94c7c4 | |
parent | 954462c24fee3c54e568f0177ff0e5007fdb18b1 (diff) | |
download | ansible-ac416f00caf60e2955f0cbaf95c0beb401af8b0e.tar.gz |
[stable-2.7] Clarify documentation an reboot delay paramaters (#55934). (#55959)
(cherry picked from commit 0e8a6e08ce031b21bafd899e9e7d256bb4220688)
Co-authored-by: Sam Doran <sdoran@redhat.com>
-rw-r--r-- | lib/ansible/modules/system/reboot.py | 10 | ||||
-rw-r--r-- | lib/ansible/modules/windows/win_reboot.py | 10 |
2 files changed, 10 insertions, 10 deletions
diff --git a/lib/ansible/modules/system/reboot.py b/lib/ansible/modules/system/reboot.py index 8787f08973..0991b70b4a 100644 --- a/lib/ansible/modules/system/reboot.py +++ b/lib/ansible/modules/system/reboot.py @@ -19,21 +19,21 @@ version_added: "2.7" options: pre_reboot_delay: description: - - Seconds for shutdown to wait before requesting reboot. - - 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. + - 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. default: 0 type: int 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. default: 0 type: int 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. default: 600 type: int diff --git a/lib/ansible/modules/windows/win_reboot.py b/lib/ansible/modules/windows/win_reboot.py index 4cdb47b7b0..2d78e21e02 100644 --- a/lib/ansible/modules/windows/win_reboot.py +++ b/lib/ansible/modules/windows/win_reboot.py @@ -17,14 +17,14 @@ version_added: "2.1" 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 - - This is useful if you want wait for something to settle despite your connection already working + - 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 version_added: '2.4' @@ -39,8 +39,8 @@ options: aliases: [ shutdown_timeout_sec ] 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) + - 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 reboot verification and test command success so maximum clock time is actually twice this value. type: int default: 600 aliases: [ reboot_timeout_sec ] |