salt.states.rsync

State to synchronize files and directories with rsync.

/opt/user-backups:
  rsync.synchronized:
    - source: /home
    - force: True

salt.states.rsync.synchronized(name, source, delete=False, force=False, update=False, passwordfile=None, exclude=None, excludefrom=None, prepare=False, dryrun=False, additional_opts=None)

Guarantees that the source directory is always copied to the target.

name

Name of the target directory.

source

Source directory.

prepare

Create destination directory if it does not exists.

delete

Delete extraneous files from the destination dirs (True or False)

force

Force deletion of dirs even if not empty

update

Skip files that are newer on the receiver (True or False)

passwordfile

Read daemon-access password from the file (path)

exclude

Exclude files, that matches pattern.

excludefrom

Read exclude patterns from the file (path)

dryrun

Perform a trial run with no changes made. Is the same as doing test=True

New in version 2016.3.1.

additional_opts

Pass additional options to rsync, should be included as a list.

New in version 2018.3.0.