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