1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Clarify documentation an reboot delay paramaters (#55934)

This commit is contained in:
Sam Doran 2019-04-30 12:28:34 -04:00 committed by Alicia Cozine
parent 9961d02547
commit 0e8a6e08ce
2 changed files with 6 additions and 6 deletions

View file

@ -23,21 +23,21 @@ version_added: "2.7"
options: options:
pre_reboot_delay: pre_reboot_delay:
description: 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 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. - On Solaris and FreeBSD, this will be seconds.
type: int type: int
default: 0 default: 0
post_reboot_delay: post_reboot_delay:
description: 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. - This is useful if you want wait for something to settle despite your connection already working.
type: int type: int
default: 0 default: 0
reboot_timeout: reboot_timeout:
description: description:
- Maximum seconds to wait for machine to reboot and respond to a test command. - 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. maximum execution time for the module is twice this amount.
type: int type: int
default: 600 default: 600

View file

@ -18,13 +18,13 @@ version_added: '2.1'
options: options:
pre_reboot_delay: pre_reboot_delay:
description: description:
- Seconds for shutdown to wait before requesting reboot. - Seconds to wait before reboot. Passed as a parameter to the reboot command.
type: int type: int
default: 2 default: 2
aliases: [ pre_reboot_delay_sec ] aliases: [ pre_reboot_delay_sec ]
post_reboot_delay: post_reboot_delay:
description: 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. - This is useful if you want wait for something to settle despite your connection already working.
type: int type: int
default: 0 default: 0
@ -41,7 +41,7 @@ options:
reboot_timeout: reboot_timeout:
description: description:
- Maximum seconds to wait for machine to re-appear on the network and respond to a test command. - 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 type: int
default: 600 default: 600
aliases: [ reboot_timeout_sec ] aliases: [ reboot_timeout_sec ]