1. ansible
  2. Commit f03d9c14506383aa3f4dc2c255d5ee0359921c5b
Browse code

[stable-2.8] Clarify documentation an reboot delay paramaters (#55934) (cherry picked from commit 0e8a6e08ce)

Co-authored-by: Sam Doran <sdoran@redhat.com>

Sam Doran authored on 2019/05/01 01:28:34
Showing 2 changed files
lib/ansible/modules/system/reboot.py
History View file @ f03d9c1
... ... 
@@ -23,21 +23,21 @@ version_added: "2.7"
23 23 
 options:
24 24 
   pre_reboot_delay:
25 25 
     description:
26 
-      - Seconds for shutdown to wait before requesting reboot.
26 
+      - Seconds to wait before reboot. Passed as a parameter to the reboot command.
27 27 
       - On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it will be set to 0.
28 28 
       - On Solaris and FreeBSD, this will be seconds.
29 29 
     type: int
30 30 
     default: 0
31 31 
   post_reboot_delay:
32 32 
     description:
33 
-      - Seconds to wait after the reboot was successful and the connection was re-established.
33 
+      - Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully.
34 34 
       - This is useful if you want wait for something to settle despite your connection already working.
35 35 
     type: int
36 36 
     default: 0
37 37 
   reboot_timeout:
38 38 
     description:
39 39 
       - Maximum seconds to wait for machine to reboot and respond to a test command.
40 
-      - This timeout is evaluated separately for both network connection and test command success so the
40 
+      - This timeout is evaluated separately for both reboot verification and test command success so the
41 41 
         maximum execution time for the module is twice this amount.
42 42 
     type: int
43 43 
     default: 600
lib/ansible/modules/windows/win_reboot.py
History View file @ f03d9c1
... ... 
@@ -18,13 +18,13 @@ version_added: '2.1'
18 18 
 options:
19 19 
   pre_reboot_delay:
20 20 
     description:
21 
-    - Seconds for shutdown to wait before requesting reboot.
21 
+    - Seconds to wait before reboot. Passed as a parameter to the reboot command.
22 22 
     type: int
23 23 
     default: 2
24 24 
     aliases: [ pre_reboot_delay_sec ]
25 25 
   post_reboot_delay:
26 26 
     description:
27 
-    - Seconds to wait after the reboot was successful and the connection was re-established.
27 
+    - Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully.
28 28 
     - This is useful if you want wait for something to settle despite your connection already working.
29 29 
     type: int
30 30 
     default: 0
... ... 
@@ -41,7 +41,7 @@ options:
41 41 
   reboot_timeout:
42 42 
     description:
43 43 
     - Maximum seconds to wait for machine to re-appear on the network and respond to a test command.
44 
-    - This timeout is evaluated separately for both network appearance and test command success (so maximum clock time is actually twice this value).
44 
+    - This timeout is evaluated separately for both reboot verification and test command success so maximum clock time is actually twice this value.
45 45 
     type: int
46 46 
     default: 600
47 47 
     aliases: [ reboot_timeout_sec ]