git.gag.com Git - debian/amanda/blob - man/amzfs-sendrecv.8

   1 '\" t
   2 .\"     Title: amzfs-sendrecv
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2012
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.3.2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMZFS\-SENDRECV" "8" "07/25/2012" "Amanda 3\&.3\&.2" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amzfs-sendrecv \- Amanda script to create zfs sendrecv
  32 .SH "DESCRIPTION"
  33 .PP
  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\&.
  35 .PP
  36 The application is run as the amanda user, it must have many zfs priviledge:
  37 .sp
  38 .nf
  39     zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
  40 .fi
  41 .PP
  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:
  43 .sp
  44 .nf
  45 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
  46 .fi
  47 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
  48 .PP
  49 The format of the
  50 \fBdiskdevice\fR
  51 in the disklist (DLE) must be one of:
  52 .sp
  53 .nf
  54 Desciption              Example
  55 \-\-\-\-\-\-\-\-\-\-              \-\-\-\-\-\-\-
  56 Mountpoint              /data
  57 ZFS pool name           datapool
  58 ZFS filesystem          datapool/database
  59 ZFS logical volume      datapool/dbvol
  60 .fi
  61 .PP
  62 The filesystem doesn\*(Aqt need to be mounted\&.
  63 .SH "PROPERTIES"
  64 .PP
  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\&.
  68 .PP
  69 DF\-PATH
  70 .RS 4
  71
  72 Path to the \*(Aqdf\*(Aq binary, search in $PATH by default\&.
  73 .RE
  74 .PP
  75 KEEP\-SNAPSHOT
  76 .RS 4
  77
  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\&.
  79 .RE
  80 .PP
  81 ZFS\-PATH
  82 .RS 4
  83
  84 Path to the \*(Aqzfs\*(Aq binary, search in $PATH by default\&.
  85 .RE
  86 .PP
  87 PFEXEC\-PATH
  88 .RS 4
  89
  90 Path to the \*(Aqpfexec\*(Aq binary, search in $PATH by default\&.
  91 .RE
  92 .PP
  93 PFEXEC
  94 .RS 4
  95
  96 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
  97 .RE
  98 .SH "EXAMPLE"
  99
 100
 101 In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
 102 .nf
 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"
 111  }
 112
 113  define dumptype user\-zfs\-sendrecv {
 114    program "APPLICATION"
 115    application "amzfs_sendrecv"
 116  }
 117 .fi
 118 .SH "SEE ALSO"
 119 .PP
 120 \fBamanda\fR(8),
 121 \fBamanda.conf\fR(5),
 122 \fBamanda-client.conf\fR(5),
 123 \fBamanda-applications\fR(7)
 124 .PP
 125 The Amanda Wiki:
 126 : http://wiki.zmanda.com/
 127 .SH "AUTHOR"
 128 .PP
 129 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 130 .RS 4
 131 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 132 .RE