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: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMZFS\-SENDRECV" "8" "10/18/2010" "Amanda 3\&.2\&.0" "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 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 \'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\&.
  26 .PP
  27 The application is run as the amanda user, it must have many zfs priviledge:
  28 .sp
  29 .nf
  30     zfs allow \-ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
  31 .fi
  32 .PP
  33 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:
  34 .sp
  35 .nf
  36 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
  37 .fi
  38 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
  39 .PP
  40 The format of the DLE must be one of:
  41 .sp
  42 .nf
  43 Desciption              Example
  44 \-\-\-\-\-\-\-\-\-\-              \-\-\-\-\-\-\-
  45 Mountpoint              /data
  46 ZFS pool name           datapool
  47 ZFS filesystem          datapool/database
  48 ZFS logical volume      datapool/dbvol
  49 .fi
  50 .PP
  51 The filesystem doesn\'t need to be mounted\&.
  52 .SH "PROPERTIES"
  53 .PP
  54 This section lists the properties that control amzfs\-sendrecv\'s functionality\&. See
  55 \fBamanda-applications\fR(7)
  56 for information on the Application API, application configuration\&.
  57 .PP
  58 DF\-PATH
  59 .RS 4
  60
  61 Path to the \'df\' binary, search in $PATH by default\&.
  62 .RE
  63 .PP
  64 KEEP\-SNAPSHOT
  65 .RS 4
  66
  67 If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail\&.
  68 .RE
  69 .PP
  70 ZFS\-PATH
  71 .RS 4
  72
  73 Path to the \'zfs\' binary, search in $PATH by default\&.
  74 .RE
  75 .PP
  76 PFEXEC\-PATH
  77 .RS 4
  78
  79 Path to the \'pfexec\' binary, search in $PATH by default\&.
  80 .RE
  81 .PP
  82 PFEXEC
  83 .RS 4
  84
  85 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
  86 .RE
  87 .SH "EXAMPLE"
  88
  89
  90 In this example, a dumptype is defined to use amzfs\-sendrecv application to backup a zfs filesystem\&.
  91 .nf
  92  define application\-tool amzfs_sendrecv {
  93    comment "amzfs\-sendrecv"
  94    plugin "amzfs\-sendrecv"
  95    #property "DF\-PATH"  "/usr/sbin/df"
  96    #property "KEEP\-SNAPSHOT" "YES"
  97    #property "ZFS\-PATH" "/usr/sbin/zfs"
  98    #property "PFEXEC\-PATH" "/usr/sbin/pfexec"
  99    #property "PFEXEC" "NO"
 100  }
 101
 102  define dumptype user\-zfs\-sendrecv {
 103    program "APPLICATAION"
 104    application "amzfs_sendrecv"
 105  }
 106 .fi
 107 .SH "SEE ALSO"
 108 .PP
 109 \fBamanda\fR(8),
 110 \fBamanda.conf\fR(5),
 111 \fBamanda-client.conf\fR(5),
 112 \fBamanda-applications\fR(7)
 113 .PP
 114 The Amanda Wiki:
 115 : http://wiki.zmanda.com/
 116 .SH "AUTHOR"
 117 .PP
 118 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 119 .RS 4
 120 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 121 .RE