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