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 vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMZFS\-SENDRECV" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amzfs-sendrecv \- Amanda script to create zfs sendrecv
  23 .SH "DESCRIPTION"
  24 .PP
  25 amzfs\-sendrecv is an
  26 \fIAmanda\fR
  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\&.
  28 .PP
  29 The application is run as the amanda user, it must have many zfs priviledge:
  30 .sp
  31 .nf
  32     zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
  33 .fi
  34 .PP
  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:
  36 .sp
  37 .nf
  38 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
  39 .fi
  40 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
  41 .PP
  42 The format of the DLE must be one of:
  43 .sp
  44 .nf
  45 Desciption              Example
  46 \-\-\-\-\-\-\-\-\-\-              \-\-\-\-\-\-\-
  47 Mountpoint              /data
  48 ZFS pool name           datapool
  49 ZFS filesystem          datapool/database
  50 ZFS logical volume      datapool/dbvol
  51 .fi
  52 .PP
  53 The filesystem doesn\'t need to be mounted\&.
  54 .SH "PROPERTIES"
  55 .PP
  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\&.
  59 .PP
  60 DF\-PATH
  61 .RS 4
  62
  63 Path to the \'df\' binary, search in $PATH by default\&.
  64 .RE
  65 .PP
  66 KEEP\-SNAPSHOT
  67 .RS 4
  68
  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\&.
  70 .RE
  71 .PP
  72 ZFS\-PATH
  73 .RS 4
  74
  75 Path to the \'zfs\' binary, search in $PATH by default\&.
  76 .RE
  77 .PP
  78 PFEXEC\-PATH
  79 .RS 4
  80
  81 Path to the \'pfexec\' binary, search in $PATH by default\&.
  82 .RE
  83 .PP
  84 PFEXEC
  85 .RS 4
  86
  87 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
  88 .RE
  89 .SH "EXAMPLE"
  90
  91
  92 In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
  93 .nf
  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"
 102  }
 103
 104  define dumptype user\-zfs\-sendrecv {
 105    program "APPLICATAION"
 106    application "amzfs_sendrecv"
 107  }
 108 .fi
 109 .SH "SEE ALSO"
 110 .PP
 111
 112 \fBamanda.conf\fR(5),
 113 \fBamanda-client.conf\fR(5),
 114 \fBamanda-applications\fR(7)
 115 .SH "AUTHOR"
 116 .PP
 117 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 118 .RS 4
 119 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 120 .RE