summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoraaronk1 <aaronk1@users.noreply.github.com>2018-09-26 16:28:16 -0400
committerJordan Borean <jborean93@gmail.com>2018-09-27 06:28:15 +1000
commit8498b58ad57414c8d1ed269f80cd7f1ac6f6fc5a (patch)
tree68744df20e577eb63c1f090192addfb7de0424fe
parent08c392477ebc98111cee950df16af943a5726c8c (diff)
downloadansible-8498b58ad57414c8d1ed269f80cd7f1ac6f6fc5a.tar.gz
Update win_robocopy.py (#38633)
* Update win_robocopy.py <!--- Show example of UNC path copy of a single file, noting trailing backslash required --> +label: docsite_pr * addresses jborean comment, removes double quotes * Remove trailing slash part
-rw-r--r--lib/ansible/modules/windows/win_robocopy.py10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/ansible/modules/windows/win_robocopy.py b/lib/ansible/modules/windows/win_robocopy.py
index 3a06e98d93..0aac86f2a0 100644
--- a/lib/ansible/modules/windows/win_robocopy.py
+++ b/lib/ansible/modules/windows/win_robocopy.py
@@ -17,9 +17,9 @@ module: win_robocopy
version_added: '2.2'
short_description: Synchronizes the contents of two directories using Robocopy
description:
-- Synchronizes the contents of two directories on the remote machine.
+- Synchronizes the contents of files/directories from a source to destination.
- Under the hood this just calls out to RoboCopy, since that should be available
- on most modern Windows Systems.
+ on most modern Windows systems.
options:
src:
description:
@@ -84,6 +84,12 @@ EXAMPLES = r'''
src: C:\DirectoryOne
dest: C:\DirectoryTwo
flags: /E /PURGE /XD SOME_DIR /XF SOME_FILE /MT:32
+
+- name: Sync one file from a remote UNC path in recursive and purging mode, specifying additional special flags
+ win_robocopy:
+ src: \\Server1\Directory One
+ dest: C:\DirectoryTwo
+ flags: file.zip /E /PURGE /XD SOME_DIR /XF SOME_FILE /MT:32
'''
RETURN = r'''