'\" t
.\"     Title: amzfs-sendrecv
.\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 12/01/2017
.\"    Manual: System Administration Commands
.\"    Source: Amanda 3.5.1
.\"  Language: English
.\"
.TH "AMZFS\-SENDRECV" "8" "12/01/2017" "Amanda 3\&.5\&.1" "System Administration Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
amzfs-sendrecv \- Amanda script to create zfs sendrecv
.SH "DESCRIPTION"
.PP
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 necessary 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\&.
.PP
The application is run as the amanda user, it must have many zfs privilege:
.sp
.nf
    zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
.fi
.PP
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:
.sp
.nf
usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
.fi
This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
.PP
The format of the
\fBdiskdevice\fR
in the disklist (DLE) must be one of:
.sp
.nf
Desciption              Example
\-\-\-\-\-\-\-\-\-\-              \-\-\-\-\-\-\-
Mountpoint              /data
ZFS pool name           datapool
ZFS filesystem          datapool/database
ZFS logical volume      datapool/dbvol
.fi
.PP
The filesystem doesn\*(Aqt need to be mounted\&.
.SH "PROPERTIES"
.PP
This section lists the properties that control amzfs\-sendrecv\*(Aqs functionality\&. See
\fBamanda-applications\fR(7)
for information on the Application API, application configuration\&.
.PP
DF\-PATH
.RS 4

Path to the \*(Aqdf\*(Aq binary, search in $PATH by default\&.
.RE
.PP
KEEP\-SNAPSHOT
.RS 4

If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail\&.
.RE
.PP
ZFS\-PATH
.RS 4

Path to the \*(Aqzfs\*(Aq binary, search in $PATH by default\&.
.RE
.PP
PFEXEC\-PATH
.RS 4

Path to the \*(Aqpfexec\*(Aq binary, search in $PATH by default\&.
.RE
.PP
PFEXEC
.RS 4

If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
.RE
.SH "EXAMPLE"


In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
.nf
 define application\-tool amzfs_sendrecv {
   comment "amzfs\-sendrecv"
   plugin "amzfs\-sendrecv"
   #property "DF\-PATH"  "/usr/sbin/df"
   #property "KEEP\-SNAPSHOT" "YES"
   #property "ZFS\-PATH" "/usr/sbin/zfs"
   #property "PFEXEC\-PATH" "/usr/sbin/pfexec"
   #property "PFEXEC" "NO"
 }

 define dumptype user\-zfs\-sendrecv {
   program "APPLICATION"
   application "amzfs_sendrecv"
 }
.fi
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
\fBamanda.conf\fR(5),
\fBamanda-client.conf\fR(5),
\fBamanda-applications\fR(7)
.PP
The Amanda Wiki:
: http://wiki.zmanda.com/
.SH "AUTHOR"
.PP
\fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
.RS 4
Zmanda, Inc\&. (http://www\&.zmanda\&.com)
.RE