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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amzfs-sendrecv.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amzfs-sendrecv</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amzfs-sendrecv</refname>
  21 <refpurpose>Amanda script to create zfs sendrecv</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 </refentryinfo>
  26 <!-- body begins here -->
  27
  28 <refsect1><title>DESCRIPTION</title>
  29
  30 <para>amzfs-sendrecv is an &A; application implementing the Application API.
  31 It should not be run by users directly.
  32 It create a zfs snapshot of the filesystem and backup the snapshot with 'zfs send'.
  33 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.
  34 If you want only full backup, you can disable this feature by setting the KEEP-SNAPSHOT property to 'NO'.
  35 Only the restoration of the complete backup is allowed, it is impossible to restore a single file.</para>
  36
  37 <para>The application is run as the amanda user, it must have many zfs priviledge:
  38 <programlisting>
  39     zfs allow -ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM
  40 </programlisting></para>
  41
  42 <para>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:
  43 <programlisting>
  44 usermod -P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
  45 </programlisting>
  46 This will require that your run zfs under pfexec, set the PFEXEC property to YES.</para>
  47
  48 <para>The format of the DLE must be one of:
  49 <programlisting>
  50 Desciption              Example
  51 ----------              -------
  52 Mountpoint              /data
  53 ZFS pool name           datapool
  54 ZFS filesystem          datapool/database
  55 ZFS logical volume      datapool/dbvol
  56 </programlisting></para>
  57
  58 <para>The filesystem doesn't need to be mounted.</para>
  59
  60 </refsect1>
  61
  62 <refsect1><title>PROPERTIES</title>
  63
  64 <para>This section lists the properties that control amzfs-sendrecv's functionality.
  65 See <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  66 for information on the Application API, application configuration.</para>
  67
  68 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  69 <variablelist>
  70  <!-- ==== -->
  71  <varlistentry><term>DF-PATH</term><listitem>
  72 Path to the 'df' binary, search in $PATH by default.
  73 </listitem></varlistentry>
  74  <!-- ==== -->
  75  <varlistentry><term>KEEP-SNAPSHOT</term><listitem>
  76 If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail.
  77 </listitem></varlistentry>
  78  <!-- ==== -->
  79  <varlistentry><term>ZFS-PATH</term><listitem>
  80 Path to the 'zfs' binary, search in $PATH by default.
  81 </listitem></varlistentry>
  82  <!-- ==== -->
  83  <varlistentry><term>PFEXEC-PATH</term><listitem>
  84 Path to the 'pfexec' binary, search in $PATH by default.
  85 </listitem></varlistentry>
  86  <!-- ==== -->
  87  <varlistentry><term>PFEXEC</term><listitem>
  88 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used.
  89 </listitem></varlistentry>
  90 </variablelist>
  91
  92 </refsect1>
  93
  94 <refsect1><title>EXAMPLE</title>
  95
  96 In this example, a dumptype is defined to use amzfs-sendrecv application to backup a zfs filesystem.
  97
  98 <programlisting>
  99  define application-tool amzfs_sendrecv {
 100    comment "amzfs-sendrecv"
 101    plugin "amzfs-sendrecv"
 102    #property "DF-PATH"  "/usr/sbin/df"
 103    #property "KEEP-SNAPSHOT" "YES"
 104    #property "ZFS-PATH" "/usr/sbin/zfs"
 105    #property "PFEXEC-PATH" "/usr/sbin/pfexec"
 106    #property "PFEXEC" "NO"
 107  }
 108
 109  define dumptype user-zfs-sendrecv {
 110    program "APPLICATAION"
 111    application "amzfs_sendrecv"
 112  }
 113 </programlisting>
 114 </refsect1>
 115
 116 <refsect1><title>SEE ALSO</title>
 117 <para>
 118 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 119 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 120 <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 121 </para>
 122
 123 </refsect1>
 124 </refentry>