if [[ -e "$remote_list" ]]; then
rm -f $remote_list
fi
- if [[ -n "$remote" ]]; then
- ssh $remote ls -d "$lockdir" > /dev/null 2>&1
- if [[ $? == 0 ]]; then
- ssh $remote rm -rf "$lockdir"
- fi
+ $ssh $remote ls -d "$lockdir" > /dev/null 2>&1
+ if [[ $? == 0 ]]; then
+ $ssh $remote rm -rf "$lockdir"
fi
}
fatal_and_exit() {
echo -e 2>&1 "$1"
# Destroy the backup markers on the local filesystem if they exist
if [[ -n "$current_backup_marker" ]]; then
- zfs list -t snapshot ${local_pool}/${current_backup_marker} > /dev/null 2>&1
+ zfs list -t snapshot ${backup_pool}/${current_backup_marker} > /dev/null 2>&1
if [ $? == 0 ]; then
- $zfs destroy ${local_pool}/${current_backup_marker}
+ $zfs destroy ${backup_pool}/${current_backup_marker}
fi
fi
if [[ -n "$previous_backup_marker" ]]; then
- zfs list -t snapshot ${local_pool}/${previous_backup_marker} > /dev/null 2>&1
+ zfs list -t snapshot ${backup_pool}/${previous_backup_marker} > /dev/null 2>&1
if [ $? == 0 ]; then
- $zfs destroy ${local_pool}/${previous_backup_marker}
+ $zfs destroy ${backup_pool}/${previous_backup_marker}
fi
fi
# send email notification
fatal_and_exit "Usage: $0 <hostname> <zfs filesystem>"
fi
-# Make sure the local pool and local receiving filesystem exist, or print some errors
-zpool list -H "$local_pool" >/dev/null 2>&1
+# check for localhost
+if [[ $remote = "localhost" ]]; then
+ remote=""
+ ssh=""
+fi
+
+# Make sure the local backup pool and local receiving filesystem exist, or print some errors
+zpool list -H "$backup_pool" >/dev/null 2>&1
if [ $? != 0 ]; then
- fatal_and_exit "-E- The local pool, '$local_pool' doesn't seem to exist." $mailto
+ fatal_and_exit "-E- The local backup pool, '$backup_pool' doesn't seem to exist." $mailto
fi
-zfs list "$local_pool/$remote_pool" >/dev/null 2>&1
+zfs list "$backup_pool/$remote_pool" >/dev/null 2>&1
if [ $? != 0 ]; then
- echo >&2 "-I- The local filesystem for the remote pool, '$local_pool/$remote_pool' doesn't seem to exist."
- echo >&2 " Creating the local filesystem to receive the remote pool into: $local_pool/$remote_pool"
- $zfs create $local_pool/$remote_pool
+ echo >&2 "-I- The local filesystem for the remote pool, '$backup_pool/$remote_pool' doesn't seem to exist."
+ echo >&2 " Creating the local filesystem to receive the remote pool into: $backup_pool/$remote_pool"
+ $zfs create $backup_pool/$remote_pool
if [ $? != 0 ]; then
fatal_and_exit "-E- remote $zfs create command failed" $mailto
fi
fi
-# Obtain the zpool guid for the local pool
-local_pool_guid=`zpool get guid $local_pool 2>&1 | grep $local_pool | awk '{ print $3 }'`
-zpool get guid $local_pool > /dev/null 2>&1
+# Obtain the zpool guid for the local backup pool
+backup_pool_guid=`zpool get guid $backup_pool 2>&1 | grep $backup_pool | awk '{ print $3 }'`
+zpool get guid $backup_pool > /dev/null 2>&1
if [ $? != 0 ]; then
- fatal_and_exit "-E- Unable to extract the guid for the local pool: $local_pool" $mailto
+ fatal_and_exit "-E- Unable to extract the guid for the local backup pool: $backup_pool" $mailto
fi
# Turn on shell verbosity
maxattempts=500
attempts=0
while true; do
- ssh $remote mkdir "$lockdir" >/dev/null 2>&1
+ $ssh $remote mkdir "$lockdir" >/dev/null 2>&1
if [ $? != 0 ]; then
# Another zfs admin tool is running.
# Wait a random amount of time and try again
if [[ $attempts -gt $maxattempts ]]; then
# We've exceeded our maximum while loop count
echo "-E- The zfs filesystem has been locked down. Skipping replicate operation."
- fail_msg=`ssh $remote ls -ld $lockdir 2>&1`
+ fail_msg=`$ssh $remote ls -ld $lockdir 2>&1`
fatal_and_exit "zfs-replicate-all unable to obtain zfs admin lock:\n$fail_msg" $mailto
fi
done
# Setup our backup marker names
-current_backup_marker=${remote_fs}@current-backup-${local_pool_guid}
-previous_backup_marker=${remote_fs}@previous-backup-${local_pool_guid}
+current_backup_marker=${remote_fs}@current-backup-${backup_pool_guid}
+previous_backup_marker=${remote_fs}@previous-backup-${backup_pool_guid}
# List the snapshots on the remote machine.
remote_list=$(mktemp /tmp/replicate.XXXXXX)
-ssh $remote \
+$ssh $remote \
$zfs list -H -t snapshot |
grep ^${remote_fs}@ |
awk '{print$1}' > $remote_list
# If you do, it can mess up the common finding algorithm below.
local_list=$(mktemp /tmp/replicate.XXXXXX)
$zfs list -H -t snapshot |
- grep ^${local_pool}/${remote_fs}@ |
- grep -v ^${local_pool}/${current_backup_marker} |
- awk "{gsub(/^$local_pool./,\"\",\$1); print\$1}" > $local_list
+ grep ^${backup_pool}/${remote_fs}@ |
+ grep -v ^${backup_pool}/${current_backup_marker} |
+ awk "{gsub(/^$backup_pool./,\"\",\$1); print\$1}" > $local_list
if [ $? != 0 ]; then
fatal_and_exit "-E- local $zfs list command failed" $mailto
fi
# Destroy the current backup marker snapshot on the remote system if it exists
grep -q ${current_backup_marker} $remote_list
if [ $? == 0 ]; then
- ssh $remote $zfs destroy ${current_backup_marker}
+ $ssh $remote $zfs destroy ${current_backup_marker}
if [ $? != 0 ]; then
fatal_and_exit "-E- remote $zfs destroy command failed" $mailto
fi
fi
# Create the current backup marker snapshot on the remote system
-ssh $remote $zfs snapshot ${current_backup_marker}
+$ssh $remote $zfs snapshot ${current_backup_marker}
if [ $? != 0 ]; then
fatal_and_exit "-E- remote $zfs snapshot command failed" $mailto
fi
if [ $no_markers == 0 ]; then
# We found backup markers, incrementally send the new snaps
- # First, rollback the local pool to the previous backup marker in case the previous
+ # First, rollback the local backup pool to the previous backup marker in case the previous
# backup was interrupted for some reason. If we don't do this, the zfs send -R command
# below may complain about snaps already existing as it tries to resend from the
# previous backup marker again from a previously interrupted replicate.
- $zfs rollback -r ${local_pool}/${previous_backup_marker}
+ $zfs rollback -r ${backup_pool}/${previous_backup_marker}
if [ $? != 0 ]; then
fatal_and_exit "-E- remote incremental $zfs rollback command failed" $mailto
fi
# Now it should be safe to send the snaps
if [[ $throttle_enable == 1 && -e $throttle ]]; then
- ssh $remote $zfs send -R -I${previous_backup_marker} ${current_backup_marker} |
- $throttle $throttle_opt | $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R -I${previous_backup_marker} ${current_backup_marker} |
+ $throttle $throttle_opt | $zfs receive -vF -d ${backup_pool}/${remote_pool}
else
- ssh $remote $zfs send -R -I${previous_backup_marker} ${current_backup_marker} |
- $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R -I${previous_backup_marker} ${current_backup_marker} |
+ $zfs receive -vF -d ${backup_pool}/${remote_pool}
fi
if [ $? != 0 ]; then
fatal_and_exit "-E- remote incremental $zfs send command failed" $mailto
if [[ -n "$common" ]]; then
# We found a common snapshot, incrementally send the new snaps
if [[ $throttle_enable == 1 && -e $throttle ]]; then
- ssh $remote $zfs send -R -I${common/*@/@} ${current_backup_marker} |
- $throttle $throttle_opt | $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R -I${common/*@/@} ${current_backup_marker} |
+ $throttle $throttle_opt | $zfs receive -vF -d ${backup_pool}/${remote_pool}
else
- ssh $remote $zfs send -R -I${common/*@/@} ${current_backup_marker} |
- $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R -I${common/*@/@} ${current_backup_marker} |
+ $zfs receive -vF -d ${backup_pool}/${remote_pool}
fi
if [ $? != 0 ]; then
fatal_and_exit "-E- remote incremental $zfs send command failed" $mailto
# We did not find any markers or a common snapshot
# At this point, we'll have to send the entire filesystem
# Destroy the local filesystem if it exists before receving the full replicate
- zfs list ${local_pool}/${remote_fs} > /dev/null 2>&1
+ zfs list ${backup_pool}/${remote_fs} > /dev/null 2>&1
if [ $? == 0 ]; then
if [[ $destroy_local_filesystem_on_full_replicate == 1 ]]; then
- $zfs destroy -r ${local_pool}/${remote_fs}
+ $zfs destroy -r ${backup_pool}/${remote_fs}
if [ $? != 0 ]; then
fatal_and_exit "-E- remote full $zfs destroy command failed" $mailto
fi
else
echo "-W- We need to destroy a local filesystem before receiving a full stream."
echo " However, since the option is set to prevent this, skipping replicate operation."
- fatal_and_exit "unable to destroy local filesystem:\n$zfs destroy -r ${local_pool}/${remote_fs} not able to run" $mailto
+ fatal_and_exit "unable to destroy local filesystem:\n$zfs destroy -r ${backup_pool}/${remote_fs} not able to run" $mailto
fi
fi
# Send the full filesystem
if [[ $throttle_enable == 1 && -e $throttle ]]; then
- ssh $remote $zfs send -R ${current_backup_marker} |
- $throttle $throttle_opt | $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R ${current_backup_marker} |
+ $throttle $throttle_opt | $zfs receive -vF -d ${backup_pool}/${remote_pool}
else
- ssh $remote $zfs send -R ${current_backup_marker} |
- $zfs receive -vF -d ${local_pool}/${remote_pool}
+ $ssh $remote $zfs send -R ${current_backup_marker} |
+ $zfs receive -vF -d ${backup_pool}/${remote_pool}
fi
if [ $? != 0 ]; then
fatal_and_exit "-E- remote full $zfs send command failed" $mailto
# destroy the previous backup markers now that we've replicated past them
# don't check the return codes here because these may not exist, and that is ok
-$zfs destroy ${local_pool}/${previous_backup_marker} > /dev/null 2>&1
-ssh $remote $zfs destroy ${previous_backup_marker} > /dev/null 2>&1
+$zfs destroy ${backup_pool}/${previous_backup_marker} > /dev/null 2>&1
+$ssh $remote $zfs destroy ${previous_backup_marker} > /dev/null 2>&1
# Rename the current backup marker to be the previous backup marker
-$zfs rename ${local_pool}/${current_backup_marker} ${local_pool}/${previous_backup_marker}
+$zfs rename ${backup_pool}/${current_backup_marker} ${backup_pool}/${previous_backup_marker}
if [ $? != 0 ]; then
fatal_and_exit "-E- local $zfs rename command failed" $mailto
fi
-ssh $remote $zfs rename ${current_backup_marker} ${previous_backup_marker}
+$ssh $remote $zfs rename ${current_backup_marker} ${previous_backup_marker}
if [ $? != 0 ]; then
fatal_and_exit "-E- remote $zfs rename command failed" $mailto
fi
-
# This function obtains the date a given snapshot was created in epoch seconds
snapshot_age() {
- snapshot=${local_pool}/${1}${previous_backup_marker}
+ snapshot=${backup_pool}/${1}${previous_backup_marker}
$zfs list -t snapshot ${snapshot} > /dev/null 2>&1
if [ $? == 0 ]; then
$zfs get creation ${snapshot} > /dev/null 2>&1
fi
}
-# Obtain the zpool guid for the local pool
-local_pool_guid=`zpool get guid $local_pool 2>&1 | grep $local_pool | awk '{ print $3 }'`
-zpool get guid $local_pool > /dev/null 2>&1
+# Mount the local backup pool if needed and the option is given to do so, else error out
+zpool list -H "$backup_pool" >/dev/null 2>&1
if [ $? != 0 ]; then
- echo >&2 "-E- Unable to extract the guid for the local pool: $local_pool"
+ if [[ $import_export_backup_pool == 1 ]]; then
+ zpool import $backup_pool
+ if [ $? != 0 ]; then
+ echo "-E- unable to import the backup pool $backup_pool"
+ exit 1
+ fi
+ else
+ echo "-E- The local backup pool, '$backup_pool' doesn't seem to exist." $mailto
+ exit 1
+ fi
+fi
+
+# Obtain the zpool guid for the local backup pool
+backup_pool_guid=`zpool get guid $backup_pool 2>&1 | grep $backup_pool | awk '{ print $3 }'`
+zpool get guid $backup_pool > /dev/null 2>&1
+if [ $? != 0 ]; then
+ echo >&2 "-E- Unable to extract the guid for the local backup pool: $backup_pool"
exit 1
fi
# Setup our backup marker names
-current_backup_marker=@current-backup-${local_pool_guid}
-previous_backup_marker=@previous-backup-${local_pool_guid}
+current_backup_marker=@current-backup-${backup_pool_guid}
+previous_backup_marker=@previous-backup-${backup_pool_guid}
# Auto snapshot every zfs filesystem on the system specified below
echo "$date ZFS replicate started" >> $logfile
# Replicate the sorted filesystems
for filesystem in $sorted_filesystems; do
- echo "-> Replicating $remote:$filesystem to ${local_pool}/${filesystem}" | tee -a $mylogfile
+ echo "-> Replicating $remote:$filesystem to ${backup_pool}/${filesystem}" | tee -a $mylogfile
replicate $remote $filesystem
done
+# Export the local pool if told to do so
+if [[ $import_export_backup_pool == 1 ]]; then
+ zpool export $backup_pool
+ if [ $? != 0 ]; then
+ fatal_and_exit "-E- unable to export the local backup pool $backup_pool"
+ fi
+fi
+
# All done
echo `date` ZFS replicate complete >> $logfile
echo `date` ZFS replicate complete | tee -a $mylogfile
###########################################################################
-# This is a shell config script included by the other ZFS scripts.
-# You must copy this file and modify these values to match your system.
-# Save the resulting file as "zfs-scripts.conf" in this directory.
-# This will prevent your settings from being overwritten by future updates.
+# local configuration file for ZFS scripts
###########################################################################
# setup your path here to find all the binaries the ZFS scripts call
PATH=/usr/sbin:/sbin:/etc/bin:.:$PATH
# specify the path to the zfs binary
-zfs=/usr/sbin/zfs
+zfs=/sbin/zfs
# specify the path to your command line mailer
mailx=/usr/bin/mailx
lockdir="/tmp/zfs-admin-lock"
# specify the user to send email reports to
-mailto=
+mailto="user@domain"
-# specify the name of the remote server to pull snapshots from to backup locally
+# specifu the ssh command and any options needed for accessing a remote server
+ssh="ssh"
+
+# specify the fqdn of the remote server to pull snapshots from to backup locally
+# specify "localhost" if the remote server is the local machine
remote=
-# specify the name of the local pool to store remotely pulled (backup) snapshots to
-local_pool=
+# specify the name of the local pool to store the $remote's snapshots into
+backup_pool=
+
+# import backup pool before replication and export backup pool after replication
+import_export_backup_pool=0
# when this variable is set, local filesystems will be destroyed
# before receiving a full streams into them from the remote source.
+# if it needs to do this, and this option is set to 0, it aborts.
destroy_local_filesystem_on_full_replicate=0
# set this to 1 if you want the snapshot script to run in "test" mode (not really take any snaps)
+# leave blank if not under test
SNAP_UNDER_TEST=
# Specify the maximum run time in minutes that the replicate script can run for (0=no limit)
maxruntime=0
# Setup throttling related parameters that will rate limit the zfs send | zfs receive pipe
+# The maximum limit a local backup can handle to avoid excessive CPU load is 10MB/s
throttle_enable=0
-throttle_opt="-v -M 1"
-throttle=/usr/local/bin/throttle
+throttle_opt="-v -M 10"
-# Specify the list of filesystems to replicate from the remote to the local_pool (1 per line)
-# (enter 1 filesystem per line)
-filesystems_to_replicate='
-'
+# Specify the list of filesystems to replicate from the $remote to the $backup_pool (1 per line)
+# The format of each line should be: pool/filesystem
+filesystems_to_replicate="
+"