]> git.sur5r.net Git - bacula/docs/blob - docs/manual/restore.tex
Update
[bacula/docs] / docs / manual / restore.tex
1 %%
2 %%
3
4 \section*{The Bacula Console Restore Command}
5 \label{_ChapterStart13}
6 \index[general]{Command!Bacula Console Restore }
7 \index[general]{Bacula Console Restore Command }
8 \addcontentsline{toc}{section}{Bacula Console Restore Command}
9
10 \subsection*{General}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
13
14 Below, we will discuss restoring files with the Console {\bf restore} command,
15 which is the recommended way of doing it. However, there is a standalone
16 program named {\bf bextract}, which also permits restoring files. For more
17 information on this program, please see the 
18 \ilink{Bacula Utility Programs}{bextract} chapter of this manual.
19 You will also want to look at the {\bf bls} program in the same chapter, which
20 allows you to list the contents of your Volumes. Finally, if you have an old
21 Volume that is no longer in the catalog, you can restore the catalog entries
22 using the program named {\bf bscan}, documented in the same 
23 \ilink{Bacula Utility Programs}{bextract} chapter. 
24
25 In general, to restore a file or a set of files, you must run a {\bf restore}
26 job. That is a job with {\bf Type = Restore}. As a consequence, you will need
27 a predefined {\bf restore} job in your {\bf bacula-dir.conf} (Director's
28 config) file. The exact parameters (Client, FileSet, ...) that you define are
29 not important as you can either modify them manually before running the job or
30 if you use the {\bf restore} command, explained below, Bacula will  
31 automatically set them for you. In fact, you can no longer simply run a restore
32 job.  You must use the restore command.                                  
33
34 Since Bacula is a network backup program, you must be aware that when you
35 restore files, it is up to you to ensure that you or Bacula have selected the
36 correct Client and the correct hard disk location for restoring those files.
37 {\bf Bacula} will quite willingly backup client A, and restore it by sending
38 the files to a different directory on client B. Normally, you will want to
39 avoid this, but assuming the operating systems are not too different in their
40 file structures, this should work perfectly well, if so desired. 
41 By default, Bacula will restore data to the same Client that was backed
42 up, and those data will be restored not to the original places but to
43 {\bf /tmp/bacula-restores}.  You may modify any of these defaults when the
44 restore command prompts you to run the job by selecting the {\bf mod}
45 option.
46
47 \label{Example1}
48 \subsection*{The Restore Command}
49 \index[general]{Command!Restore }
50 \index[general]{Restore Command }
51 \addcontentsline{toc}{subsection}{Restore Command}
52
53 Since Bacula maintains a catalog of your files and on which Volumes (disk or
54 tape), they are stored, it can do most of the bookkeeping work, allowing you
55 simply to specify what kind of restore you want (current, before a particular
56 date), and what files to restore. Bacula will then do the rest. 
57
58 This is accomplished using the {\bf restore} command in the Console. First you
59 select the kind of restore you want, then the JobIds are selected,
60 the File records for those Jobs are placed in an internal Bacula directory
61 tree, and the restore enters a file selection mode that allows you to
62 interactively walk up and down the file tree selecting individual files to be
63 restored. This mode is somewhat similar to the standard Unix {\bf restore}
64 program's interactive file selection mode. 
65
66 If your Files have been pruned, the {\bf restore} command will be unable
67 to find any files to restore. See below for more details on this. 
68
69 Within the Console program, after entering the {\bf restore} command, you are
70 presented with the following selection prompt:  
71
72 \footnotesize
73 \begin{verbatim}
74 First you select one or more JobIds that contain files
75 to be restored. You will be presented several methods
76 of specifying the JobIds. Then you will be allowed to
77 select which files from those JobIds are to be restored.
78 To select the JobIds, you have the following choices:
79      1: List last 20 Jobs run
80      2: List Jobs where a given File is saved
81      3: Enter list of comma separated JobIds to select
82      4: Enter SQL list command
83      5: Select the most recent backup for a client
84      6: Select backup for a client before a specified time
85      7: Enter a list of files to restore
86      8: Enter a list of files to restore before a specified time
87      9: Find the JobIds of the most recent backup for a client
88     10: Find the JobIds for a backup for a client before a specified time
89     11: Enter a list of directories to restore for found JobIds
90     12: Cancel
91 Select item:  (1-12):
92 \end{verbatim}
93 \normalsize
94
95 \begin{itemize}
96 \item Item 1 will list the last 20 jobs run. If you find the Job you want,
97    you can then select item 3 and enter its JobId(s).
98
99 \item Item 2 will list all the Jobs where a specified file is saved.  If you
100    find the Job you want, you can then select item 3 and enter the JobId.
101
102 \item Item 3 allows you the enter a list of comma separated JobIds whose 
103    files will be put into the directory tree. You may then select which
104    files from those JobIds to restore.
105
106 \item Item 4 allows you to enter any arbitrary SQL command. This is  probably
107    the most primitive way of finding the desired JobIds,  but at the same time,
108    the most flexible.  Once you have found the JobId(s), you can select item 3
109    and enter  them.
110
111 \item Item 5 will automatically select the most recent Full backup and all 
112    subsequent incremental and differential backups for a specified Client.
113    These are the Jobs and Files which, if reloaded, will restore your
114    system to the most current saved state.  It automatically enters the
115    JobIds found into the directory tree.  This is probably the most
116    convenient of all the above options to use if you wish to restore a
117    selected Client to its most recent state.
118
119    There are two important things to note. First, this automatic selection
120    will never select a job that failed (terminated with an error status).
121    If you have such a job and want to recover one or more files from it,
122    you will need to explicitly enter the JobId in item 3, then choose the
123    files to restore.
124
125    If some of the Jobs that are needed to do the restore have had their 
126    File records pruned, the restore will be incomplete. Bacula currently
127    does not correctly detect this condition.  You can however, check for
128    this by looking carefully at the list of Jobs that Bacula selects and
129    prints. If you find Jobs with the JobFiles column set to zero, when
130    files should have been backed up, then you should expect problems.
131
132    If all the File records have been pruned, Bacula will realize that there
133    are no file records in any of the JobIds chosen and will inform you. It
134    will then propose doing a full restore (non-selective) of those JobIds.
135    This is possible because Bacula still knows where the beginning of the
136    Job data is on the Volumes, even if it does not know where particular
137    files are located.
138
139 \item Item 6 allows you to specify a date and time, after which Bacula  will
140    automatically select the most recent Full backup and all  subsequent
141    incremental and differential backups that started  before the specified date
142   and time.  
143
144 \item Item 7 allows you to specify one or more filenames  (complete path
145    required) to be restored. Each filename  is entered one at a time or if you
146    prefix a filename  with the less-than symbol (\lt{}) Bacula will read that 
147    file and assume it is a list of filenames to be restored.  The filename entry
148    mode is terminated by entering a  blank line.
149
150 \item Item 8 allows you to specify a date and time before  entering the
151    filenames. See Item 7 above for more  details.
152
153 \item Item 9 allows you find the JobIds of the most recent backup for
154    a client. This is much like option 5 (it uses the same code), but
155    those JobIds are retained internally as if you had entered them
156    manually.  You may then select item 11 (see below) to restore one
157    or more directories.
158
159 \item Item 10 is the same as item 9, except that it allows you to enter
160    a before date (as with item 6). These JobIds will then be retained
161    internally.
162
163 \index[general]{Restore Directories}
164 \item Item 11 allows you to enter a list of JobIds from which you can
165    select directories to be restored. The list of JobIds can have been
166    previously created by using either item 9 or 10 on the menu.  You
167    may then enter a full path to a directory name or a filename preceded
168    by a less than sign (\lt{}). The filename should contain a list
169    of directories to be restored.  All files in those directories will
170    be restored, but if the directory contains subdirectories, nothing
171    will be restored in the subdirectory unless you explicitly enter its
172    name.
173
174 \item Item 12 allows you to cancel the restore command.  
175 \end{itemize}
176
177 As an example, suppose that we select item 5 (restore to most recent state).
178 It will then ask for the desired Client, which on my system, will print all
179 the Clients found in the database as follows:  
180
181 \footnotesize
182 \begin{verbatim}
183 Defined clients:
184      1: Rufus
185      2: Matou
186      3: Polymatou
187      4: Minimatou
188      5: Minou
189      6: MatouVerify
190      7: PmatouVerify
191      8: RufusVerify
192      9: Watchdog
193 Select Client (File daemon) resource (1-9):
194      
195 \end{verbatim}
196 \normalsize
197
198 You will probably have far fewer Clients than this example, and  if you have
199 only one Client, it will be automatically selected. In this case, I enter
200 {\bf Rufus} to select the Client. Then  Bacula needs to know what FileSet is
201 to be restored, so it  prompts with:  
202
203 \footnotesize
204 \begin{verbatim}
205 The defined FileSet resources are:
206      1: Full Set
207      2: Kerns Files
208 Select FileSet resource (1-2):
209      
210 \end{verbatim}
211 \normalsize
212
213 I choose item 1, which is my full backup. Normally, you will only have a
214 single FileSet for each Job, and if your machines are similar (all Linux) you
215 may only have one FileSet for all your Clients. 
216
217 At this point, {\bf Bacula} has all the information it needs to find the most
218 recent set of backups. It will then query the database, which may take a bit
219 of time, and it will come up with something like the following. Note, some of
220 the columns are truncated here for presentation: 
221
222 \footnotesize
223 \begin{verbatim}
224 +-------+------+----------+-------------+-------------+------+-------+----------
225 --+
226 | JobId | Levl | JobFiles | StartTime   | VolumeName  | File | SesId |
227 VolSesTime |
228 +-------+------+----------+-------------+-------------+------+-------+----------
229 --+
230 | 1,792 | F    |  128,374 | 08-03 01:58 | DLT-19Jul02 |   67 |    18 |
231 1028042998 |
232 | 1,792 | F    |  128,374 | 08-03 01:58 | DLT-04Aug02 |    0 |    18 |
233 1028042998 |
234 | 1,797 | I    |      254 | 08-04 13:53 | DLT-04Aug02 |    5 |    23 |
235 1028042998 |
236 | 1,798 | I    |       15 | 08-05 01:05 | DLT-04Aug02 |    6 |    24 |
237 1028042998 |
238 +-------+------+----------+-------------+-------------+------+-------+----------
239 --+
240 You have selected the following JobId: 1792,1792,1797
241 Building directory tree for JobId 1792 ...
242 Building directory tree for JobId 1797 ...
243 Building directory tree for JobId 1798 ...
244 cwd is: /
245 $
246 \end{verbatim}
247 \normalsize
248
249 Depending on the number of {\bf JobFiles} for each JobId, the {\bf Building
250 directory tree ..."} can take a bit of time. If you notice ath all the
251 JobFiles are zero, your Files have probably been pruned and you will not be
252 able to select any individual files -- it will be restore everything or
253 nothing.
254
255 In our example, Bacula found four Jobs that comprise the most recent backup of
256 the specified Client and FileSet. Two of the Jobs have the same JobId because
257 that Job wrote on two different Volumes. The third Job was an incremental
258 backup to the previous Full backup, and it only saved 254 Files compared to
259 128,374 for the Full backup. The fourth Job was also an incremental backup
260 that saved 15 files. 
261
262 Next Bacula entered those Jobs into the directory tree, with no files marked
263 to be restored as a default, tells you how many files are in the tree, and
264 tells you that the current working directory ({\bf cwd}) is /. Finally, Bacula
265 prompts with the dollar sign (\$) to indicate that you may enter commands to
266 move around the directory tree and to select files. 
267              
268 If you want all the files to automatically be marked when the directory
269 tree is built, enter the command {\bf restore all}.
270
271 Instead of choosing item 5 on the first menu (Select the most recent backup
272 for a client), if we had chosen item 3 (Enter list of JobIds to select) and we
273 had entered the JobIds {\bf 1792,1797,1798} we would have arrived at the same
274 point.                 
275
276 One point to note, if you are manually entering JobIds, is that you must enter
277 them in the order they were run (generally in increasing JobId order). If you
278 enter them out of order and the same file was saved in two or more of the
279 Jobs, you may end up with an old version of that file (i.e. not the most
280 recent). 
281
282 Directly entering the JobIds can also permit you to recover data from
283 a Job that wrote files to tape but that terminated with an error status.
284
285 While in file selection mode, you can enter {\bf help} or a question mark (?)
286 to produce a summary of the available commands:  
287
288 \footnotesize
289 \begin{verbatim}
290  Command    Description
291   =======    ===========
292   cd         change current directory
293   count      count marked files in and below the cd
294   dir        long list current directory, wildcards allowed
295   done       leave file selection mode
296   estimate   estimate restore size
297   exit       same as done command
298   find       find files, wildcards allowed
299   help       print help
300   ls         list current directory, wildcards allowed
301   lsmark     list the marked files in and below the cd
302   mark       mark dir/file to be restored recursively in dirs
303   markdir    mark directory name to be restored (no files)
304   pwd        print current working directory
305   unmark     unmark dir/file to be restored recursively in dir
306   unmarkdir  unmark directory name only no recursion
307   quit       quit and do not do restore
308   ?          print help
309 \end{verbatim}
310 \normalsize
311
312 As a default no files have been selected for restore (unless you
313 added {\bf all} to the command line. If you want to restore
314 everything, at this point, you should enter {\bf mark *}, and then {\bf done}
315 and {\bf Bacula} will write the bootstrap records to a file and request your
316 approval to start a restore job. 
317
318 If you do not enter the above mentioned {\bf mark *} command, you will start
319 with an empty slate. Now you can simply start looking at the tree and {\bf
320 mark} particular files or directories you want restored. It is easy to make
321 a mistake in specifying a file to mark or unmark, and Bacula's error handling
322 is not perfect, so please check your work by using the {\bf ls} or {\bf dir}
323 commands to see what files are actually selected. Any selected file has its
324 name preceded by an asterisk. 
325
326 To check what is marked or not marked, enter the {\bf count} command, which
327 displays:  
328
329 \footnotesize
330 \begin{verbatim}
331 128401 total files. 128401 marked to be restored.
332      
333 \end{verbatim}
334 \normalsize
335
336 Each of the above commands will be described in more detail in the next
337 section. We continue with the above example, having accepted to restore all
338 files as Bacula set by default. On entering the {\bf done} command, Bacula
339 prints:  
340
341 \footnotesize
342 \begin{verbatim}
343 Bootstrap records written to /home/kern/bacula/working/restore.bsr
344 The restore job will require the following Volumes:
345    
346    DLT-19Jul02
347    DLT-04Aug02
348 128401 files selected to restore.
349 Run Restore job
350 JobName:    kernsrestore
351 Bootstrap:  /home/kern/bacula/working/restore.bsr
352 Where:      /tmp/bacula-restores
353 Replace:    always
354 FileSet:    Kerns Files
355 Client:     Rufus
356 Storage:    SDT-10000
357 JobId:      *None*
358 OK to run? (yes/mod/no):
359     
360 \end{verbatim}
361 \normalsize
362
363 Please examine each of the items very carefully to make sure that they are
364 correct.  In particular, look at {\bf Where}, which tells you where in the
365 directory structure the files will be restored, and {\bf Client}, which
366 tells you which client will receive the files.  Note that by default the
367 Client which will receive the files is the Client that was backed up.
368 These items will not always be completed with the correct values depending
369 on which of the restore options you chose.  You can change any of these
370 default items by entering {\bf mod} and responding to the prompts.
371
372 The above assumes that you have defined a {\bf Restore} Job resource in your
373 Director's configuration file. Normally, you will only need one Restore Job
374 resource definition because by its nature, restoring is a manual operation,
375 and using the Console interface, you will be able to modify the Restore Job to
376 do what you want. 
377
378 An example Restore Job resource definition is given below. 
379
380 Returning to the above example, you should verify that the Client name is
381 correct before running the Job. However, you may want to modify some of the
382 parameters of the restore job. For example, in addition to checking the Client
383 it is wise to check that the Storage device chosen by Bacula is indeed
384 correct. Although the {\bf FileSet} is shown, it will be ignored in restore.
385 The restore will choose the files to be restored either by reading the {\bf
386 Bootstrap} file, or if not specified, it will restore all files associated
387 with the specified backup {\bf JobId} (i.e. the JobId of the Job that
388 originally backed up the files). 
389
390 Finally before running the job, please note that the default location for
391 restoring files is {\bf not} their original locations, but rather the directory
392 {\bf /tmp/bacula-restores}. You can change this default by modifying your {\bf
393 bacula-dir.conf} file, or you can modify it using the {\bf mod} option. If you
394 want to restore the files to their original location, you must have {\bf
395 Where} set to nothing or to the root, i.e. {\bf /}. 
396
397 If you now enter {\bf yes}, Bacula will run the restore Job. The Storage
398 daemon will first request Volume {\bf DLT-19Jul02} and after the appropriate
399 files have been restored from that volume, it will request Volume {\bf
400 DLT-04Aug02}. 
401
402 \subsection*{Selecting Files by Filename}
403 \index[general]{Selecting Files by Filename }
404 \index[general]{Filename!Selecting Files by }
405 \addcontentsline{toc}{subsection}{Selecting Files by Filename}
406
407 If you have a small number of files to restore, and you know the filenames,
408 you can either put the list of filenames in a file to be read by Bacula, or
409 you can enter the names one at a time. The filenames must include the full
410 path and filename. No wild cards are used. 
411
412 To enter the files, after the {\bf restore}, you select item number 7 from the
413 prompt list: 
414
415 \footnotesize
416 \begin{verbatim}
417 To select the JobIds, you have the following choices:
418      1: List last 20 Jobs run
419      2: List Jobs where a given File is saved
420      3: Enter list of comma separated JobIds to select
421      4: Enter SQL list command
422      5: Select the most recent backup for a client
423      6: Select backup for a client before a specified time
424      7: Enter a list of files to restore
425      8: Enter a list of files to restore before a specified time
426      9: Find the JobIds of the most recent backup for a client
427     10: Find the JobIds for a backup for a client before a specified time
428     11: Enter a list of directories to restore for found JobIds
429     12: Cancel
430 Select item:  (1-12):
431 \end{verbatim}
432 \normalsize
433
434 which then prompts you for the client name: 
435
436 \footnotesize
437 \begin{verbatim}
438 Defined Clients:
439      1: Timmy
440      2: Tibs
441      3: Rufus
442 Select the Client (1-3): 3
443 \end{verbatim}
444 \normalsize
445
446 Of course, your client list will be different, and if you have only one
447 client, it will be automatically selected. And finally, Bacula requests you to
448 enter a filename: 
449
450 \footnotesize
451 \begin{verbatim}
452 Enter filename:
453 \end{verbatim}
454 \normalsize
455
456 At this point, you can enter the full path and filename 
457
458 \footnotesize
459 \begin{verbatim}
460 Enter filename: /home/kern/bacula/k/Makefile.in
461 Enter filename:
462 \end{verbatim}
463 \normalsize
464
465 as you can see, it took the filename. If Bacula cannot find a copy of the
466 file, it prints the following: 
467
468 \footnotesize
469 \begin{verbatim}
470 Enter filename: junk filename
471 No database record found for: junk filename
472 Enter filename:
473 \end{verbatim}
474 \normalsize
475
476 If you want Bacula to read the filenames from a file, you simply precede the
477 filename with a less-than symbol (\lt{}). When you have entered all the
478 filenames, you enter a blank line, and Bacula will write the bootstrap file,
479 tells you what tapes will be used, and proposes a Restore job to be run: 
480
481 \footnotesize
482 \begin{verbatim}
483 Enter filename:
484 Automatically selected Storage: DDS-4
485 Bootstrap records written to /home/kern/bacula/working/restore.bsr
486 The restore job will require the following Volumes:
487    
488    test1
489 1 file selected to restore.
490 Run Restore job
491 JobName:    kernsrestore
492 Bootstrap:  /home/kern/bacula/working/restore.bsr
493 Where:      /tmp/bacula-restores
494 Replace:    always
495 FileSet:    Kerns Files
496 Client:     Rufus
497 Storage:    DDS-4
498 When:       2003-09-11 10:20:53
499 Priority:   10
500 OK to run? (yes/mod/no):
501 \end{verbatim}
502 \normalsize
503
504 It is possible to automate the selection by file by putting your list of files
505 in say {\bf /tmp/file-list}, then using the following command: 
506
507 \footnotesize
508 \begin{verbatim}
509 restore client=Rufus file=</tmp/file-list
510 \end{verbatim}
511 \normalsize
512
513 If in modifying the parameters for the Run Restore job, you find that Bacula
514 asks you to enter a Job number, this is because you have not yet specified
515 either a Job number or a Bootstrap file. Simply entering zero will allow you
516 to continue and to select another option to be modified. 
517 \label{CommandArguments}
518
519 \subsection*{Command Line Arguments}
520 \index[general]{Arguments!Command Line }
521 \index[general]{Command Line Arguments }
522 \addcontentsline{toc}{subsection}{Command Line Arguments}
523
524 If all the above sounds complicated, you will probably agree that it really
525 isn't after trying it a few times. It is possible to do everything that was
526 shown above, with the exception of selecting the FileSet, by using command
527 line arguments with a single command by entering: 
528
529 \footnotesize
530 \begin{verbatim}
531 restore client=Rufus select current all done yes
532 \end{verbatim}
533 \normalsize
534
535 The {\bf client=Rufus} specification will automatically select Rufus as the
536 client, the {\bf current} tells Bacula that you want to restore the system to
537 the most current state possible, and the {\bf yes} suppresses the final {\bf
538 yes/mod/no} prompt and simply runs the restore. 
539
540 The full list of possible command line arguments are: 
541
542 \begin{itemize}
543 \item {\bf all} -- select all Files to be restored.  
544 \item {\bf select} -- use the tree selection method.  
545 \item {\bf done} -- do not prompt the user in tree mode.  
546 \item {\bf current} -- automatically select the most current set of  backups
547    for the specified client.  
548 \item {\bf client=xxxx} -- select the specified client.  
549 \item {\bf jobid=nnn} -- specify a JobId or comma separated list of  JobIds to
550    be restored.  
551 \item {\bf before=YYYY-MM-DD HH:MM:SS} -- specify a date and time to  which
552    the system should be restored. Only Jobs started before  the specified
553    date/time will be selected, and as is the case  for {\bf current} Bacula will
554 automatically find the most  recent prior Full save and all Differential and
555 Incremental  saves run before the date you specify. Note, this command is  not
556 too user friendly in that you must specify the date/time  exactly as shown. 
557 \item {\bf file=filename} -- specify a filename to be restored. You  must
558    specify the full path and filename. Prefixing the entry  with a less-than
559 sign
560    (\lt{}) will cause Bacula to assume that the  filename is on your system and
561 contains a list of files to be  restored. Bacula will thus read the list from
562 that file. Multiple  file=xxx specifications may be specified on the command
563 line. 
564 \item {\bf jobid=nnn} -- specify a JobId to be restored. 
565 \item {\bf pool=pool-name} -- specify a Pool name to be used for selection  of
566    Volumes when specifying options 5 and 6 (restore current system,  and restore
567    current system before given date). This permits you to  have several Pools,
568 possibly one offsite, and to select the Pool to  be used for restoring.  
569 \item {\bf yes} -- automatically run the restore without prompting  for
570    modifications (most useful in batch scripts). 
571    \end{itemize}
572
573 \subsection*{Restoring Directory Attributes}
574 \index[general]{Attributes!Restoring Directory }
575 \index[general]{Restoring Directory Attributes }
576 \addcontentsline{toc}{subsection}{Restoring Directory Attributes}
577
578 Depending how you do the restore, you may or may not get the directory entries
579 back to their original state. Here are a few of the problems you can
580 encounter, and for same machine restores, how to avoid them. 
581
582 \begin{itemize}
583 \item You backed up on one machine and are restoring to another that is 
584    either a different OS or doesn't have the same users/groups defined.  Bacula
585    does the best it can in these situations.  
586 \item You are restoring into a directory that is already created and has  file
587    creation restrictions. Bacula tries to reset everything  but without walking
588    up the full chain of directories and modifying  them all during the restore,
589    which Bacula does and will not do,  getting permissions back correctly in
590 this
591    situation depends to a  large extent on your OS.  
592 \item You selected one or more files in a directory, but did not select  the
593    directory entry to be restored. In that case, if the directory  is not on
594 disk
595    Bacula simply creates the directory with some default  attributes which may
596    not be the same as the original.  If you do not select a directory and all
597 its
598    contents to be restored,  you can still select items within the directory to
599    be restored by  individually marking those files, but in that case, you
600 should
601    individually use the "markdir" command to select all higher level 
602    directory entries (one at a time) to be restored if you want the  directory
603    entries properly restored. 
604 \end{itemize}
605
606 \label{Windows}
607
608 \subsection*{Restoring on Windows}
609 \index[general]{Restoring on Windows }
610 \index[general]{Windows!Restoring on }
611 \addcontentsline{toc}{subsection}{Restoring on Windows}
612
613 If you are restoring on WinNT/2K/XP systems, Bacula will restore the files
614 with the original ownerships and permissions as would be expected.  This is
615 also true if you are restoring those files to an alternate directory (using
616 the Where option in restore).  However, if the alternate directory does not
617 already exist, the Bacula File daemon (Client) will try to create it.  In
618 some cases, it may not create the directories, and if it does since the
619 File daemon runs under the SYSTEM account, the directory will be created
620 with SYSTEM ownership and permissions.  In this case, you may have problems
621 accessing the newly restored files.
622
623 To avoid this problem, you should create any alternate directory before
624 doing the restore.  Bacula will not change the ownership and permissions of
625 the directory if it is already created as long as it is not one of the
626 directories being restored (i.e.  written to tape).
627
628 The default restore location is {\bf /tmp/bacula-restores/} and if you are
629 restoring from drive {\bf E:}, the default will be 
630 {\bf /tmp/bacula-restores/e/}, so you should ensure that this directory
631 exists before doing the restore, or use the {\bf mod} option to
632 select a different {\bf where} directory that does exist.
633
634 Some users have experienced problems restoring files that participate in
635 the Active Directory. They also report that changing the userid under which
636 Bacula (bacula-fd.exe) runs, from SYSTEM to a Domain Admin userid, resolves
637 the problem.
638
639
640 \subsection*{Restoring Files Can Be Slow}
641 \index[general]{Slow!Restoring Files Can Be }
642 \index[general]{Restoring Files Can Be Slow }
643 \addcontentsline{toc}{subsection}{Restoring Files Can Be Slow}
644
645 Restoring files is generally {\bf much} slower than backing them up for several
646 reasons. The first is that during a backup the tape is normally already
647 positioned and Bacula only needs to write. On the other hand, because restoring
648 files is done so rarely, Bacula keeps only the start file and block on the
649 tape for the whole job rather than on a file by file basis which would use
650 quite a lot of space in the catalog. 
651
652 Bacula will forward space to the correct file mark on the tape for the Job,
653 then forward space to the correct block, and finally sequentially read each
654 record until it gets to the correct one(s) for the file or files you want to
655 restore. Once the desired files are restored, Bacula will stop reading the
656 tape. 
657
658 Finally, instead of just reading a file for backup, during the restore, Bacula
659 must create the file, and the operating system must allocate disk space for
660 the file as Bacula is restoring it. 
661
662 For all the above reasons the restore process is generally much slower than
663 backing up (sometimes it takes three times as long).
664
665 \subsection*{Problems Restoring Files}
666 \index[general]{Files!Problems Restoring }
667 \index[general]{Problems Restoring Files }
668 \addcontentsline{toc}{subsection}{Problems Restoring Files}
669
670 The most frequent problems users have restoring files are error messages such
671 as: 
672
673 \footnotesize
674 \begin{verbatim}
675 04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
676 block.c:868 Volume data error at 20:0! Short block of 512 bytes on
677 device /dev/tape discarded.
678 \end{verbatim}
679 \normalsize
680
681 or 
682
683 \footnotesize
684 \begin{verbatim}
685 04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
686 block.c:264 Volume data error at 20:0! Wanted ID: "BB02", got ".".
687 Buffer discarded.
688 \end{verbatim}
689 \normalsize
690
691 Both these kinds of messages indicate that you were probably running your tape
692 drive in fixed block mode rather than variable block mode. Fixed block mode
693 will work with any program that reads tapes sequentially such as tar, but
694 Bacula repositions the tape on a block basis when restoring files because this
695 will speed up the restore by orders of magnitude when only a few files are being
696 restored. There are several ways that you can attempt to recover from this
697 unfortunate situation. 
698
699 Try the following things, each separately, and reset your Device resource to
700 what it is now after each individual test: 
701
702 \begin{enumerate}
703 \item Set "Block Positioning = no" in your Device resource  and try the
704    restore. This is a new directive and untested. 
705 \item Set "Minimum Block Size = 512" and "Maximum  Block Size = 512" and
706    try the restore.  Again send me the full job report output.  If you are
707    able to determine the block size your drive was previously using, you
708    should try that size if 512 does not work.
709 \item Try editing the restore.bsr file at the Run xxx yes/mod/no prompt 
710    before starting the restore job and remove all the VolBlock statements.
711    These are what causes Bacula to reposition the tape, and where problems
712    occur if you have a fixed block size set for your drive.  The VolFile
713    commands also cause repositioning, but this will work regardless of the
714    block size.
715 \item Use bextract to extract the files you want -- it reads the  Volume
716    sequentially if you use the include list feature, or if you use a .bsr
717    file, but remove all the VolBlock statements after the .bsr file is
718    created (at the Run yes/mod/no) prompt but before you start the restore.
719 \end{enumerate}
720
721 \subsection*{Example Restore Job Resource}
722 \index[general]{Example Restore Job Resource }
723 \index[general]{Resource!Example Restore Job }
724 \addcontentsline{toc}{subsection}{Example Restore Job Resource}
725
726 \footnotesize
727 \begin{verbatim}
728 Job {
729   Name = "RestoreFiles"
730   Type = Restore
731   Client = Any-client
732   FileSet = "Any-FileSet"
733   Storage = Any-storage
734   Where = /tmp/bacula-restores
735   Messages = Standard
736   Pool = Default
737 }
738 \end{verbatim}
739 \normalsize
740
741 If {\bf Where} is not specified, the default location for restoring files will
742 be their original locations. 
743 \label{Selection}
744
745 \subsection*{File Selection Commands}
746 \index[general]{Commands!File Selection }
747 \index[general]{File Selection Commands }
748 \addcontentsline{toc}{subsection}{File Selection Commands}
749
750 After you have selected the Jobs to be restored and Bacula has created the
751 in-memory directory tree, you will enter file selection mode as indicated by
752 the dollar sign ({\bf \$}) prompt. While in this mode, you may use the
753 commands listed above. The basic idea is to move up and down the in memory
754 directory structure with the {\bf cd} command much as you normally do on the
755 system. Once you are in a directory, you may select the files that you want
756 restored. As a default no files are marked to be restored. If you wish to
757 start with all files, simply enter: {\bf cd /} and {\bf mark *}. Otherwise
758 proceed to select the files you wish to restore by marking them with the {\bf
759 mark} command. The available commands are: 
760
761 \begin{description}
762
763 \item [cd]
764    The {\bf cd} command changes the current directory to  the argument
765    specified.
766    It operates much like the Unix {\bf cd} command.  Wildcard specifications are
767    not permitted.  
768
769    Note, on Windows systems, the various drives (c:, d:, ...) are treated  like
770    a
771    directory within the file tree while in the file  selection mode. As a
772    consequence, you must do a {\bf cd c:} or  possibly in some cases a {\bf cd
773    C:} (note upper case)  to get down to the first directory.  
774
775 \item [dir]
776    \index[dir]{dir }
777    The {\bf dir} command is similar to the {\bf ls} command,  except that it
778    prints it in long format (all details). This command  can be a bit slower
779    than
780    the {\bf ls} command because it must access  the catalog database for the
781    detailed information for each file.  
782
783 \item [estimate]
784    \index[dir]{estimate }
785    The {\bf estimate} command prints a summary of  the total files in the tree,
786    how many are marked to be restored, and  an estimate of the number of bytes
787    to
788    be restored. This can be useful  if you are short on disk space on the
789    machine
790    where the files will be  restored.  
791
792 \item [find]
793    \index[dir]{find }
794    The {\bf find} command accepts one or more arguments  and displays all files
795    in the tree that match that argument. The argument  may have wildcards. It is
796    somewhat similar to the Unix command  {\bf find / -name arg}.  
797
798 \item [ls]
799    The {\bf ls} command produces a listing of all the files  contained in the
800    current directory much like the Unix {\bf ls} command.  You may specify an
801    argument containing wildcards, in which case only  those files will be
802 listed.
803    Any file that is marked to be restored will  have its name preceded by an
804    asterisk ({\bf *}). Directory names  will be terminated with a forward slash
805    ({\bf /}) to distinguish them  from filenames.  
806
807 \item [lsmark]
808    \index[fd]{lsmark }
809    The {\bf lsmark} command is the same as the  {\bf ls} except that it will
810    print only those files marked for  extraction. The other distinction is that
811    it will recursively  descend into any directory selected. 
812
813 \item [mark]
814    \index[dir]{mark }
815    The {\bf mark} command allows you to mark files to be restored. It takes a
816    single argument which is the filename  or directory name in the current
817    directory to be marked for extraction.  The argument may be a wildcard
818    specification, in which  case all files that match in the current directory
819    are marked to be  restored. If the argument matches a directory rather than a
820    file,  then the directory and all the files contained in that directory
821    (recursively)  are marked to be restored. Any marked file will have its name 
822    preceded with an asterisk ({\bf *}) in the output produced by the  {\bf ls}
823 or
824    {\bf dir} commands. Note, supplying a full path on  the mark command does not
825    work as expected to select a file or  directory in the current directory.
826    Also, the {\bf mark} command works  on the current and lower directories but
827    does not touch higher level  directories.  
828
829    After executing the {\bf mark} command, it will print a brief summary:  
830
831 \footnotesize
832 \begin{verbatim}
833     No files marked.
834     
835 \end{verbatim}
836 \normalsize
837
838    If no files were marked, or:  
839
840 \footnotesize
841 \begin{verbatim}
842     nn files marked.
843     
844 \end{verbatim}
845 \normalsize
846
847    if some files are marked.  
848
849 \item [unmark]
850    \index[dir]{unmark }
851    The {\bf unmark} is identical to the {\bf mark}  command, except that it
852    unmarks the specified file or files so that  they will not be restored. Note:
853    the {\bf unmark} command works from  the current directory, so it does not
854    unmark any files at a higher  level. First do a {\bf cd /} before the {\bf
855    unmark *} command if  you want to unmark everything.  
856
857 \item [pwd]
858    \index[dir]{pwd }
859    The {\bf pwd} command prints the current working  directory. It accepts no
860    arguments.  
861
862 \item [count]
863    \index[dir]{count }
864    The {\bf count} command prints the total files in the  directory tree and the
865    number of files marked to be restored.  
866
867 \item [done]
868    \index[dir]{done }
869    This command terminates file selection mode.  
870
871 \item [exit]
872    \index[fd]{exit }
873    This command terminates file selection mode (the same as  done).  
874
875 \item [quit]
876    \index[fd]{quit }
877    This command terminates the file selection and does  not run the restore
878 job. 
879
880
881 \item [help]
882    \index[fd]{help }
883    This command prints a summary of the commands available.  
884
885 \item [?]
886    This command is the same as the {\bf help} command.  
887 \end{description}
888
889 \label{database_restore}
890 \subsection*{Restoring When Things Go Wrong}
891 \index[general]{Restoring When Things Go Wrong }
892 \index[general]{Restoring Your Database}
893 \index[general]{Database!Restoring}
894 \addcontentsline{toc}{subsection}{Restoring When Things Go Wrong}
895
896 This and the following sections will try to present a few of the kinds of
897 problems that can come up making restoring more difficult. I'll try to
898 provide a few ideas how to get out of these problem situations.
899 In addition to what is presented here, there is more specific information
900 on restoring a \ilink{Client}{restore_client} and your
901 \ilink{Server}{restore_server} in the \ilink{Disaster Recovery Using
902 Bacula}{_ChapterRescue} chapter of this manual.
903
904 \begin{description}
905 \item[Problem]
906    My database is broken.
907 \item[Solution]
908    For SQLite, use the vacuum command to try to fix the database. For either
909    MySQL or PostgreSQL, see the vendor's documentation. They have specific tools
910    that check and repair databases.
911
912    Assuming the above does not resolve the problem, you will need to restore
913    or rebuild your catalog.
914 \item[Problem]
915    How do I restore my catalog?
916 \item[Solution]
917    If you have backed up your database nightly (as you should) and you
918    have made a bootstrap file, you can immediately load back your
919    database (or the ASCII SQL output).  Make a copy of your current
920    database, then re-initialize it, by running the following scripts:
921 \begin{verbatim}
922    ./drop_bacula_tables
923    ./make_bacula_tables
924 \end{verbatim}
925    After re-initializing the database, you should be able to run 
926    Bacula. If you now try to use the restore command, it will not 
927    work because the database will be empty. However, you can manually
928    run a restore job and specify your bootstrap file. You do so
929    by entering the {bf run} command in the console and selecting the
930    restore job.  If you are using the default bacula-dir.conf, this
931    Job will be named {\bf RestoreFiles}. Most likely it will prompt
932    you with something such as:
933 \footnotesize
934 \begin{verbatim}
935 Run Restore job
936 JobName:    RestoreFiles
937 Bootstrap:  /home/kern/bacula/working/restore.bsr
938 Where:      /tmp/bacula-restores
939 Replace:    always
940 FileSet:    Full Set
941 Client:     rufus-fd
942 Storage:    File
943 When:       2005-07-10 17:33:40
944 Catalog:    MyCatalog
945 Priority:   10
946 OK to run? (yes/mod/no): 
947 \end{verbatim}
948 \normalsize
949    A number of the items will be different in your case.  What you want to
950    do is: to use the mod option to change the Bootstrap to point to your
951    saved bootstrap file; and to make sure all the other items such as
952    Client, Storage, Catalog, and Where are correct.  The FileSet is not
953    used when you specify a bootstrap file.  Once you have set all the
954    correct values, run the Job and it will restore the backup of your
955    database.  You will then need to follow the instructions for your
956    database type to recreate the database from the ASCII backup file.
957
958       
959 \item[Solution]
960    If you did save your database but did not make a bootstrap file, then
961    recovering the database is more difficult.  You will probably need to
962    use bextract to extract the backup copy.  First you should locate the
963    listing of the job report from the last catalog backup.  It has
964    important information that will allow you to quickly find your database
965    file.  For example, in the job report for the CatalogBackup shown below,
966    the critical items are the Volume name(s), the Volume Session Id and the
967    Volume Session Time.  If you know those, you can easily restore your
968    Catalog.
969 \footnotesize
970 \begin{verbatim}
971
972 22-Apr 10:22 HeadMan: Start Backup JobId 7510,
973 Job=CatalogBackup.2005-04-22_01.10.0
974 22-Apr 10:23 HeadMan: Bacula 1.37.14 (21Apr05): 22-Apr-2005 10:23:06
975   JobId:                  7510
976   Job:                    CatalogBackup.2005-04-22_01.10.00
977   Backup Level:           Full
978   Client:                 Polymatou
979   FileSet:                "CatalogFile" 2003-04-10 01:24:01
980   Pool:                   "Default"
981   Storage:                "DLTDrive"
982   Start time:             22-Apr-2005 10:21:00
983   End time:               22-Apr-2005 10:23:06
984   FD Files Written:       1
985   SD Files Written:       1
986   FD Bytes Written:       210,739,395
987   SD Bytes Written:       210,739,521
988   Rate:                   1672.5 KB/s
989   Software Compression:   None
990   Volume name(s):         DLT-22Apr05
991   Volume Session Id:      11
992   Volume Session Time:    1114075126
993   Last Volume Bytes:      1,428,240,465
994   Non-fatal FD errors:    0
995   SD Errors:              0
996   FD termination status:  OK
997   SD termination status:  OK
998   Termination:            Backup OK
999
1000 \end{verbatim}
1001 \normalsize
1002   From the above information, you can manually create a bootstrap file,
1003   and then follow the instructions given above for restoring your database.
1004   A reconstructed bootstrap file for the above backup Job would look
1005   like the following:
1006 \footnotesize
1007 \begin{verbatim}
1008 Volume="DLT-22Apr05"
1009 VolSessionId=11
1010 VolSessionTime=1114075126
1011 FileIndex=1-1
1012 \end{verbatim}
1013 \normalsize    
1014   Where we have inserted the Volume name, Volume Session Id, and Volume
1015   Session Time that correspond to the values in the job report.  We've also
1016   used a FileIndex of one, which will always be the case providing that
1017   there was only one file backed up in the job.
1018   
1019   The disadvantage of this bootstrap file compared to what is created when
1020   you ask for one to be written, is that there is no File and Block
1021   specified, so the restore code must search all data in the Volume to find
1022   the requested file.  A fully specified bootstrap file would have the File
1023   and Blocks specified as follows:
1024 \footnotesize
1025 \begin{verbatim}
1026 Volume="DLT-22Apr05"
1027 VolSessionId=11
1028 VolSessionTime=1114075126
1029 VolFile=118-118
1030 VolBlock=0-4053
1031 FileIndex=1-1
1032 \end{verbatim}
1033 \normalsize
1034
1035 \item [Problem]
1036    I try to restore the last known good full backup by specifying
1037    item 3 on the restore menu then the JobId to restore.  Bacula 
1038    then reports:
1039
1040 \footnotesize
1041 \begin{verbatim}
1042    1 Job 0 Files
1043 \end{verbatim}
1044 \normalsize
1045    and restores nothing.
1046 \item[Solution]
1047    Most likely the File records were pruned from the database either due
1048    to the File Retention period expiring or by explicitly purging the
1049    Job. By using the "llist jobid=nn" command, you can obtain all the
1050    important information about the job:
1051 \footnotesize
1052 \begin{verbatim}
1053 llist jobid=120
1054            JobId: 120
1055              Job: save.2005-12-05_18.27.33
1056         Job.Name: save
1057      PurgedFiles: 0
1058             Type: B
1059            Level: F
1060     Job.ClientId: 1
1061      Client.Name: Rufus
1062        JobStatus: T
1063        SchedTime: 2005-12-05 18:27:32
1064        StartTime: 2005-12-05 18:27:35
1065          EndTime: 2005-12-05 18:27:37
1066         JobTDate: 1133803657
1067     VolSessionId: 1
1068   VolSessionTime: 1133803624
1069         JobFiles: 236
1070        JobErrors: 0
1071  JobMissingFiles: 0
1072       Job.PoolId: 4
1073        Pool.Name: Full
1074    Job.FileSetId: 1
1075  FileSet.FileSet: BackupSet
1076 \end{verbatim}
1077 \normalsize
1078
1079    Then you can find the Volume(s) used by doing:
1080 \footnotesize
1081 \begin{verbatim}
1082 sql
1083 select VolumeName from JobMedia,Media where JobId=1 and JobMedia.MediaId=Media.MediaId;
1084 \end{verbatim}
1085 \normalsize
1086    Finally, you can create a bootstrap file as described in the previous
1087    problem above using this information.
1088
1089    If you are using Bacula version 1.38.0 or greater, when you select
1090    item 3 from the menu and enter the JobId, it will ask you if
1091    you would like to restore all the files in the job, and it will
1092    collect the above information and write the bootstrap file for
1093    you.
1094
1095 \item [Problem]
1096   You don't have a bootstrap file, and you don't have the Job report for
1097   the backup of your database, but you did backup the database, and you
1098   know the Volume to which it was backed up.
1099   
1100 \item [Solution]
1101   Use {\bf bls} to indicate where it is on the tape. For example:
1102
1103 \footnotesize
1104 \begin{verbatim}
1105 ./bls -j -V DLT-22Apr05 /dev/nst0
1106 \end{verbatim}
1107 \normalsize
1108   Might produce the following output:
1109 \footnotesize
1110 \begin{verbatim}
1111 bls: butil.c:258 Using device: "/dev/nst0" for reading.
1112 21-Jul 18:34 bls: Ready to read from volume "DLT-22Apr05" on device "DLTDrive"
1113 (/dev/nst0).
1114 Volume Record: File:blk=0:0 SessId=11 SessTime=1114075126 JobId=0 DataLen=164
1115 ...
1116 Begin Job Session Record: File:blk=118:0 SessId=11 SessTime=1114075126
1117 JobId=7510
1118    Job=CatalogBackup.2005-04-22_01.10.0 Date=22-Apr-2005 10:21:00 Level=F Type=B
1119 End Job Session Record: File:blk=118:4053 SessId=11 SessTime=1114075126
1120 JobId=7510
1121    Date=22-Apr-2005 10:23:06 Level=F Type=B Files=1 Bytes=210,739,395 Errors=0
1122 Status=T
1123 ...
1124 21-Jul 18:34 bls: End of Volume at file 201 on device "DLTDrive" (/dev/nst0),
1125 Volume "DLT-22Apr05"
1126 21-Jul 18:34 bls: End of all volumes.
1127 \end{verbatim}
1128 \normalsize
1129   Of course, there will be many more records printed, but we have indicated
1130   the essential lines of output. From the information on the Begin Job and End 
1131   Job Session Records, you can reconstruct a bootstrap file such as the one
1132   shown above.
1133
1134 \item[Problem]
1135   How can I find where a file is stored.
1136 \item[Solution]
1137   Normally, it is not necessary, you just use the {\bf restore} command to
1138   restore the most recently saved version (menu option 5), or a version
1139   saved before a given date (menu option 8).  If you know the JobId of the
1140   job in which it was saved, you can use menu option 3 to enter that JobId.
1141
1142   If you would like to know the JobId where a file was saved, select
1143   restore menu option 2.
1144
1145   You can also use the {\bf query} command to find information such as: 
1146 \footnotesize
1147 \begin{verbatim}
1148 *query
1149 Available queries:
1150      1: List Job totals:
1151      2: List up to 20 places where a File is saved regardless of the directory:
1152      3: List where the most recent copies of a file are saved:
1153      4: List last 20 Full Backups for a Client:
1154      5: List all backups for a Client after a specified time
1155      6: List all backups for a Client
1156      7: List Volume Attributes for a selected Volume:
1157      8: List Volumes used by selected JobId:
1158      9: List Volumes to Restore All Files:
1159     10: List Pool Attributes for a selected Pool:
1160     11: List total files/bytes by Job:
1161     12: List total files/bytes by Volume:
1162     13: List Files for a selected JobId:
1163     14: List Jobs stored in a selected MediaId:
1164     15: List Jobs stored for a given Volume name:
1165 Choose a query (1-15):
1166 \end{verbatim}
1167 \normalsize
1168
1169
1170 \end{description}