git.gag.com Git - debian/amanda/blob - man/xml-source/amsamba.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='amsamba.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amsamba</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amsamba</refname>
  21 <refpurpose>Amanda Application to interface with smbclient</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 </refentryinfo>
  26 <!-- body begins here -->
  27
  28 <refsect1><title>DESCRIPTION</title>
  29
  30 <para>Amsamba is an Amanda Application API script.  It should not be run
  31 by users directly.  It uses smbclient to backup and restore data.</para>
  32
  33 <para> The device name in the disklist must have the form
  34 '//CIFSHOST/SHARE/SUBDIR' where CIFSHOST is the CIFS host containing the data
  35 to be backed up, SHARE is the share to connect, and subdir is the subdirectory
  36 to backup. '/subdir' can be ommited, in which case the complete share is
  37 archived.  </para>
  38
  39 <para> Unlike most applications, amsamba backs up and restores data located on
  40 a different system from that where amsamba itself runs.  The host containing
  41 the data is the CIFS host.  In practice, amsamba is usually run on the same
  42 system as the Amanda server, with a DLE like
  43 <programlisting>
  44 localhost "//CIFSHOST/SHARENAME" amsamba-dumptype
  45 </programlisting>
  46 </para>
  47
  48 <para> Include or exclude can be used, but not both. The path for 'exclude
  49 list' or 'include list' must be absolute path on the CIFS host. The estimate
  50 calculates the complete size of the share, without regard for include or
  51 exclude directives.  It will be larger than the actual dump if you use include
  52 or exclude. Using 'estimate server' in the dumptype could give better estimate.
  53 </para>
  54
  55 </refsect1>
  56
  57 <refsect1><title>PROPERTIES</title>
  58
  59 <para>This section lists the properties that control amsamba's functionality.
  60 See <manref name="amanda-applications" vol="7"/>
  61 for information on application properties and how they are configured.</para>
  62
  63 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  64 <variablelist>
  65  <!-- ==== -->
  66  <varlistentry><term>SMBCLIENT-PATH</term><listitem>
  67 The path to the smbclient binary.  The default is set when Amanda is built by the
  68 --with-smbclient configure option.
  69 </listitem></varlistentry>
  70  <!-- ==== -->
  71  <varlistentry><term>GNUTAR-PATH</term><listitem>
  72 The path to the gnutar binary.  The default is set when Amanda is built by the
  73 --with-gnutar configure option. gnutar is used to create the index.
  74 </listitem></varlistentry>
  75  <!-- ==== -->
  76  <varlistentry><term>AMANDAPASS</term><listitem>
  77 Location of the amandapass file, defaulting to "$CONFIG_DIR/amandapass".
  78 Relative pathnames are relative to the configuration directory,
  79 "$CONFIG_DIR/&lt;config&gt;".
  80 Note that this file is located on the client, not on the server.
  81 The format of the file is as follow:
  82 <programlisting>
  83   Sharename User%Password Domain
  84 </programlisting>
  85 Sharename is '//HOST/SHARE' without the SUBDIR.
  86 Sharename can be quoted,
  87 it can be '*' to match all share,
  88 it can be '//pc-host/*' to match all share on pc-host.
  89 User is the username use to connect to the share.
  90 Password is the password use to connect to the share.
  91 '%Password' is optional if the user can connect to the share without password.
  92 'User%Password' is optional, the user 'guest' without password is use to connect to the share.
  93 Domain is optional. Example:
  94 <programlisting>
  95   //another-pc/share otheruser%otherpw domain
  96   //another-pc/share otheruser%otherpw
  97   //another-pc/share myuser mydomain
  98   //another-pc/share myuser
  99   //another-pc/share
 100 </programlisting>
 101 </listitem></varlistentry>
 102  <!-- ==== -->
 103  <varlistentry><term>ALLOW-ANONYMOUS</term><listitem>
 104 This username without password is used to connect to the share if no matching entry is found in the amandapass file.
 105 </listitem></varlistentry>
 106  <!-- ==== -->
 107  <varlistentry><term>DIRECTORY</term><listitem>
 108 For restore command only, the data is recoved in that directory. Must be a unix path for "tar" RECOVER-MODE or a smb path for "smb" recover-MODE.
 109 </listitem></varlistentry>
 110  <!-- ==== -->
 111  <varlistentry><term>RECOVER-MODE</term><listitem>
 112 "tar" or "smb", default to "tar". If "tar", the data is recovered on the local machine, If "smb", the data is recovered on the smb client machine.
 113 </listitem></varlistentry>
 114 </variablelist>
 115
 116 </refsect1>
 117
 118 <refsect1><title>INCLUDE AND EXCLUDE LISTS</title>
 119
 120 <para>This application supplies exclude lists via the
 121 <command>smbclient</command> <option>-TX</option> option.  Normal shell-style
 122 wildcard expressions, using * and ?, are not supported.  All expressions are
 123 matched only from the base directory of the DLE.  Expressions that match a
 124 directory may have a leading or trailing "/".  Example expressions:
 125 <programlisting>
 126   ./temp-files           # exclude top-level dir "temp-files" entirely
 127   ./temp-files/          # same
 128   /temp-files            # same
 129   temp-files             # same
 130   ./temp-files/*         # BAD: does nothing
 131   *.iso                  # BAD: does nothing
 132   proxy/local/cache      # exclude "cache" in dir "proxy/local"
 133 </programlisting>
 134 </para>
 135
 136 <para>Include lists are supported only if excludes are not given.  They are
 137 handled via the <command>smbclient</command> <option>-TI</option> option.
 138 Include matching is identical to the exclude matching described above.</para>
 139
 140 </refsect1>
 141
 142 <refsect1><title>EXAMPLE</title>
 143 <programlisting>
 144   define application app_amsamba {
 145     property "SMBCLIENT-PATH" "/usr/bin/smbclient"
 146     property "GNUTAR-PATH" "/bin/tar"
 147     property "AMANDAPASS" /etc/amandapass"
 148     property "ALLOW-ANONYMOUS" "guest"
 149   }
 150 </programlisting>
 151 </refsect1>
 152
 153 <seealso>
 154 <manref name="amanda.conf" vol="5"/>,
 155 <manref name="amanda-applications" vol="7"/>
 156 </seealso>
 157 </refentry>