Clarify documentation an reboot delay paramaters (#55934)

ansible · Apr 30, 2019 · 0e8a6e0 · 0e8a6e0
1 parent 9961d02
commit 0e8a6e0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git 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
@@ -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 ]