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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <refentry id='disklist.5'>
13 <refentrytitle>disklist</refentrytitle>
14 <manvolnum>5</manvolnum>
20 <refname>disklist</refname>
21 <refpurpose>List of partitions to back up for &A;</refpurpose>
28 <!-- body begins here -->
30 <refsect1><title>DESCRIPTION</title>
32 <emphasis remap='I'>disklist</emphasis>
33 file determines which disks will be backed up by &A;.
34 The file usually contains one line per disk:</para>
37 <emphasis>hostname diskname</emphasis> [<emphasis>diskdevice</emphasis>] <emphasis>dumptype</emphasis> [<emphasis>spindle</emphasis> [<emphasis>interface</emphasis>] ]
40 <para>All pairs [ <emphasis>hostname diskname</emphasis> ] must be unique.</para>
42 <para>Lines starting with # are ignored, as are blank lines.
43 The fields have the following meanings:</para>
44 <variablelist remap='TP'>
46 <term><emphasis remap='I'>hostname</emphasis></term>
48 <para>The name of the host to be backed up.
50 <emphasis remap='B'>diskdevice</emphasis>
51 refers to a PC share, this is the host &A; will run the Samba
52 <emphasis remap='B'>smbclient</emphasis> program on to back up the share.</para>
56 <term><emphasis remap='I'>diskname</emphasis></term>
58 <para>The name of the disk (a label).
59 In most case, you set your
60 <emphasis remap='B'>diskname</emphasis>
62 <emphasis remap='B'>diskdevice</emphasis>
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 &A; command.
72 Look at the example/disklist file for example.</para>
76 <term><emphasis remap='I'>diskdevice</emphasis></term>
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>
83 <emphasis remap='I'>sd0a</emphasis>,
84 or a mount point such as
85 <filename>/usr</filename>.</para>
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>.
90 <emphasis remap='B'>program</emphasis>
91 option in the associated
92 <emphasis remap='B'>dumptype</emphasis>
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>
98 <emphasis remap='B'>dumptype</emphasis>
99 that triggers the use of Samba.</para>
104 <term><emphasis remap='I'>dumptype</emphasis></term>
107 <emphasis remap='B'>dumptype</emphasis>
109 <emphasis remap='B'>amanda.conf</emphasis>
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>/var/lib/dumpdates</filename>, the disk's relative priority, etc.</para>
119 <term><emphasis remap='I'>spindle</emphasis></term>
123 A number used to balance backup load on a host.
124 &A; 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>
130 <term><emphasis remap='I'>interface</emphasis></term>
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>
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>
148 <emphasis remap='B'>amanda.conf</emphasis>.
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>
156 <emphasis remap='B'>must</emphasis>
157 follow the left curly bracket.</para>
159 <para>For instance, if a
160 <emphasis remap='B'>dumptype</emphasis>
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>
168 <emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
171 } [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]