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 '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 Amanda 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 <emphasis remap='B'>diskdevice</emphasis> in the
  49 disklist (DLE) must be one of:
  50 <programlisting>
  51 Desciption              Example
  52 ----------              -------
  53 Mountpoint              /data
  54 ZFS pool name           datapool
  55 ZFS filesystem          datapool/database
  56 ZFS logical volume      datapool/dbvol
  57 </programlisting></para>
  58
  59 <para>The filesystem doesn't need to be mounted.</para>
  60
  61 </refsect1>
  62
  63 <refsect1><title>PROPERTIES</title>
  64
  65 <para>This section lists the properties that control amzfs-sendrecv's functionality.
  66 See <manref name="amanda-applications" vol="7"/>
  67 for information on the Application API, application configuration.</para>
  68
  69 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  70 <variablelist>
  71  <!-- ==== -->
  72  <varlistentry><term>DF-PATH</term><listitem>
  73 Path to the 'df' binary, search in $PATH by default.
  74 </listitem></varlistentry>
  75  <!-- ==== -->
  76  <varlistentry><term>KEEP-SNAPSHOT</term><listitem>
  77 If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail.
  78 </listitem></varlistentry>
  79  <!-- ==== -->
  80  <varlistentry><term>ZFS-PATH</term><listitem>
  81 Path to the 'zfs' binary, search in $PATH by default.
  82 </listitem></varlistentry>
  83  <!-- ==== -->
  84  <varlistentry><term>PFEXEC-PATH</term><listitem>
  85 Path to the 'pfexec' binary, search in $PATH by default.
  86 </listitem></varlistentry>
  87  <!-- ==== -->
  88  <varlistentry><term>PFEXEC</term><listitem>
  89 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used.
  90 </listitem></varlistentry>
  91 </variablelist>
  92
  93 </refsect1>
  94
  95 <refsect1><title>EXAMPLE</title>
  96
  97 In this example, a dumptype is defined to use amzfs-sendrecv application to backup a zfs filesystem.
  98
  99 <programlisting>
 100  define application-tool amzfs_sendrecv {
 101    comment "amzfs-sendrecv"
 102    plugin "amzfs-sendrecv"
 103    #property "DF-PATH"  "/usr/sbin/df"
 104    #property "KEEP-SNAPSHOT" "YES"
 105    #property "ZFS-PATH" "/usr/sbin/zfs"
 106    #property "PFEXEC-PATH" "/usr/sbin/pfexec"
 107    #property "PFEXEC" "NO"
 108  }
 109
 110  define dumptype user-zfs-sendrecv {
 111    program "APPLICATION"
 112    application "amzfs_sendrecv"
 113  }
 114 </programlisting>
 115 </refsect1>
 116
 117 <seealso>
 118 <manref name="amanda.conf" vol="5"/>,
 119 <manref name="amanda-client.conf" vol="5"/>,
 120 <manref name="amanda-applications" vol="7"/>
 121 </seealso>
 122
 123 </refentry>