summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Doran <sdoran@redhat.com>2019-04-30 12:28:34 -0400
committerToshio Kuratomi <a.badger@gmail.com>2019-05-01 06:59:24 -0500
commitf03d9c14506383aa3f4dc2c255d5ee0359921c5b (patch)
tree72a69cf1b6ca1fb7c85b73db3e358baf83c40cff
parentfdbb83cea0582860fd2ff49ee7755fc5bbfdaedf (diff)
downloadansible-f03d9c14506383aa3f4dc2c255d5ee0359921c5b.tar.gz
[stable-2.8] Clarify documentation an reboot delay paramaters (#55934)
(cherry picked from commit 0e8a6e08ce) Co-authored-by: Sam Doran <sdoran@redhat.com>
-rw-r--r--lib/ansible/modules/system/reboot.py6
-rw-r--r--lib/ansible/modules/windows/win_reboot.py6
2 files changed, 6 insertions, 6 deletions
diff --git a/lib/ansible/modules/system/reboot.py b/lib/ansible/modules/system/reboot.py
index c22969678a..cb901e5cae 100644
--- a/lib/ansible/modules/system/reboot.py
+++ b/lib/ansible/modules/system/reboot.py
@@ -23,21 +23,21 @@ version_added: "2.7"
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 4354b67a9c..b252c927b6 100644
--- a/lib/ansible/modules/windows/win_reboot.py
+++ b/lib/ansible/modules/windows/win_reboot.py
@@ -18,13 +18,13 @@ 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.
+ - 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 @@ options:
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 ]