mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
Windows: Add missing parameter types and doc fixes (#50232)
* Windows: Add missing parameter types and doc fixes This PR includes: - Adding missing parameter types - Various documentation fixes * Update lib/ansible/modules/windows/win_copy.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_credential.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_computer.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_user.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_environment.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_psexec.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_uri.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_wait_for.py Co-Authored-By: dagwieers <dag@wieers.com> * Ensure docstrings are raw strings
This commit is contained in:
parent
f80ce60cf9
commit
d863027159
92 changed files with 982 additions and 716 deletions
|
@ -24,28 +24,31 @@ options:
|
|||
src:
|
||||
description:
|
||||
- Source file/directory to sync.
|
||||
required: yes
|
||||
type: path
|
||||
required: yes
|
||||
dest:
|
||||
description:
|
||||
- Destination file/directory to sync (Will receive contents of src).
|
||||
required: yes
|
||||
type: path
|
||||
required: yes
|
||||
recurse:
|
||||
description:
|
||||
- Includes all subdirectories (Toggles the C(/e) flag to RoboCopy).
|
||||
- If C(flags) is set, this will be ignored.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
purge:
|
||||
description:
|
||||
- Deletes any files/directories found in the destination that do not exist in the source.
|
||||
- Toggles the C(/purge) flag to RoboCopy. If C(flags) is set, this will be ignored.
|
||||
- Toggles the C(/purge) flag to RoboCopy.
|
||||
- If C(flags) is set, this will be ignored.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
flags:
|
||||
description:
|
||||
- Directly supply Robocopy flags. If set, C(purge) and C(recurse) will be ignored.
|
||||
- Directly supply Robocopy flags.
|
||||
- If set, C(purge) and C(recurse) will be ignored.
|
||||
type: str
|
||||
notes:
|
||||
- This is not a complete port of the M(synchronize) module. Unlike the M(synchronize) module this only performs the sync/copy on the remote machine,
|
||||
not from the master to the remote machine.
|
||||
|
@ -97,7 +100,7 @@ EXAMPLES = r'''
|
|||
|
||||
RETURN = r'''
|
||||
cmd:
|
||||
description: The used command line
|
||||
description: The used command line.
|
||||
returned: always
|
||||
type: str
|
||||
sample: robocopy C:\DirectoryOne C:\DirectoryTwo /e /purge
|
||||
|
@ -115,12 +118,12 @@ recurse:
|
|||
description: Whether or not the recurse flag was toggled.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: False
|
||||
sample: false
|
||||
purge:
|
||||
description: Whether or not the purge flag was toggled.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: False
|
||||
sample: false
|
||||
flags:
|
||||
description: Any flags passed in by the user.
|
||||
returned: always
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue