The M(copy) module copies a file on the local box to remote locations. Use the M(fetch) module to copy files from remote locations to the local box. If you need variable interpolation in copied files, use the M(template) module.

Options

namedescriptionrequiredchoices
src 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.
content When used instead of '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.
dest Remote absolute path where the file should be copied to. If src is a directory, this must be a directory too. true
backup Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
  • yes
  • no
force the default is C(yes), which will replace the remote file when contents are different than the source. If C(no), the file will only be transferred if the destination does not exist.
  • yes
  • no
directory_mode When doing a recursive copy set the mode for the directories. If this is not set we will use the system defaults. The mode is only set on directories which are newly created, and will not affect those that already existed.
remote_src If False, it will search for src at originating/master machine, if True it will go to the remote/target machine for the src. Default is False.
  • True
  • False

Author

Ansible Core Team ,Michael DeHaan