2 .\" Title: amzfs-sendrecv
3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.1
10 .TH "AMZFS\-SENDRECV" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amzfs-sendrecv \- Amanda script to create zfs sendrecv
34 amzfs\-sendrecv is an Amanda application implementing the Application API\&. It should not be run by users directly\&. It create a zfs snapshot of the filesystem and backup the snapshot with \*(Aqzfs send\*(Aq\&. Snapshot are kept after the backup is done, this increase the disk space use on the client but it is neccesary to be able do to incremental backup\&. If you want only full backup, you can disable this feature by setting the KEEP\-SNAPSHOT property to \*(AqNO\*(Aq\&. Only the restoration of the complete backup is allowed, it is impossible to restore a single file\&.
36 The application is run as the amanda user, it must have many zfs priviledge:
39 zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
42 Some system doesn\*(Aqt have "zfs allow", but you can give the Amanda backup user the rights to manipulate ZFS filesystems by using the following command:
45 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
47 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
51 in the disklist (DLE) must be one of:
55 \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-
57 ZFS pool name datapool
58 ZFS filesystem datapool/database
59 ZFS logical volume datapool/dbvol
62 The filesystem doesn\*(Aqt need to be mounted\&.
65 This section lists the properties that control amzfs\-sendrecv\*(Aqs functionality\&. See
66 \fBamanda-applications\fR(7)
67 for information on the Application API, application configuration\&.
72 Path to the \*(Aqdf\*(Aq binary, search in $PATH by default\&.
78 If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail\&.
84 Path to the \*(Aqzfs\*(Aq binary, search in $PATH by default\&.
90 Path to the \*(Aqpfexec\*(Aq binary, search in $PATH by default\&.
96 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
101 In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
103 define application\-tool amzfs_sendrecv {
104 comment "amzfs\-sendrecv"
105 plugin "amzfs\-sendrecv"
106 #property "DF\-PATH" "/usr/sbin/df"
107 #property "KEEP\-SNAPSHOT" "YES"
108 #property "ZFS\-PATH" "/usr/sbin/zfs"
109 #property "PFEXEC\-PATH" "/usr/sbin/pfexec"
110 #property "PFEXEC" "NO"
113 define dumptype user\-zfs\-sendrecv {
114 program "APPLICATAION"
115 application "amzfs_sendrecv"
121 \fBamanda.conf\fR(5),
122 \fBamanda-client.conf\fR(5),
123 \fBamanda-applications\fR(7)
126 : http://wiki.zmanda.com/
129 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
131 Zmanda, Inc\&. (http://www\&.zmanda\&.com)