git.gag.com Git - debian/amanda/blob - man/xml-source/disklist.5.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='disklist.5'>
  11
  12 <refmeta>
  13 <refentrytitle>disklist</refentrytitle>
  14 <manvolnum>5</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.5;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>disklist</refname>
  21 <refpurpose>List of partitions to back up for Amanda</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jds;
  25 &author.sgw.xml;
  26 &author.dustin;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29
  30 <refsect1><title>DESCRIPTION</title>
  31 <para>The
  32 <emphasis remap='I'>disklist</emphasis>
  33 file determines which disks will be backed up by Amanda.
  34 The file usually contains one line per disk:</para>
  35
  36 <programlisting>
  37 <emphasis>hostname diskname</emphasis> [<emphasis>diskdevice</emphasis>] <emphasis>dumptype</emphasis> [<emphasis>spindle</emphasis> [<emphasis>interface</emphasis>] ]
  38 </programlisting>
  39
  40 <para>All pairs [ <emphasis>hostname diskname</emphasis> ] must be unique.</para>
  41
  42 <para>Lines starting with # are ignored, as are blank lines.
  43 The fields have the following meanings:</para>
  44 <variablelist remap='TP'>
  45   <varlistentry>
  46   <term><emphasis remap='I'>hostname</emphasis></term>
  47   <listitem>
  48 <para>The name of the host to be backed up.
  49 If
  50 <emphasis remap='B'>diskdevice</emphasis>
  51 refers to a PC share, this is the host Amanda will run the Samba
  52 <emphasis remap='B'>smbclient</emphasis> program on to back up the share.</para>
  53   </listitem>
  54   </varlistentry>
  55   <varlistentry>
  56   <term><emphasis remap='I'>diskname</emphasis></term>
  57   <listitem>
  58 <para>The name of the disk (a label).
  59 In most case, you set your
  60 <emphasis remap='B'>diskname</emphasis>
  61 to the
  62 <emphasis remap='B'>diskdevice</emphasis>
  63 and you don't set the
  64 <emphasis remap='B'>diskdevice.</emphasis>
  65 If you want multiple entries with the same
  66 <emphasis remap='B'>diskdevice</emphasis>,
  67 you must set a different
  68 <emphasis remap='B'>diskname</emphasis>
  69 for each entry. It's the
  70 <emphasis remap='B'>diskname</emphasis>
  71 that you use on the commandline for any Amanda command.
  72 Look at the example/disklist file for example.</para>
  73   </listitem>
  74   </varlistentry>
  75   <varlistentry>
  76   <term><emphasis remap='I'>diskdevice</emphasis></term>
  77   <listitem>
  78 <para>Default: same as diskname.
  79 The name of the disk device to be backed up. It may be a full device name,
  80 a device name without the
  81 <filename>/dev/</filename>
  82 prefix, e.g.
  83 <emphasis remap='I'>sd0a</emphasis>,
  84 or a mount point such as
  85 <filename>/usr</filename>.</para>
  86
  87 <para>It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
  88 <filename>//some-pc/home</filename>.
  89 In this case, the
  90 <emphasis remap='B'>program</emphasis>
  91 option in the associated
  92 <emphasis remap='B'>dumptype</emphasis>
  93 must be entered as
  94 <emphasis remap='B'>GNUTAR</emphasis>.
  95 It is the combination of the double slash disk name and
  96 <emphasis remap='B'>program GNUTAR</emphasis>
  97 in the
  98 <emphasis remap='B'>dumptype</emphasis>
  99 that triggers the use of Samba.</para>
 100 </listitem>
 101 </varlistentry>
 102
 103   <varlistentry>
 104   <term><emphasis remap='I'>dumptype</emphasis></term>
 105   <listitem>
 106 <para>Refers to a
 107 <emphasis remap='B'>dumptype</emphasis>
 108 defined in the
 109 <emphasis remap='B'>amanda.conf</emphasis>
 110 file.
 111 <emphasis remap='I'>Dumptype</emphasis>s
 112 specify backup related parameters,
 113 such as whether to compress the backups,
 114 whether to record backup results in
 115 <filename>/etc/dumpdates</filename>, the disk's relative priority, etc.</para>
 116   </listitem>
 117   </varlistentry>
 118   <varlistentry>
 119   <term><emphasis remap='I'>spindle</emphasis></term>
 120   <listitem>
 121 <para>Default:
 122 <option>-1</option>.
 123 A number used to balance backup load on a host.
 124 Amanda will not run multiple backups at the same time
 125 on the same spindle, unless the spindle number is -1,
 126 which means there is no spindle restriction.</para>
 127   </listitem>
 128   </varlistentry>
 129   <varlistentry>
 130   <term><emphasis remap='I'>interface</emphasis></term>
 131   <listitem>
 132 <para>Default:
 133 <emphasis remap='I'>local</emphasis>.
 134 The name of a network interface definition in the
 135 <emphasis remap='B'>amanda.conf</emphasis>
 136 file, used to balance network load.</para>
 137   </listitem>
 138   </varlistentry>
 139 </variablelist>
 140
 141 <para>Instead of naming a
 142 <emphasis remap='B'>dumptype</emphasis>,
 143 it is possible to define one in-line, enclosing
 144 <emphasis remap='B'>dumptype</emphasis>
 145 options within curly braces, one per line, just like a
 146 <emphasis remap='B'>dumptype</emphasis>
 147 definition in
 148 <emphasis remap='B'>amanda.conf</emphasis>.
 149 Since pre-existing
 150 <emphasis remap='B'>dumptype</emphasis>s
 151 are valid option names, this syntax may be used to customize
 152 <emphasis remap='B'>dumptype</emphasis>s
 153 for particular disks.</para>
 154
 155 <para>A line break
 156 <emphasis remap='B'>must</emphasis>
 157 follow the left curly bracket.</para>
 158
 159 <para>For instance, if a
 160 <emphasis remap='B'>dumptype</emphasis>
 161 named
 162 <emphasis remap='I'>normal</emphasis>
 163 is used for most disks, but use of the holding disk needs to be disabled
 164 for the file system that holds it, this would work instead of defining
 165 a new dumptype:</para>
 166
 167 <programlisting>
 168 <emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
 169   normal
 170   holdingdisk never
 171 } [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]
 172 </programlisting>
 173
 174 <para>The { must appear at the end of a line, and the } on its own line possibly followed by the spindle and interface.</para>
 175 </refsect1>
 176
 177 <seealso>
 178 <manref name="amanda.conf" vol="5"/>
 179 </seealso>
 180
 181 </refentry>