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
|
@ -21,19 +21,21 @@ options:
|
|||
content:
|
||||
description:
|
||||
- When used instead of C(src), sets the contents of a file directly to the
|
||||
specified value. This is for simple values, for anything complex or with
|
||||
formatting please switch to the template module.
|
||||
specified value.
|
||||
- This is for simple values, for anything complex or with formatting please
|
||||
switch to the M(template) module.
|
||||
type: str
|
||||
version_added: '2.3'
|
||||
decrypt:
|
||||
description:
|
||||
- This option controls the autodecryption of source files using vault.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
version_added: '2.5'
|
||||
dest:
|
||||
description:
|
||||
- Remote absolute path where the file should be copied to. If src is a
|
||||
directory, this must be a directory too.
|
||||
- Remote absolute path where the file should be copied to.
|
||||
- If C(src) is a directory, this must be a directory too.
|
||||
- Use \ for path separators or \\ when in "double quotes".
|
||||
- If C(dest) ends with \ then source or the contents of source will be
|
||||
copied to the directory without renaming.
|
||||
|
@ -52,21 +54,21 @@ options:
|
|||
- If set to C(no), no checksuming of the content is performed which can
|
||||
help improve performance on larger files.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
version_added: '2.3'
|
||||
local_follow:
|
||||
description:
|
||||
- This flag indicates that filesystem links in the source tree, if they
|
||||
exist, should be followed.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
version_added: '2.4'
|
||||
remote_src:
|
||||
description:
|
||||
- If C(no), it will search for src at originating/master machine.
|
||||
- If C(yes), it will go to the remote/target machine for the src.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
version_added: '2.3'
|
||||
src:
|
||||
description:
|
||||
|
@ -79,10 +81,9 @@ options:
|
|||
end with "/", the directory itself with all contents is copied.
|
||||
- If path is a file and dest ends with "\", the file is copied to the
|
||||
folder with the same filename.
|
||||
required: yes
|
||||
type: path
|
||||
required: yes
|
||||
notes:
|
||||
- For non-Windows targets, use the M(copy) module instead.
|
||||
- Currently win_copy does not support copying symbolic links from both local to
|
||||
remote and remote to remote.
|
||||
- It is recommended that backslashes C(\) are used instead of C(/) when dealing
|
||||
|
@ -141,32 +142,32 @@ EXAMPLES = r'''
|
|||
|
||||
RETURN = r'''
|
||||
dest:
|
||||
description: destination file/path
|
||||
description: Destination file/path.
|
||||
returned: changed
|
||||
type: str
|
||||
sample: C:\Temp\
|
||||
src:
|
||||
description: source file used for the copy on the target machine
|
||||
description: Source file used for the copy on the target machine.
|
||||
returned: changed
|
||||
type: str
|
||||
sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source
|
||||
checksum:
|
||||
description: sha1 checksum of the file after running copy
|
||||
description: SHA1 checksum of the file after running copy.
|
||||
returned: success, src is a file
|
||||
type: str
|
||||
sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
|
||||
size:
|
||||
description: size of the target, after execution
|
||||
description: Size of the target, after execution.
|
||||
returned: changed, src is a file
|
||||
type: int
|
||||
sample: 1220
|
||||
operation:
|
||||
description: whether a single file copy took place or a folder copy
|
||||
description: Whether a single file copy took place or a folder copy.
|
||||
returned: success
|
||||
type: str
|
||||
sample: file_copy
|
||||
original_basename:
|
||||
description: basename of the copied file
|
||||
description: Basename of the copied file.
|
||||
returned: changed, src is a file
|
||||
type: str
|
||||
sample: foo.txt
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue