Document behavior of fetch when file already exists (#59816)

* Document behavior of fetch when file already exists
This commit is contained in:
Jered Sutton 2019-07-31 11:09:58 -05:00 committed by Sandra McCann
parent 934d25a820
commit cb9ab42ab8

View file

@ -20,6 +20,7 @@ short_description: Fetch files from remote nodes
description: description:
- This module works like M(copy), but in reverse. - This module works like M(copy), but in reverse.
- It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. - It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname.
- Files that already exist at I(dest) will be overwritten if they are different than the I(src).
- This module is also supported for Windows targets. - This module is also supported for Windows targets.
version_added: '0.2' version_added: '0.2'
options: options:
@ -55,7 +56,8 @@ options:
description: description:
- Allows you to override the default behavior of appending hostname/path/to/file to the destination. - Allows you to override the default behavior of appending hostname/path/to/file to the destination.
- If C(dest) ends with '/', it will use the basename of the source file, similar to the copy module. - If C(dest) ends with '/', it will use the basename of the source file, similar to the copy module.
- Obviously this is only handy if the filenames are unique. - This can be useful if working with a single host, or if retrieving files that are uniquely named per host.
- If using multiple hosts with the same filename, the file will be overwritten for each host.
type: bool type: bool
default: no default: no
notes: notes: