1AMZFS-SENDRECV(8) System Administration Commands AMZFS-SENDRECV(8)
2
3
4
6 amzfs-sendrecv - Amanda script to create zfs sendrecv
7
9 amzfs-sendrecv is an Amanda application implementing the Application
10 API. It should not be run by users directly. It create a zfs snapshot
11 of the filesystem and backup the snapshot with 'zfs send'. Snapshot are
12 kept after the backup is done, this increase the disk space use on the
13 client but it is neccesary to be able do to incremental backup. If you
14 want only full backup, you can disable this feature by setting the
15 KEEP-SNAPSHOT property to 'NO'. Only the restoration of the complete
16 backup is allowed, it is impossible to restore a single file.
17
18 The application is run as the amanda user, it must have many zfs
19 priviledge:
20
21 zfs allow -ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
22
23 Some system doesn't have "zfs allow", but you can give the Amanda
24 backup user the rights to manipulate ZFS filesystems by using the
25 following command:
26
27 usermod -P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
28 This will require that your run zfs under pfexec, set the PFEXEC
29 property to YES.
30
31 The format of the diskdevice in the disklist (DLE) must be one of:
32
33 Desciption Example
34 ---------- -------
35 Mountpoint /data
36 ZFS pool name datapool
37 ZFS filesystem datapool/database
38 ZFS logical volume datapool/dbvol
39
40 The filesystem doesn't need to be mounted.
41
43 This section lists the properties that control amzfs-sendrecv's
44 functionality. See amanda-applications(7) for information on the
45 Application API, application configuration.
46
47 DF-PATH
48
49 Path to the 'df' binary, search in $PATH by default.
50
51 KEEP-SNAPSHOT
52
53 If "YES" (the default), snapshot are kept after the backup, if set
54 to "NO" then snapshot are no kept and incremental backup will fail.
55
56 ZFS-PATH
57
58 Path to the 'zfs' binary, search in $PATH by default.
59
60 PFEXEC-PATH
61
62 Path to the 'pfexec' binary, search in $PATH by default.
63
64 PFEXEC
65
66 If "NO" (the default), pfexec is not used, if set to "YES" then
67 pfexec is used.
68
70 In this example, a dumptype is defined to use amzfs-sendrecv
71 application to backup a zfs filesystem.
72 define application-tool amzfs_sendrecv {
73 comment "amzfs-sendrecv"
74 plugin "amzfs-sendrecv"
75 #property "DF-PATH" "/usr/sbin/df"
76 #property "KEEP-SNAPSHOT" "YES"
77 #property "ZFS-PATH" "/usr/sbin/zfs"
78 #property "PFEXEC-PATH" "/usr/sbin/pfexec"
79 #property "PFEXEC" "NO"
80 }
81
82 define dumptype user-zfs-sendrecv {
83 program "APPLICATION"
84 application "amzfs_sendrecv"
85 }
86
88 amanda(8), amanda.conf(5), amanda-client.conf(5), amanda-
89 applications(7)
90
91 The Amanda Wiki: : http://wiki.zmanda.com/
92
94 Jean-Louis Martineau <martineau@zmanda.com>
95 Zmanda, Inc. (http://www.zmanda.com)
96
97
98
99Amanda 3.3.3 01/10/2013 AMZFS-SENDRECV(8)