zfs-scripts.conf.dist

   1 ###########################################################################
   2 # local configuration file for ZFS scripts
   3 ###########################################################################
   4
   5 # setup your path here to find all the binaries the ZFS scripts call
   6 PATH=/usr/sbin:/sbin:/etc/bin:.:$PATH
   7
   8 # set our hostname
   9 hostname=`hostname`
  10
  11 # specify the path to the zfs binary
  12 zfs=/sbin/zfs
  13
  14 # specify the path to your command line mailer
  15 mailx=/usr/bin/mailx
  16
  17 # specify the path to the logdir the ZFS scripts should dump their logs to
  18 logdir="/var/log/zfs"
  19 [[ ! -d "$logdir" ]] && mkdir "$logdir"
  20
  21 # specify the name of the lockdir used when performing ZFS admin operations
  22 lockdir="/tmp/zfs-admin-lock"
  23
  24 # specify the user to send email reports to
  25 mailto="user@domain"
  26
  27 # specifu the ssh command and any options needed for accessing a remote server
  28 ssh="ssh"
  29
  30 # specify the fqdn of the remote server to pull snapshots from to backup locally
  31 # specify "localhost" if the remote server is the local machine
  32 remote=
  33
  34 # specify the name of the local pool to store the $remote's snapshots into
  35 # multiple pools can be specified by separating with a space
  36 backup_pool=
  37
  38 # import backup pool before replication and export backup pool after replication
  39 import_export_backup_pool=0
  40
  41 # expect empty remote list
  42 # - set to 1 if backing up any new filesystems for the first time
  43 # - set to 0 if not backing up new filesystems for the first time (to prevent dropping the entire filesystem if the remote list command fails)
  44 expect_empty_remote_list=0
  45
  46 # when this variable is set, local filesystems will be destroyed
  47 # before receiving a full streams into them from the remote source.
  48 # if it needs to do this, and this option is set to 0, it aborts.
  49 destroy_local_filesystem_on_full_replicate=0
  50
  51 # set this to 1 if you want the snapshot script to run in "test" mode (not really take any snaps)
  52 # leave blank if not under test
  53 SNAP_UNDER_TEST=
  54
  55 # Specify the maximum run time in minutes that the replicate script can run for (0=no limit)
  56 maxruntime=0
  57
  58 # Setup throttling related parameters that will rate limit the zfs send | zfs receive pipe
  59 # The maximum limit a local backup can handle to avoid excessive CPU load is 10MB/s
  60 throttle_enable=0
  61 throttle_opt="-v -M 10"
  62
  63 # Specify the list of filesystems to replicate from the $remote to the $backup_pool (1 per line)
  64 # The format of each line should be: pool/filesystem OR dst_pool:src_pool/filesystem
  65 # NOTE: If dst_pool is not specified, the given pool/filesystem will be replicated to all pools in backup_pool
  66 filesystems_to_replicate="
  67 "
  68