diff options
Diffstat (limited to 'lib/ansible/modules/windows/win_copy.py')
-rw-r--r-- | lib/ansible/modules/windows/win_copy.py | 207 |
1 files changed, 0 insertions, 207 deletions
diff --git a/lib/ansible/modules/windows/win_copy.py b/lib/ansible/modules/windows/win_copy.py deleted file mode 100644 index a55f4c65b7..0000000000 --- a/lib/ansible/modules/windows/win_copy.py +++ /dev/null @@ -1,207 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk> -# Copyright: (c) 2017, Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - -ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['stableinterface'], - 'supported_by': 'core'} - -DOCUMENTATION = r''' ---- -module: win_copy -version_added: '1.9.2' -short_description: Copies files to remote locations on windows hosts -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. -options: - 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(template) module. - type: str - version_added: '2.3' - decrypt: - description: - - This option controls the autodecryption of source files using vault. - type: bool - default: yes - version_added: '2.5' - 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. - type: path - required: yes - backup: - description: - - Determine whether a backup should be created. - - When set to C(yes), 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 - default: no - version_added: '2.8' - force: - 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 - default: yes - version_added: '2.3' - local_follow: - description: - - This flag indicates that filesystem links in the source tree, if they - exist, should be followed. - type: bool - default: yes - version_added: '2.4' - remote_src: - 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 - default: no - version_added: '2.3' - 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 -notes: -- Currently win_copy does not support copying symbolic links from both local to - remote and remote to remote. -- It is recommended that backslashes C(\) are used instead of C(/) when dealing - with remote paths. -- Because win_copy runs over WinRM, it is not a very efficient transfer - mechanism. If sending large files consider hosting them on a web service and - using M(win_get_url) instead. -seealso: -- module: assemble -- module: copy -- module: win_get_url -- module: win_robocopy -author: -- Jon Hawkesworth (@jhawkesworth) -- Jordan Borean (@jborean93) -''' - -EXAMPLES = r''' -- name: Copy a single file - win_copy: - src: /srv/myfiles/foo.conf - dest: C:\Temp\renamed-foo.conf - -- name: Copy a single file, but keep a backup - win_copy: - src: /srv/myfiles/foo.conf - dest: C:\Temp\renamed-foo.conf - backup: yes - -- name: Copy a single file keeping the filename - win_copy: - src: /src/myfiles/foo.conf - dest: C:\Temp\ - -- name: Copy folder to C:\Temp (results in C:\Temp\temp_files) - win_copy: - src: files/temp_files - dest: C:\Temp - -- name: Copy folder contents recursively - win_copy: - src: files/temp_files/ - dest: C:\Temp - -- 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 - -- name: Copy a folder recursively where the source is on the remote host - win_copy: - src: C:\Temp - dest: C:\ansible - remote_src: yes - -- name: Set the contents of a file - win_copy: - content: abc123 - dest: C:\Temp\foo.txt - -- name: Copy a single file as another user - 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' -''' - -RETURN = r''' -backup_file: - description: Name of the backup file that was created. - returned: if backup=yes - type: str - sample: C:\Path\To\File.txt.11540.20150212-220915.bak -dest: - description: Destination file/path. - returned: changed - type: str - sample: C:\Temp\ -src: - description: Source file used for the copy on the target machine. - returned: changed - type: str - sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source -checksum: - description: SHA1 checksum of the file after running copy. - returned: success, src is a file - type: str - sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 -size: - description: Size of the target, after execution. - returned: changed, src is a file - type: int - sample: 1220 -operation: - description: Whether a single file copy took place or a folder copy. - returned: success - type: str - sample: file_copy -original_basename: - description: Basename of the copied file. - returned: changed, src is a file - type: str - sample: foo.txt -''' |