Try SpotterCopies files to remote locations on windows hosts
Authors: Jon Hawkesworth (@jhawkesworth), Jordan Borean (@jborean93)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install ansible.windows:==2.3.0
collections:
- name: ansible.windows
version: 2.3.0The C(win_copy) module copies a file on the local box to remote windows locations.
For non-Windows targets, use the M(ansible.builtin.copy) module instead.
- name: Copy a single file
ansible.windows.win_copy:
src: /srv/myfiles/foo.conf
dest: C:\Temp\renamed-foo.conf
- name: Copy a single file, but keep a backup
ansible.windows.win_copy:
src: /srv/myfiles/foo.conf
dest: C:\Temp\renamed-foo.conf
backup: yes
- name: Copy a single file keeping the filename
ansible.windows.win_copy:
src: /src/myfiles/foo.conf
dest: C:\Temp\
- name: Copy folder to C:\Temp (results in C:\Temp\temp_files)
ansible.windows.win_copy:
src: files/temp_files
dest: C:\Temp
- name: Copy folder contents recursively
ansible.windows.win_copy:
src: files/temp_files/
dest: C:\Temp
- name: Copy a single file where the source is on the remote host
ansible.windows.win_copy:
src: C:\Temp\foo.txt
dest: C:\ansible\foo.txt
remote_src: true
- name: Copy a folder recursively where the source is on the remote host
ansible.windows.win_copy:
src: C:\Temp
dest: C:\ansible
remote_src: true
- name: Set the contents of a file
ansible.windows.win_copy:
content: abc123
dest: C:\Temp\foo.txt
- name: Copy a single file as another user
ansible.windows.win_copy:
src: NuGet.config
dest: '%AppData%\NuGet\NuGet.config'
vars:
ansible_become_user: user
ansible_become_password: pass
# The tmp dir must be set when using win_copy as another user
# This ensures the become user will have permissions for the operation
# Make sure to specify a folder both the ansible_user and the become_user have access to (i.e not %TEMP% which is user specific and requires Admin)
ansible_remote_tmp: 'c:\tmp'
src:
description:
- Local path to a file to copy to the remote server; can be absolute or relative.
- If path is a directory, it is copied (including the source folder name) recursively
to C(dest).
- If path is a directory and ends with "/", only the inside contents of that directory
are copied to the destination. Otherwise, if it does not 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 unless using C(content).
type: path
dest:
description:
- 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.
- If C(dest) is a nonexistent path, it will only be created if C(dest) ends with "/"
or "\", or C(src) is a directory.
- If C(src) and C(dest) are files and if the parent directory of C(dest) doesn't exist,
then the task will fail.
required: true
type: path
force:
default: true
description:
- If set to C(true), the file will only be transferred if the content is different
than destination.
- If set to C(false), the file will only be transferred if the destination does not
exist.
- If set to C(false), no checksuming of the content is performed which can help improve
performance on larger files.
type: bool
backup:
default: false
description:
- Determine whether a backup should be created.
- When set to C(true), create a backup file including the timestamp information so
you can get the original file back if you somehow clobbered it incorrectly.
- No backup is taken when C(remote_src=False) and multiple files are being copied.
type: bool
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 M(ansible.windows.win_template) module.
type: str
decrypt:
default: true
description:
- This option controls the autodecryption of source files using vault.
type: bool
remote_src:
default: false
description:
- If C(false), it will search for src at originating/controller machine.
- If C(true), it will go to the remote/target machine for the src.
type: bool
local_follow:
default: true
description:
- This flag indicates that filesystem links in the source tree, if they exist, should
be followed.
type: bool
backup_file: description: Name of the backup file that was created. returned: if backup=yes sample: C:\Path\To\File.txt.11540.20150212-220915.bak type: str checksum: description: SHA1 checksum of the file after running copy. returned: success, src is a file sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 type: str dest: description: Destination file/path. returned: changed sample: C:\Temp\ type: str operation: description: Whether a single file copy took place or a folder copy. returned: success sample: file_copy type: str original_basename: description: Basename of the copied file. returned: changed, src is a file sample: foo.txt type: str size: description: Size of the target, after execution. returned: changed, src is a file sample: 1220 type: int src: description: Source file used for the copy on the target machine. returned: changed sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source type: str