mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 13:20:23 -07:00
win_reboot: Use more conforming parameter names (#26466)
This is part of the effort to make windows parameters conform to other modules. Usually parameters don't include the unit in the parameter name. See also #20160
This commit is contained in:
parent
5e7b2a1c06
commit
513b582ba3
2 changed files with 61 additions and 35 deletions
|
@ -15,30 +15,35 @@ description:
|
|||
- Reboot a Windows machine, wait for it to go down, come back up, and respond to commands.
|
||||
version_added: "2.1"
|
||||
options:
|
||||
pre_reboot_delay_sec:
|
||||
pre_reboot_delay:
|
||||
description:
|
||||
- Seconds for shutdown to wait before requesting reboot
|
||||
default: 2
|
||||
post_reboot_delay_sec:
|
||||
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
|
||||
default: 0
|
||||
version_added: '2.4'
|
||||
shutdown_timeout_sec:
|
||||
aliases: [ post_reboot_delay_sec ]
|
||||
shutdown_timeout:
|
||||
description:
|
||||
- Maximum seconds to wait for shutdown to occur
|
||||
- Increase this timeout for very slow hardware, large update applications, etc
|
||||
default: 600
|
||||
reboot_timeout_sec:
|
||||
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)
|
||||
default: 600
|
||||
connect_timeout_sec:
|
||||
aliases: [ reboot_timeout_sec ]
|
||||
connect_timeout:
|
||||
description:
|
||||
- Maximum seconds to wait for a single successful TCP connection to the WinRM endpoint before trying again
|
||||
default: 5
|
||||
aliases: [ connect_timeout_sec ]
|
||||
test_command:
|
||||
description:
|
||||
- Command to expect success for to determine the machine is ready for management
|
||||
|
@ -65,16 +70,16 @@ EXAMPLES = r'''
|
|||
|
||||
# Reboot a slow machine that might have lots of updates to apply
|
||||
- win_reboot:
|
||||
shutdown_timeout_sec: 3600
|
||||
reboot_timeout_sec: 3600
|
||||
shutdown_timeout: 3600
|
||||
reboot_timeout: 3600
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
rebooted:
|
||||
description: true if the machine was rebooted
|
||||
returned: always
|
||||
type: boolean
|
||||
sample: true
|
||||
description: true if the machine was rebooted
|
||||
returned: always
|
||||
type: boolean
|
||||
sample: true
|
||||
elapsed:
|
||||
description: The number of seconds that elapsed waiting for the system to be rebooted.
|
||||
returned: always
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue