ansible.builtin.win_copy (v2.3.0.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.0.0.post1

Description

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

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\foo.conf

Scanned by Steampunk Spotter

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

- name: Copy files/temp_files to c:\temp
  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: True

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

Scanned by Steampunk Spotter

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

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

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 recursively. In this case, if path ends with
      "/", only inside contents of that directory are copied to destination. Otherwise,
      if it does not end with "/", the directory itself with all contents is copied. This
      behavior is similar to Rsync.
    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".
    required: true

force:
    choices:
    - true
    - false
    default: true
    description:
    - If set to C(yes), the remote file will be replaced when content is different than
      the source.
    - If set to C(no), the remote file will only be transferred if the destination does
      not exist.
    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

remote_src:
    choices:
    - true
    - false
    default: false
    description:
    - If False, it will search for src at originating/master machine, if True it will
      go to the remote/target machine for the src.
    version_added: '2.3'
    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: changed
  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 or remote_src == True)
  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