1AMANDA(8) System Administration Commands AMANDA(8)
2
6 amanda - The Open Source Backup Platform
7
9 This manual page gives an overview of the Amanda commands and
10 configuration files for quick reference.
11 COMMANDS
13 Here are all the Amanda commands. Each one has its own manual page. See
14 them for all the gory details.
15 · amaddclient(8),
17 · amadmin(8),
19 · amaespipe(8),
21 · amarchiver(8),
23 · amcheck(8),
25 · amcheckdb(8),
27 · amcheckdump(8),
29 · amcleanup(8),
31 · amcrypt-ossl-asym(8),
33 · amcrypt-ossl(8),
35 · amcrypt(8),
37 · amcryptsimple(8),
39 · amdevcheck(8),
41 · amdump(8),
43 · amfetchdump(8),
45 · amflush(8),
47 · amgetconf(8),
49 · amgpgcrypt(8),
51 · amgtar(8),
53 · amlabel(8),
55 · amoverview(8),
57 · ampgsql(8),
59 · amplot(8),
61 · amraw(8),
63 · amrecover(8),
65 · amreport(8),
67 · amrestore(8),
69 · amrmtape(8),
71 · amsamba(8),
73 · amserverconfig(8),
75 · amservice(8),
77 · amstar(8),
79 · amstatus(8),
81 · amsuntar(8),
83 · amtape(8),
85 · amtapetype(8),
87 · amtoc(8),
89 · amvault(8),
91 · amzfs-sendrecv(8),
93 · amzfs-snapshot(8),
95 · script-email(8),
97 CONFIGURATION FILES
99 · amanda.conf(5),
100 · amanda-client.conf(5),
102 · disklist(5),
104 · tapelist(5),
106 DATA FORMATS
108 · amanda-archive-format(5),
109 CONCEPTS
111 · amanda-applications(7),
112 · amanda-auth(7),
114 · amanda-changers(7),
116 · amanda-compatibility(7),
118 · amanda-devices(7),
120 · amanda-scripts(7),
122 · amanda-taperscan(7),
124
126 There are four user-editable files that control the behavior of Amanda.
127 The first two are amanda.conf(5) and amanda-client.conf(5), the main
129 configuration files for the server and client, respectively. They
130 contain parameters to customize Amanda for the site.
131 Next is the disklist(5) file, which lists hosts and disk partitions to
133 back up.
134 Last is the seldom-edited tapelist(5) file, which lists tapes that are
136 currently active. These files are described in more detail in the
137 following sections.
138 All configuration files are stored in individual configuration
140 directories, usually under /etc/amanda/. A site will often have more
141 than one configuration. For example, it might have a normal
142 configuration for everyday backups and an archive configuration for
143 infrequent full archival backups. The configuration files would be
144 stored under directories /etc/amanda/normal/ and /etc/amanda/archive/,
145 respectively. Part of the job of an Amanda administrator is to create,
146 populate and maintain these directories.
147 Most Amanda applications take a "config" parameter; this is generally
149 the (unqualified) name of the configuration directory, e.g., normal. If
150 the parameter is . (dot), the current directory is used. This feature
151 is present for backward compatibility, but is not commonly used.
152
154 All log and database files generated by Amanda go in corresponding
155 directories somewhere. The exact location is controlled by entries in
156 amanda.conf(5). A typical location would be under /var/adm/amanda. For
157 the above example, the files might go in /var/adm/amanda/normal/ and
158 /var/adm/amanda/archive/.
159 As log files are no longer needed (no longer contain relevant
161 information), Amanda cycles them out in various ways, depending on the
162 type of file.
163 Detailed information about amdump runs are stored in dump logs -- files
165 named amdump.NN where NN is a sequence number, with 1 being the most
166 recent file. Amdump rotates these files each run, keeping roughly the
167 last tapecycle (see below) worth of them.
168 The file used by amreport to generate the mail summary is the trace
170 log. This file constitutes the "catalog" describing the data on the
171 tapes written in a run. It is named log.YYYYMMDDHHMMSS.NN where
172 YYYYMMDDHHMMSS is the datestamp of the start of the amdump or amflush
173 run and NN is a sequence number started at 0. At the end of each amdump
174 run, log files for runs whose tapes have been reused are renamed into a
175 subdirectory of the main log directory (see the logdir parameter below)
176 named oldlog. It is up to the Amanda administrator to remove them from
177 this directory when desired.
178 Index (backup image catalogue) files older than the full dump matching
180 the oldest backup image for a given client and disk are removed by
181 amdump at the end of each run.
182
184 For Samba access, Amanda needs a file on the Samba server (which may or
185 may not also be the tape server) named /etc/amandapass with share
186 names, (clear text) passwords and (optional) domain names, in that
187 order, one per line, whitespace separated. By default, the user used to
188 connect to the PC is the same for all PC´s and is compiled into Amanda.
189 It may be changed on a host by host basis by listing it first in the
190 password field followed by a percent sign and then the password. For
191 instance:
192 //some-pc/home normalpw
193 //another-pc/disk otheruser%otherpw
194 With clear text passwords, this file should obviously be tightly
196 protected. It only needs to be readable by the Amanda-user on the Samba
197 server.
198
200 All host and disk arguments to programs are special expressions. The
201 command applies to all DLEs that match the arguments. This section
202 describes the matcher.
203 The matcher matches by word, each word is a glob expression, words are
205 separated by the separator ´.´ for host and ´/´ for disk. You can
206 anchor the expression at left with a ´^´. You can anchor the expression
207 at right with a ´$´. The matcher is case insensitive for host but is
208 case sensitive for disk. A match succeeds if all words in your
209 expression match contiguous words in the host or disk.
210 If the disk is a UNC ("\\windows\share") then all ´\´ are converted to
212 ´/´ before the match. Using ´\´ is complicated because of the extra
213 quoting required by the shell and amanda. It´s easier to use ´/´
214 because it require less quoting ("//windows/share")
215 dot (.)
217 word separator for a host
218 /
220 word separator for a disk
221 \
223 word separator for a UNC disk
224 ^
226 anchor at left
227 $
229 anchor at right
230 ?
232 match exactly one character except the separator
233 *
235 match zero or more characters except the separator
236 **
238 match zero or more characters including the separator
239 [...]
241 match a single character, namely any of the characters enclosed by
242 the brackets.
243 [!...]
245 match a single character, namely any characters that is not
246 enclosed by the brackets.
247 The shell interpret some of these characters, they must be escaped by a
249 backslash ´\´ and/or the expression must be enclosed in simple or
250 double quote.
251 Some examples:
253 hosta
255 Will match hosta, foo.hosta.org, and hoSTA.dOMAIna.ORG but not
256 hostb.
257 host
259 Will match host but not hosta.
260 host?
262 Will match hosta and hostb, but not host.
263 ho*na
265 Will match hoina but not ho.aina.org.
266 ho**na
268 Will match hoina and ho.aina.org.
269 ^hosta
271 Will match hosta but not foo.hosta.org.
272 sda*
274 Will match /dev/sda1 and /dev/sda12.
275 /opt
277 Will match the disk opt but not the host opt.
278 (note dots:) .opt.
280 Will match the host opt but not the disk opt.
281 /
283 Will match the disk / but no other disk.
284 /usr
286 Will match the disks /usr and /usr/local.
287 /usr$
289 Will match the disks /usr but not /usr/local.
290 share
292 Will match the disks \\windows1\share and \\windows2\share.
293 share*
295 Will match the disks \\windows\share1 and \\windows\share2.
296 //windows/share
298 Will match the disk \\windows\share.
299
301 A datestamp expression is a range expression where we only match the
302 prefix. Leading ^ is removed. Trailing $ forces an exact match.
303 20001212-14
305 match all dates beginning with 20001212, 20001213 or 20001214
306 20001212-4
308 same as previous
309 20001212-24
311 match all dates between 20001212 and 20001224
312 2000121
314 match all dates that start with 2000121 (20001210-20001219)
315 2
317 match all dates that start with 2 (20000101-29991231)
318 2000-10
320 match all dates between 20000101-20101231
321 200010$
323 match only 200010
324
326 A dump specification selects one or more dumps. It has the form
327 [host][:disk][@datestamp], where each component is a pattern as
328 described above. If a component is missing, it is treated as a
329 wildcard. The characters ´:´, ´@´, and ´\´ may be escaped within any
330 component by preceding them with a ´\´.
331 Some examples:
333 client17
335 all dumps of client17
336 @20080615
338 All dumps on with datestamps matching 20080615
339 webserver:/var/www
341 All dumps of /var/www on host webserver
342 webserver:/var/www@200806150317
344 The dump of webserver with datestamp 200806150317
345 :/var/www
347 All dumps of /var/www on any host
348
350 Most commands allow the override of specific configuration options on
351 the command line, using the -o option. This option has the form
352 -oname=value. An optional space is allowed after the -o. Each
353 configuration option should be specified in a separate command-line
354 option.
355 For global options, name is simply the name of the option, e.g.,
357 amdump -oruntapes=2
359 For options in a named section of the configuration, name has the form
360 SECTION:section_name:name, where SECTION is one of TAPETYPE, DUMPTYPE,
361 HOLDINGDISK, or INTERFACE, and section_name is the name of the
362 tapetype, dumptype, holdingdisk, or interface. Examples:
363 amdump -o TAPETYPE:HP-DAT:length=2000m
365 amdump -o DUMPTYPE:no-compress:compress="server fast"
366 amdump -o HOLDINGDISK:hd1:use="-100 mb"
367 amdump -o INTERFACE:local:use="2000 kbps"
368 When overriding device properties, one must carefully quote the command
370 line to simulate the syntax of real configuration files. The following
371 example should serve as a guide:
372 amdump -o ´device-property="PROPERTY_MAX_VOLUME_USAGE" "100000"´
374 Note that configuration overrides are not effective for tape changers,
376 which supply a tapedev based on their own configuration. In order to
377 override tapedev, you must also disable any changer:
378 amdump -otapedev=/dev/nst1 -otpchanger=´´
380
382 James da Silva <jds@amanda.org>
383 Stefan G. Weichinger <sgw@amanda.org>
385Amanda 3.1.3 10/04/2010 AMANDA(8)