ansible.builtin.win_copy (v2.6.20) — module

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

The C(win_copy) module copies a file on the local box to remote windows locations.

For non-Windows targets, use the M(copy) module instead.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy a single file
  win_copy:
    src: /srv/myfiles/foo.conf
    dest: C:\Temp\renamed-foo.conf

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy a single file keeping the filename
  win_copy:
    src: /src/myfiles/foo.conf
    dest: C:\Temp\

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy folder to C:\Temp (results in C:\Temp\temp_files)
  win_copy:
    src: files/temp_files
    dest: C:\Temp

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy folder contents recursively
  win_copy:
    src: files/temp_files/
    dest: C:\Temp

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy a single file where the source is on the remote host
  win_copy:
    src: C:\Temp\foo.txt
    dest: C:\ansible\foo.txt
    remote_src: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Copy a folder recursively where the source is on the remote host
  win_copy:
    src: C:\Temp
    dest: C:\ansible
    remote_src: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set the contents of a file
  win_copy:
    content: abc123
    dest: C:\Temp\foo.txt

Inputs

    
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: true

dest:
    description:
    - Remote absolute path where the file should be copied to. If 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

force:
    default: 'yes'
    description:
    - If set to C(yes), the file will only be transferred if the content is different
      than destination.
    - If set to C(no), the file will only be transferred if the destination does not exist.
    - If set to C(no), no checksuming of the content is performed which can help improve
      performance on larger files.
    type: bool
    version_added: '2.3'
    version_added_collection: ansible.builtin

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.
    version_added: '2.3'
    version_added_collection: ansible.builtin

decrypt:
    default: 'yes'
    description:
    - This option controls the autodecryption of source files using vault.
    type: bool
    version_added: '2.5'
    version_added_collection: ansible.builtin

remote_src:
    default: 'no'
    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
    version_added: '2.3'
    version_added_collection: ansible.builtin

local_follow:
    default: 'yes'
    description:
    - This flag indicates that filesystem links in the source tree, if they exist, should
      be followed.
    type: bool
    version_added: '2.4'
    version_added_collection: ansible.builtin

Outputs

checksum:
  description: sha1 checksum of the file after running copy
  returned: success, src is a file
  sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
  type: string
dest:
  description: destination file/path
  returned: changed
  sample: C:\Temp\
  type: string
operation:
  description: whether a single file copy took place or a folder copy
  returned: success
  sample: file_copy
  type: string
original_basename:
  description: basename of the copied file
  returned: changed, src is a file
  sample: foo.txt
  type: string
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: string