Vhj}ddlmZdZdZdZddlZddlZddlZddlZddl Zddl Z ddl Z ddl Z ddl Z ddlZddlmZmZddlmZGdd eZd Zd Zd Zd ZdZdZdZedk(reyy)) annotationsa --- module: copy version_added: historical short_description: Copy files to remote locations description: - The M(ansible.builtin.copy) module copies a file or a directory structure from the local or remote machine to a location on the remote machine. File system meta-information (permissions, ownership, etc.) may be set, even when the file or directory already exists on the target system. Some meta-information may be copied on request. - Get meta-information with the M(ansible.builtin.stat) module. - Set meta-information with the M(ansible.builtin.file) module. - Use the M(ansible.builtin.fetch) module to copy files from remote locations to the local box. - If you need variable interpolation in copied files, use the M(ansible.builtin.template) module. Using a variable with the O(content) parameter produces unpredictable results. - For Windows targets, use the M(ansible.windows.win_copy) module instead. options: src: description: - Local path to a file to copy to the remote server. - This can be absolute or relative. - If path is a directory, it is copied recursively. In this case, if path ends with C(/), only inside contents of that directory are copied to destination. Otherwise, if it does not end with C(/), the directory itself with all contents is copied. This behavior is similar to the C(rsync) command line tool. type: path content: description: - When used instead of O(src), sets the contents of a file directly to the specified value. - Works only when O(dest) is a file. Creates the file if it does not exist. - For advanced formatting or if O(content) contains a variable, use the M(ansible.builtin.template) module. type: str version_added: '1.1' dest: description: - Remote absolute path where the file should be copied to. - If O(src) is a directory, this must be a directory too. - If O(dest) is a non-existent path and if either O(dest) ends with C(/) or O(src) is a directory, O(dest) is created. - If O(dest) is a relative path, the starting directory is determined by the remote host. - If O(src) and O(dest) are files, the parent directory of O(dest) is not created and the task fails if it does not already exist. type: path required: yes backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool default: no version_added: '0.7' force: description: - Influence whether the remote file must always be replaced. - If V(true), the remote file will be replaced when contents are different than the source. - If V(false), the file will only be transferred if the destination does not exist. type: bool default: yes version_added: '1.1' mode: description: - The permissions of the destination file or directory. - For those used to C(/usr/bin/chmod) remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like V(0644) or V(01777)) or quote it (like V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)). - As of Ansible 2.3, the mode may also be the special string V(preserve). - V(preserve) means that the file will be given the same permissions as the source file. - When doing a recursive copy, see also O(directory_mode). - If O(mode) is not specified and the destination file B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created file. - If O(mode) is not specified and the destination file B(does) exist, the mode of the existing file will be used. - Specifying O(mode) is the best way to ensure files are created with the correct permissions. See CVE-2020-1736 for further details. directory_mode: description: - Set the access permissions of newly created directories to the given mode. Permissions on existing directories do not change. - See O(mode) for the syntax of accepted values. - The target system's defaults determine permissions when this parameter is not set. type: raw version_added: '1.5' remote_src: description: - Influence whether O(src) needs to be transferred or already is present remotely. - If V(false), it will search for O(src) on the controller node. - If V(true), it will search for O(src) on the managed (remote) node. - O(remote_src) supports recursive copying as of version 2.8. - O(remote_src) only works with O(mode=preserve) as of version 2.6. - Auto-decryption of files does not work when O(remote_src=yes). type: bool default: no version_added: '2.0' follow: description: - This flag indicates that filesystem links in the destination, if they exist, should be followed. type: bool default: no version_added: '1.8' 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' checksum: description: - SHA1 checksum of the file being transferred. - Used to validate that the copy of the file was successful. - If this is not provided, ansible will use the local calculated checksum of the src file. type: str version_added: '2.5' extends_documentation_fragment: - decrypt - files - validate - action_common_attributes - action_common_attributes.files - action_common_attributes.flow notes: - The M(ansible.builtin.copy) module recursively copy facility does not scale to lots (>hundreds) of files. seealso: - module: ansible.builtin.assemble - module: ansible.builtin.fetch - module: ansible.builtin.file - module: ansible.builtin.template - module: ansible.posix.synchronize - module: ansible.windows.win_copy author: - Ansible Core Team - Michael DeHaan attributes: action: support: full async: support: none bypass_host_loop: support: none check_mode: support: full diff_mode: support: full platform: platforms: posix safe_file_operations: support: full vault: support: full version_added: '2.2' a - name: Copy file with owner and permissions ansible.builtin.copy: src: /srv/myfiles/foo.conf dest: /etc/foo.conf owner: foo group: foo mode: '0644' - name: Copy file with owner and permission, using symbolic representation ansible.builtin.copy: src: /srv/myfiles/foo.conf dest: /etc/foo.conf owner: foo group: foo mode: u=rw,g=r,o=r - name: Another symbolic mode example, adding some permissions and removing others ansible.builtin.copy: src: /srv/myfiles/foo.conf dest: /etc/foo.conf owner: foo group: foo mode: u+rw,g-wx,o-rwx - name: Copy a new "ntp.conf" file into place, backing up the original if it differs from the copied version ansible.builtin.copy: src: /mine/ntp.conf dest: /etc/ntp.conf owner: root group: root mode: '0644' backup: yes - name: Copy a new "sudoers" file into place, after passing validation with visudo ansible.builtin.copy: src: /mine/sudoers dest: /etc/sudoers validate: /usr/sbin/visudo -csf %s - name: Copy a "sudoers" file on the remote machine for editing ansible.builtin.copy: src: /etc/sudoers dest: /etc/sudoers.edit remote_src: yes validate: /usr/sbin/visudo -csf %s - name: Copy using inline content ansible.builtin.copy: content: '# This file was moved to /etc/other.conf' dest: /etc/mine.conf - name: If follow=yes, /path/to/file will be overwritten by contents of foo.conf ansible.builtin.copy: src: /etc/foo.conf dest: /path/to/link # link to /path/to/file follow: yes - name: If follow=no, /path/to/link will become a file and be overwritten by contents of foo.conf ansible.builtin.copy: src: /etc/foo.conf dest: /path/to/link # link to /path/to/file follow: no a; dest: description: Destination file/path. returned: success type: str sample: /path/to/file.txt 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 md5sum: description: MD5 checksum of the file after running copy. returned: when supported type: str sample: 2a5aeecc61dc98c4d780b14b330e3282 checksum: description: SHA1 checksum of the file after running copy. returned: success type: str sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 backup_file: description: Name of backup file created. returned: changed and if backup=yes type: str sample: /path/to/file.txt.2015-02-12@22:09~ gid: description: Group id of the file, after execution. returned: success type: int sample: 100 group: description: Group of the file, after execution. returned: success type: str sample: httpd owner: description: Owner of the file, after execution. returned: success type: str sample: httpd uid: description: Owner id of the file, after execution. returned: success type: int sample: 100 mode: description: Permissions of the target, after execution. returned: success type: str sample: '0644' size: description: Size of the target, after execution. returned: success type: int sample: 1220 state: description: State of the target, after execution. returned: success type: str sample: file N)to_bytes to_native) AnsibleModuleceZdZdZy)AnsibleModuleErrorc||_y)Nresults)selfr s D/home/dcms/DCMS/lib/python3.12/site-packages/ansible/modules/copy.py__init__zAnsibleModuleError.__init__0s  N)__name__ __module__ __qualname__rrr rr/srrc*tjj|\}}t|d}|dk(rd|gfStjj |s"|dk(rt ddit |\}}n||gfS|j|||fS) zi Return the first pre-existing directory and a list of the new directories that will be created. surrogate_or_stricterrors./msgz0The '/' directory doesn't exist on this machine.r )ospathsplitrexistsrsplit_pre_existing_dirappend)dirnameheadtailb_headpre_existing_dirnew_directory_lists r r r 4sw'JD$ d#8 9F rzdV} 77>>& ! 3;$e5g-hi i1G1M. -tf~d# 0 11rc|rUtjj||jd}||d<|j ||}t |||||}|S)z] Walk the new directories list and make sure that permissions are as we would expect rr)rrjoinpopset_fs_attributes_if_different&adjust_recursive_directory_permissions)r&r'moduledirectory_argschanged working_dirs r r,r,Fs_ ggll#35G5K5KA5NO !,v77P8FXZ`bpryz Nrcd}|jd}|jd}||jstj|D]\}}}|j ||d}|dur|}|D cgc]"} tj j || $c} D]} |j | |d}|dus|}|D cgc]"} tj j || $c} D]} |j | |d}|dus|}ntj|j} tj|D]\}}}tj|j| k7}|dur|}|D cgc]"} tj j || $c} D]+} tj| j| k7}|dus*|}-|D cgc]"} tj j || $c} D]+} tj| j| k7}|dus*|}-||jstj|D]\}}}|j||d}|dur|}|D cgc]"} tj j || $c} D]} |j| |d}|dus|}|D cgc]"} tj j || $c} D]} |j| |d}|dus|}|Stj|j}tj|D]\}}}tj|j |k7}|dur|}|D cgc]"} tj j || $c} D]+} tj| j |k7}|dus*|}-|D cgc]"} tj j || $c} D]+} tj| j |k7}|dus*|}-|Scc} wcc} wcc} wcc} wcc} wcc} wcc} wcc} w)NFownergroupT)params check_moderwalkset_owner_if_differentrr)pwdgetpwnampw_uidstatst_uidset_group_if_differentgrpgetgrnamgr_gidst_gid)rr-r/r2r3dirpathdirnames filenames owner_changedddirffileuid group_changedgids r chown_recursiverMSs$G MM' "E MM' "E   02 0,9 & = =gue T  D(+G>FGBGGLL!4G0C$*$A$A#ue$TM$,"/0@II!RWW\\'15I0D$*$A$A$u$UM$,"/0 0,,u%,,C02 0,9!#!1!8!8C!?  D(+G>FGBGGLL!4G0C%'WWS\%8%8C%?M$,"/0@II!RWW\\'15I0D%'WWT]%9%9S%@M$,"/0 0   02 0,9 & = =gue T  D(+G>FGBGGLL!4G0C$*$A$A#ue$TM$,"/0@II!RWW\\'15I0D$*$A$A$u$UM$,"/0 06 N,,u%,,C02 0,9!#!1!8!8C!?  D(+G>FGBGGLL!4G0C%'WWS\%8%8C%?M$,"/0@II!RWW\\'15I0D%'WWT]%9%9S%@M$,"/0 0 NgHJHJHJHJs0)'P!6'P&*'P+'P0('P55'P:)'P?'Qcd}|jd}|jd}|jd}tj||j}t |rd}|j s |D]}t jj||} t jj||} t| d} t| d} t jj| r0|dur,t j| } t j| | n,tj| | tj| | ||j!| |d||j#| |dd}|S)zKCopy files that are different between `src` directory and `dest` directory.Fr2r3 local_followTrr)r4filecmpdircmp diff_fileslenr5rrr)rislinkreadlinksymlinkshutilcopyfilecopymoder7r=)srcdestr-r/r2r3rOrRitem src_item_pathdest_item_pathb_src_item_pathb_dest_item_pathlinktos r copy_diff_filesrbs@G MM' "E MM' "E==0LT*55J :    DGGLLd3MWW\\$5N&}=RSO'?TU ww~~o.<53H_5 6#341AB1AB --.>uM --.>uMG! " Nrcd}|jd}|jd}|jd}tj||j}t |rd}|j s|D]}t jj||} t jj||} t| d} t| d} t jj| rHt jj| r)|dur%tj| | | t| |t jj| rNt jj| r/|dur+t j| } t j | | t jj| rct jj#| rD|dur@tj$| | ||j'| |d||j)| |dt jj| rNt jj#| r/|dur+t j| } t j | | t jj| sut jj#| rVtj$| | tj*| | ||j'| |d||j)| |dt jj| sDt jj| r%tj| | | t| |d}|S) zFCopy files that exist in `src` directory only to the `dest` directory.Fr2r3rOTrrsymlinks)r4rPrQ left_onlyrSr5rrr)rrTisdirrWcopytreerMrUrVisfilerXr7r=rY)rZr[r-r/r2r3rOrfr\r]r^r_r`ras r copy_left_onlyrjsG MM' "E MM' "E==0LsD)33I 9~   & DGGLLd3MWW\\$5N&}=RSO'?TU ww~~o.277==3QVbfjVj1AP\L\] 0&9ww~~o.277==3QVbfkVk_5 6#34ww~~o.277>>/3RWcgkWk1AB$112BE5Q$112BE5Qww~~o.277>>/3RWcglWl_5 6#3477>>/2rww~~o7V1AB1AB$112BE5Q$112BE5Q77>>/2rww}}_7U1AP\L\] 0&9GM& N Nrcd}tj||j}|D]}tjj ||}tjj ||}t |d}t |d} t|| |} t|| |} | s| rd}ttjj ||tjj |||xs|}|S)NFrrT) rPrQ common_dirsrrr)rrbrjcopy_common_dirs) rZr[r-r/rlr\r]r^r_r`diff_files_changedleft_only_changeds r rmrmsG..d+77K i S$/ dD1"=9NO#N;PQ,_>NPVW*?|rd}|j@stij||| ?t||d}|j3tj j stj j1|jdrhttj jK|d}&ttj j5||&d}ttj j5|jd d>d}|j@sFtj j|s'tij||| ?d}t|||j@r!tj j|sd}tj j|r=ty|||}"t{|||}#t}|||}$t||}%|"s|#s|$s|%rd}|j3tj j sitj j|jdsd}ty|||}"t{|||}#t}|||}$t||}%|j@r!tj j|sd}t|||||@}'|r||'dA<|jG|j|B}(|j|(|'dC|'dC<|jBdDi|'y#t$t&f$r(}|j)d"t+|zYd}~ d}~wwxYw#t.$rY wxYw#t:$rM}|j<d&xxd'j|z cc<|jdDi|j>Yd}~ 3d}~wwxYw#t$$rX}d-t+|jQvr2|jd.tj j7|zYd}~ ad}~wwxYw#t$$rX}|jntnjpk(r/| d k(r*|j)d9jt+|nYd}~Jd}~wwxYw#t&t$f$r/|jd;|d<|tujv=YlwxYw)ENr)typestrT)rqno_log)rqrequiredboolF)rqdefaultraw) rZ_original_basenamecontentr[backupforcevalidatedirectory_mode remote_srcrOchecksumfollow) argument_specadd_file_common_argssupports_check_moderZrrr[z.{0}{1}rzr{rxr|rrOmoder2r3r~rzSource %s not found)rzSource %s not readablepreservez0%03oz5Unable to calculate src checksum, assuming change: %sz+Cannot copy invalid source '%s': not a filezBCopied file does not match the expected checksum. Transfer failed.)rrexpected_checksumrz Could not copy to {0}z"dest directory %s would be created)rr/rZr}zfile already exists)rrZr[r/zpermission deniedz*Destination directory %s is not accessiblez'Destination directory %s does not exist unsafe_writeszDestination %s not writablewz%szvalidate must contain %%s: %srzfailed to validate)r exit_statusstdoutstderr)rGzUnable to copy stats {0})rkeep_dest_attrszfailed to copy: z to )r tracebackrrd)r[rZmd5sumrr/ backup_file)rr/r)Brdictr4rrrsepformatgetr fail_jsonaccessR_OKr;S_IMODEst_moderisha1OSErrorIOErrorwarnrmd5 ValueErrorrgendswithr)r"r rresultr r5 exit_jsonmakedirsload_file_common_argumentsr,basenamerTrealpathlowerW_OK backup_localunlinkopencloseset_mode_if_differentr7r= run_commandtempfilemkstemprWrXcopystaterrnoENOSYS atomic_mover format_excrbrjrmrMrhr+))r-rZb_srcr[b_destrzr{rxr|rrOrr2r3r~rr/ checksum_dest checksum_src md5sum_srcer" b_dirnamer&r'r.r}rrrcouterrb_mysrcdummyrnrocommon_dirs_changedowner_group_changed b_basenameres_args file_argss) r mainrs &!#/eD16D1VU3FD1u%U+(6*u%VU3  " #F( -- C S!6 7E == D ww{{$ T2 d#8 9F ]]8 $F MM' "E**+?F}}  T2H ]]8 $F==0L == D MM' "E MM' "E|,J}}Z(H 77>>% 2c:; 99UBGG $5=>}}V * '$,,rwwu~7M7M*N N f == DGMLJ ww~~c `!;;s+L CJ BGGMM#.FSVWXLH,T!&   }}RVV 77<<&89D$'<=''//$'W-BC ww~~i( .9OPW9X6!#5     %IG%S]agj k KK "G#>>v}}MN#]]+;>& !fWW%%f-FV,ABD   !6CdTY  Z 99VRWW %"''..*@"KK-Mww~~bggoof56 q /0   !Jbggoo^bNc!d  e 99RWW__V,bgg 6v}}_?]:bggood>STUK}$v(>  ) qww~~f-&,&9&9$&? 77>>&)IIf%%++-'44S$F(55c5%H(55c5%H8+((-LPX-Y(Z%+%7%73%GNRcQw((-ArZ]fi(j"''.."7%-%5%5"''//&:Q%RNE7OOE73"w7""7D o@^t~p~" 5 "''-- e(<=V]]51:OPEfmmF3QUh"G||BGGKK( f@U1V%bgg&6&6s&;DYZ !"'',,vz"BK`a fmmE.BB!GPef((OOE6 >&))8)O&(6uff(M%*:5&&*Q'*9&&*I')->BUYl"&<< ,RWW^^FMMRXDY5Z%bgg&6&6v}}U7K&LUjk !"'',,vz"BK`a((1GKK'"G$RWW\\&--2F%KTijE)8)O&(6uff(M%*:5&&*Q'*9&&*I'$$RWW^^F-C"G s: gH"-11&--d1KI ?? 8T]K^_HYF x u! ` KKOR[\]R^^ _ _ `    ,& .#;#B#B4#HH   -199-- .N q&)A,*<*<*>>$$)UY[Y`Y`YhYhimYn)o$p qV#"99 49K"KK(B(I(I)TYJZ([\!]"W% q  3%MYbYmYmYo p qsz({.{2|7E;?~-#?{ #{{  {{ |4'A|//|47 ~A ~~ <$A 71?7<<??:A@=@<A@=__main__) __future__r DOCUMENTATIONEXAMPLESRETURNrrPr>ros.pathr8rWr;rr+ansible.module_utils.common.text.convertersrransible.module_utils.basicr Exceptionrr r,rMrbrjrmrrrrr rs#T l? B= ~   K4 2$ >B>2j$w!t zFr