Tweaked comment in last commit
[zfs-ubuntu/.git] / 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
20 # specify the name of the lockdir used when performing ZFS admin operations
21 lockdir="/tmp/zfs-admin-lock"
22
23 # specify the user to send email reports to
24 mailto="user@domain"
25
26 # specifu the ssh command and any options needed for accessing a remote server
27 ssh="ssh"
28
29 # specify the fqdn of the remote server to pull snapshots from to backup locally
30 # specify "localhost" if the remote server is the local machine
31 remote=
32
33 # specify the name of the local pool to store the $remote's snapshots into
34 backup_pool=
35
36 # import backup pool before replication and export backup pool after replication
37 import_export_backup_pool=0
38
39 # when this variable is set, local filesystems will be destroyed
40 # before receiving a full streams into them from the remote source.
41 # if it needs to do this, and this option is set to 0, it aborts.
42 destroy_local_filesystem_on_full_replicate=0
43
44 # set this to 1 if you want the snapshot script to run in "test" mode (not really take any snaps)
45 # leave blank if not under test
46 SNAP_UNDER_TEST=
47
48 # Specify the maximum run time in minutes that the replicate script can run for (0=no limit)
49 maxruntime=0
50
51 # Setup throttling related parameters that will rate limit the zfs send | zfs receive pipe
52 # The maximum limit a local backup can handle to avoid excessive CPU load is 10MB/s
53 throttle_enable=0
54 throttle_opt="-v -M 10"
55
56 # Specify the list of filesystems to replicate from the $remote to the $backup_pool (1 per line)
57 # The format of each line should be: pool/filesystem
58 filesystems_to_replicate="
59 "
60