2 .\" Title: amzfs-sendrecv
3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 2.6.1p2
10 .TH "AMZFS\-SENDRECV" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amzfs-sendrecv \- Amanda script to create zfs sendrecv
27 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 \'zfs send\'\&. 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 \'NO\'\&. Only the restoration of the complete backup is allowed, it is impossible to restore a single file\&.
29 The application is run as the amanda user, it must have many zfs priviledge:
32 zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
35 Some system doesn\'t have "zfs allow", but you can give the Amanda backup user the rights to manipulate ZFS filesystems by using the following command:
38 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
40 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
42 The format of the DLE must be one of:
46 \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-
48 ZFS pool name datapool
49 ZFS filesystem datapool/database
50 ZFS logical volume datapool/dbvol
53 The filesystem doesn\'t need to be mounted\&.
56 This section lists the properties that control amzfs\-sendrecv\'s functionality\&. See
57 \fBamanda-applications\fR(7)
58 for information on the Application API, application configuration\&.
63 Path to the \'df\' binary, search in $PATH by default\&.
69 If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail\&.
75 Path to the \'zfs\' binary, search in $PATH by default\&.
81 Path to the \'pfexec\' binary, search in $PATH by default\&.
87 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
92 In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
94 define application\-tool amzfs_sendrecv {
95 comment "amzfs\-sendrecv"
96 plugin "amzfs\-sendrecv"
97 #property "DF\-PATH" "/usr/sbin/df"
98 #property "KEEP\-SNAPSHOT" "YES"
99 #property "ZFS\-PATH" "/usr/sbin/zfs"
100 #property "PFEXEC\-PATH" "/usr/sbin/pfexec"
101 #property "PFEXEC" "NO"
104 define dumptype user\-zfs\-sendrecv {
105 program "APPLICATAION"
106 application "amzfs_sendrecv"
112 \fBamanda.conf\fR(5),
113 \fBamanda-client.conf\fR(5),
114 \fBamanda-applications\fR(7)
117 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
119 Zmanda, Inc\&. (http://www\&.zmanda\&.com)