Skip to content

Commit

Permalink
[stable-2.7] Clarify documentation an reboot delay paramaters (ansibl…
Browse files Browse the repository at this point in the history
…e#55934).

(cherry picked from commit 0e8a6e0)

Co-authored-by: Sam Doran <sdoran@redhat.com>
  • Loading branch information
samdoran committed Apr 30, 2019
1 parent a44b62a commit 551bcfa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions lib/ansible/modules/system/reboot.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@
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
Expand Down
10 changes: 5 additions & 5 deletions lib/ansible/modules/windows/win_reboot.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
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'
Expand All @@ -39,8 +39,8 @@
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 ]
Expand Down

0 comments on commit 551bcfa

Please sign in to comment.