zfs-replicate

https://github.com/alunduil/zfs-replicate

Description

zfs-replicate sends all Zettabyte File System (ZFS) snapshots to a remote host by SSH. zfs-replicate does not create ZFS snapshots.

zfs-replicate forks autorepl.py used by FreeNAS.

zfs-replicate relates to several other projects, which fit other niches:

sanoid: A full snapshot management system. Its companion, syncoid, handles replication with copious options.
zfs-replicate (BASH): A similar project. The major differences include configuration style and system expectations (for example, logging controls). zfs-replicate uses parameters whereas zfs-replicate (BASH) uses a BASH script.
znapzend: Another scheduling and replicating system.
zrep: A SH script with several control commands for snapshot replication.

Terms of use

You are free to copy, change, and distribute zfs-replicate with attribution under the terms of the BSD-2-Clause licence. See the LICENSE for details.

Prerequisites

A remote system with a ZFS filesystem and the zfs command-line tools
If using lz4 compression, local and remote systems must have lz4 in their environments
SSH access to that remote system
If you're not using the root user remotely:
1. Ensure the user can mount filesystems
  1. FreeBSD: sysctl -w vfs.usermount=1
2. Add ZFS permissions
  1. Command: zfs allow ${USER} ${PERMISSIONS} ${BACKUP_DATASET}
  2. Permissions
    1. clone
    2. create
    3. destroy
    4. hold
    5. mount
    6. promote
    7. quota
    8. readonly
    9. receive
    10. rename
    11. reservation
    12. rollback
    13. send
    14. snapshot
A local ZFS filesystem and zfs command-line tools

N.B., don't use the root user to access your remote system.

How to use zfs-replicate

poetry install
poetry run -- zfs-replicate --help

Documentation

zfs-replicate --help: Help for zfs-replicate.
LICENSE: Licence file explaining usage of zfs-replicate.
Survey of ZFS Replication Tools: Overview of various ZFS replication tools and their uses.
Working With Oracle Solaris ZFS Snapshots and Clones: Oracle's guide to working with ZFS snapshots.

ZFS REMOTE REPLICATION SCRIPT WITH REPORTING

ZFS replication without using Root user: How to configure ZFS replication for a non-root user.

Getting support

GitHub issues: Report any problems or features requests to GitHub issues.

Release files for zfs-replicate 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zfs-replicate 4.1.0
File	Size	Uploaded
zfs_replicate-4.1.0.tar.gz	15.9 kB	May 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for zfs-replicate 4.1.0
File	Interpreter	ABI	Platform	Reset
zfs_replicate-4.1.0-py3-none-any.whl 20.3 kB May 9, 2026	Python 3	none	any	Details

Total release size: 36.2 kB

Release files / zfs_replicate-4.1.0.tar.gz

Download URL	zfs_replicate-4.1.0.tar.gz
Size	15.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`0535c946ddb87dd7461f0ef765108b8c3f107e842dfa7844227a07271b3d5186`
BLAKE2b-256 checksum How to use checksums	`c362f1da847087a7fbf2228d16308dd48e898464c2bddee553e4049361485e41`
Upload date	May 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.0 CPython/3.12.3 Linux/6.17.0-1010-azure`

Release files / zfs_replicate-4.1.0-py3-none-any.whl

Download URL	zfs_replicate-4.1.0-py3-none-any.whl
Size	20.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8c155e1e704f50d784989c84fbe7ea7d41f0b02bd2709741fc6791dbf17da927`
BLAKE2b-256 checksum How to use checksums	`bd36d2ff73f6cda3c1f0d84cdb688e0063d1f234a71392671caefa43a2d511e2`
Upload date	May 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.0 CPython/3.12.3 Linux/6.17.0-1010-azure`