mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 06:30:19 -07:00
Windows: Add "special" parameter types to docs (#42853)
* Windows: Add special parameter types Adding explicit parameter types now exposes this information in the module documentation, and proves really helpful. We only do this for non-string types as strings, mostly because strings are implicit. PS We also make copyright statements consistent and use #Requires for explicit library imports * Type "string" must be type "str" * A few more Copyright corrections * More fixes * Don't add file encoding to Powershell files * Don't add missing interfacetypes parameter Otherwise CI demands an incorrect version_added * Small fix
This commit is contained in:
parent
290df027e3
commit
95a1170908
127 changed files with 327 additions and 664 deletions
|
@ -18,12 +18,14 @@ options:
|
|||
pre_reboot_delay:
|
||||
description:
|
||||
- Seconds for shutdown to wait before requesting reboot
|
||||
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
|
||||
type: int
|
||||
default: 0
|
||||
version_added: '2.4'
|
||||
aliases: [ post_reboot_delay_sec ]
|
||||
|
@ -32,17 +34,20 @@ options:
|
|||
- Maximum seconds to wait for shutdown to occur
|
||||
- Increase this timeout for very slow hardware, large update applications, etc
|
||||
- This option has been removed since Ansible 2.5 as the win_reboot behavior has changed
|
||||
type: int
|
||||
default: 600
|
||||
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)
|
||||
type: int
|
||||
default: 600
|
||||
aliases: [ reboot_timeout_sec ]
|
||||
connect_timeout:
|
||||
description:
|
||||
- Maximum seconds to wait for a single successful TCP connection to the WinRM endpoint before trying again
|
||||
type: int
|
||||
default: 5
|
||||
aliases: [ connect_timeout_sec ]
|
||||
test_command:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue