VhdZdZdZy)a --- module: win_robocopy short_description: Synchronizes the contents of two directories using Robocopy description: - 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. options: src: description: - Source file/directory to sync. type: path required: yes dest: description: - Destination file/directory to sync (Will receive contents of src). 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 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. type: bool default: no flags: description: - 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(ansible.posix.synchronize) module. Unlike the M(ansible.posix.synchronize) module this only performs the sync/copy on the remote machine, not from the Ansible controller to the remote machine. - This module does not currently support all Robocopy flags. seealso: - module: ansible.posix.synchronize - module: ansible.windows.win_copy author: - Corwin Brown (@blakfeld) a& - name: Sync the contents of one directory to another community.windows.win_robocopy: src: C:\DirectoryOne dest: C:\DirectoryTwo - name: Sync the contents of one directory to another, including subdirectories community.windows.win_robocopy: src: C:\DirectoryOne dest: C:\DirectoryTwo recurse: true - name: Sync the contents of one directory to another, and remove any files/directories found in destination that do not exist in the source community.windows.win_robocopy: src: C:\DirectoryOne dest: C:\DirectoryTwo purge: true - name: Sync content in recursive mode, removing any files/directories found in destination that do not exist in the source community.windows.win_robocopy: src: C:\DirectoryOne dest: C:\DirectoryTwo recurse: true purge: true - name: Sync two directories in recursive and purging mode, specifying additional special flags community.windows.win_robocopy: 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 community.windows.win_robocopy: src: \\Server1\Directory One dest: C:\DirectoryTwo flags: file.zip /E /PURGE /XD SOME_DIR /XF SOME_FILE /MT:32 a cmd: description: The used command line. returned: always type: str sample: robocopy C:\DirectoryOne C:\DirectoryTwo /e /purge src: description: The Source file/directory of the sync. returned: always type: str sample: C:\Some\Path dest: description: The Destination file/directory of the sync. returned: always type: str sample: C:\Some\Path recurse: description: Whether or not the recurse flag was toggled. returned: always type: bool sample: false purge: description: Whether or not the purge flag was toggled. returned: always type: bool sample: false flags: description: Any flags passed in by the user. returned: always type: str sample: /e /purge rc: description: The return code returned by robocopy. returned: success type: int sample: 1 output: description: The output of running the robocopy command. returned: success type: str sample: "------------------------------------\\n ROBOCOPY :: Robust File Copy for Windows \\n------------------------------------\\n " msg: description: Output interpreted into a concise message. returned: always type: str sample: No files copied! N) DOCUMENTATIONEXAMPLESRETURNr/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/windows/plugins/modules/win_robocopy.pyrs. `$ L. r