Try SpotterA wrapper around rsync to make common tasks in your playbooks quick and easy.
| "added in version" 1.4 of ansible.builtin"
Authors: Timothy Appnel (@tima)
preview | supported by core
pipInstall with pip install ansible==2.7.10
C(synchronize) is a wrapper around rsync to make common tasks in your playbooks quick and easy. It is run and originates on the local host where Ansible is being run. Of course, you could just use the C(command) action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. C(synchronize) is not intended to provide access to the full power of rsync, but does make the most common invocations easier to implement. You `still` may need to call rsync directly via C(command) or C(shell) depending on your use case.
- name: Synchronization of src on the control machine to dest on the remote hosts
synchronize:
src: some/relative/path
dest: /some/absolute/path
- name: Synchronization using rsync protocol (push)
synchronize:
src: some/relative/path/
dest: rsync://somehost.com/path/
- name: Synchronization using rsync protocol (pull)
synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
- name: Synchronization using rsync protocol on delegate host (push)
synchronize:
src: /some/absolute/path/
dest: rsync://somehost.com/path/
delegate_to: delegate.host
- name: Synchronization using rsync protocol on delegate host (pull)
synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
delegate_to: delegate.host
- name: Synchronization without any --archive options enabled
synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
- name: Synchronization with --archive options enabled except for --recursive
synchronize:
src: some/relative/path
dest: /some/absolute/path
recursive: no
- name: Synchronization with --archive options enabled except for --times, with --checksum option enabled
synchronize:
src: some/relative/path
dest: /some/absolute/path
checksum: yes
times: no
- name: Synchronization without --archive options enabled except use --links
synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
links: yes
- name: Synchronization of two paths both on the control machine
synchronize:
src: some/relative/path
dest: /some/absolute/path
delegate_to: localhost
- name: Synchronization of src on the inventory host to the dest on the localhost in pull mode
synchronize:
mode: pull
src: some/relative/path
dest: /some/absolute/path
- name: Synchronization of src on delegate host to dest on the current inventory host.
synchronize:
src: /first/absolute/path
dest: /second/absolute/path
delegate_to: delegate.host
- name: Synchronize two directories on one remote host.
synchronize:
src: /first/absolute/path
dest: /second/absolute/path
delegate_to: "{{ inventory_hostname }}"
- name: Synchronize and delete files in dest on the remote host that are not found in src of localhost.
synchronize:
src: some/relative/path
dest: /some/absolute/path
delete: yes
recursive: yes
# This specific command is granted su privileges on the destination
- name: Synchronize using an alternate rsync command
synchronize:
src: some/relative/path
dest: /some/absolute/path
rsync_path: "su -c rsync"
# Example .rsync-filter file in the source directory
# - var # exclude any path whose last part is 'var'
# - /var # exclude any path starting with 'var' starting at the source directory
# + /var/conf # include /var/conf even though it was previously excluded
- name: Synchronize passing in extra rsync options
synchronize:
src: /tmp/helloworld
dest: /var/www/helloworld
rsync_opts:
- "--no-motd"
- "--exclude=.git"
# Hardlink files if they didn't change
- name: Use hardlinks when synchronizing filesystems
synchronize:
src: /tmp/path_a/foo.txt
dest: /tmp/path_b/foo.txt
link_dest: /tmp/path_a/
# Specify the rsync binary to use on remote host and on local host
- hosts: groupofhosts
vars:
ansible_rsync_path: "/usr/gnu/bin/rsync"
tasks:
- name: copy /tmp/localpath/ to remote location /tmp/remotepath
synchronize:
src: "/tmp/localpath/"
dest: "/tmp/remotepath"
rsync_path: "/usr/gnu/bin/rsync"
src:
description:
- Path on the source host that will be synchronized to the destination; The path can
be absolute or relative.
required: true
dest:
description:
- Path on the destination host that will be synchronized from the source; The path
can be absolute or relative.
required: true
dirs:
default: 'no'
description:
- Transfer directories without recursing
type: bool
mode:
choices:
- pull
- push
default: push
description:
- Specify the direction of the synchronization. In push mode the localhost or delegate
is the source; In pull mode the remote host in context is the source.
group:
default: the value of the archive option
description:
- Preserve group
type: bool
links:
default: the value of the archive option
description:
- Copy symlinks as symlinks.
type: bool
owner:
default: the value of the archive option
description:
- Preserve owner (super user only)
type: bool
perms:
default: the value of the archive option
description:
- Preserve permissions.
type: bool
times:
default: the value of the archive option
description:
- Preserve modification times
type: bool
delete:
default: 'no'
description:
- Delete files in C(dest) that don't exist (after transfer, not before) in the C(src)
path. This option requires C(recursive=yes).
type: bool
archive:
default: 'yes'
description:
- Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group
flags and -D.
type: bool
partial:
default: 'no'
description:
- Tells rsync to keep the partial file which should make a subsequent transfer of
the rest of the file much faster.
type: bool
version_added: '2.0'
version_added_collection: ansible.builtin
checksum:
default: 'no'
description:
- Skip based on checksum, rather than mod-time & size; Note that that "archive" option
is still enabled by default - the "checksum" option will not disable it.
type: bool
version_added: '1.6'
version_added_collection: ansible.builtin
compress:
default: 'yes'
description:
- Compress file data during the transfer. In most cases, leave this enabled unless
it causes problems.
type: bool
version_added: '1.7'
version_added_collection: ansible.builtin
dest_port:
default: Value of ansible_ssh_port for this host, remote_port config setting, or the
value from ssh client configuration if none of those are set
description:
- Port number for ssh on the destination host. Prior to ansible 2.0, the ansible_ssh_port
inventory var took precedence over this value.
version_added: '1.5'
version_added_collection: ansible.builtin
link_dest:
default: null
description:
- add a destination to hard link against during the rsync.
version_added: '2.5'
version_added_collection: ansible.builtin
recursive:
default: the value of the archive option
description:
- Recurse into directories.
type: bool
copy_links:
default: 'no'
description:
- Copy symlinks as the item that they point to (the referent) is copied, rather than
the symlink.
type: bool
rsync_opts:
default: null
description:
- Specify additional rsync options by passing in an array.
version_added: '1.6'
version_added_collection: ansible.builtin
rsync_path:
description:
- Specify the rsync command to run on the remote host. See C(--rsync-path) on the
rsync man page.
- To specify the rsync command to run on the local host, you need to set this your
task var C(ansible_rsync_path).
private_key:
description:
- Specify the private key to use for SSH-based rsync connections (e.g. C(~/.ssh/id_rsa))
version_added: '1.6'
version_added_collection: ansible.builtin
verify_host:
default: 'no'
description:
- Verify destination host key.
type: bool
version_added: '2.0'
version_added_collection: ansible.builtin
use_ssh_args:
default: 'no'
description:
- Use the ssh_args specified in ansible.cfg
type: bool
version_added: '2.0'
version_added_collection: ansible.builtin
existing_only:
default: 'no'
description:
- Skip creating new files on receiver.
type: bool
version_added: '1.5'
version_added_collection: ansible.builtin
rsync_timeout:
default: 0
description:
- Specify a C(--timeout) for the rsync command in seconds.
set_remote_user:
default: true
description:
- put user@ for the remote paths. If you have a custom ssh config to define the remote
user for a host that does not match the inventory user, you should set this parameter
to "no".