4 \section*{The Bootstrap File}
5 \label{_ChapterStart43}
6 \index[general]{File!Bootstrap }
7 \index[general]{Bootstrap File }
8 \addcontentsline{toc}{section}{Bootstrap File}
10 The information in this chapter is provided so that you may either create your
11 own bootstrap files, or so that you can edit a bootstrap file produced by {\bf
12 Bacula}. However, normally the bootstrap file will be automatically created
14 \ilink{restore}{_ChapterStart13} command in the Console program, or
16 \ilink{ Write Bootstrap}{writebootstrap} record in your Backup
17 Jobs, and thus you will never need to know the details of this file.
19 The {\bf bootstrap} file contains ASCII information that permits precise
20 specification of what files should be restored. It is a relatively compact
21 form of specifying the information, is human readable, and can be edited with
24 \subsection*{File Format}
25 \index[general]{Format!File }
26 \index[general]{File Format }
27 \addcontentsline{toc}{subsection}{File Format}
29 The general format of a {\bf bootstrap} file is:
31 {\bf \lt{}keyword\gt{}= \lt{}value\gt{}}
33 Where each {\bf keyword} and the {\bf value} specify which files to restore.
34 More precisely the {\bf keyword} and their {\bf values} serve to limit which
35 files will be restored and thus act as a filter. The absence of a keyword
36 means that all records will be accepted.
38 Blank lines and lines beginning with a pound sign (\#) in the bootstrap file
41 There are keywords which permit filtering by Volume, Client, Job, FileIndex,
42 Session Id, Session Time, ...
44 The more keywords that are specified, the more selective the specification of
45 which files to restore will be. In fact, each keyword is {\bf AND}ed with
46 other keywords that may be present.
54 VolSessionTime = 108927638
58 directs the Storage daemon (or the {\bf bextract} program) to restore only
59 those files on Volume Test-001 {\bf AND} having VolumeSessionId equal to one
60 {\bf AND} having VolumeSession time equal to 108927638.
62 The full set of permitted keywords presented in the order in which they are
63 matched against the Volume records are:
69 The value field specifies what Volume the following commands apply to. Each
70 Volume specification becomes the current Volume, to which all the following
71 commands apply until a new current Volume (if any) is specified. If the
72 Volume name contains spaces, it should be enclosed in quotes.
76 The value is the total number of files that will be restored for this Volume.
77 This allows the Storage daemon to know when to stop reading the Volume.
81 The value is a file number, a list of file numbers, or a range of file
82 numbers numbers to match on the current Volume. The file number represents
83 the physical file on the Volume where the data is stored. For a tape volume,
84 this record is used to position to the correct starting file, and once the
85 tape is past the last specified file, reading will stop.
89 The value is a block number, a list of block numbers, or a range of block
90 numbers numbers to match on the current Volume. The block number represents
91 the physical block on the Volume where the data is stored. This record is
94 \item [VolSessionTime]
95 \index[fd]{VolSessionTime }
96 The value specifies a Volume Session Time to be matched from the current
100 \index[fd]{VolSessionId }
101 The value specifies a VolSessionId, a list of volume session ids, or a range
102 of volume session ids to be matched from the current Volume. Each
103 VolSessionId and VolSessionTime pair corresponds to a unique Job that is
104 backed up on the Volume.
108 The value specifies a JobId, list of JobIds, or range of JobIds to be
109 selected from the current Volume. Note, the JobId may not be unique if you
110 have multiple Directors, or if you have reinitialized your database. The
111 JobId filter works only if you do not run multiple simultaneous jobs.
115 The value specifies a Job name or list of Job names to be matched on the
116 current Volume. The Job corresponds to a unique VolSessionId and
117 VolSessionTime pair. However, the Job is perhaps a bit more readable by
118 humans. Standard regular expressions (wildcards) may be used to match Job
119 names. The Job filter works only if you do not run multiple simultaneous
124 The value specifies a Client name or list of Clients to will be matched on
125 the current Volume. Standard regular expressions (wildcards) may be used to
126 match Client names. The Client filter works only if you do not run multiple
130 \index[fd]{FileIndex }
131 The value specifies a FileIndex, list of FileIndexes, or range of FileIndexes
132 to be selected from the current Volume. Each file (data) stored on a Volume
133 within a Session has a unique FileIndex. For each Session, the first file
134 written is assigned FileIndex equal to one and incremented for each file
137 This for a given Volume, the triple VolSessionId, VolSessionTime, and
138 FileIndex uniquely identifies a file stored on the Volume. Multiple copies of
139 the same file may be stored on the same Volume, but for each file, the triple
140 VolSessionId, VolSessionTime, and FileIndex will be unique. This triple is
141 stored in the Catalog database for each file.
145 The value specifies the autochanger slot. There may be only a single {\bf
146 Slot} specification for each Volume.
150 The value specifies a Stream, a list of Streams, or a range of Streams to be
151 selected from the current Volume. Unless you really know what you are doing
152 (the internals of {\bf Bacula}, you should avoid this specification.
155 \index[fd]{*JobType }
159 \index[fd]{*JobLevel }
163 The {\bf Volume} record is a bit special in that it must be the first record.
164 The other keyword records may appear in any order and any number following a
167 Multiple Volume records may be specified in the same bootstrap file, but each
168 one starts a new set of filter criteria for the Volume.
170 In processing the bootstrap file within the current Volume, each filter
171 specified by a keyword is {\bf AND}ed with the next. Thus,
176 Client = "My machine"
181 will match records on Volume {\bf Test-01} {\bf AND} Client records for {\bf
182 My machine} {\bf AND} FileIndex equal to {\bf one}.
184 Multiple occurrences of the same record are {\bf OR}ed together. Thus,
189 Client = "My machine"
190 Client = "Backup machine"
195 will match records on Volume {\bf Test-01} {\bf AND} (Client records for {\bf
196 My machine} {\bf OR} {\bf Backup machine}) {\bf AND} FileIndex equal to {\bf
199 For integer values, you may supply a range or a list, and for all other values
200 except Volumes, you may specify a list. A list is equivalent to multiple
201 records of the same keyword. For example,
206 Client = "My machine", "Backup machine"
211 will match records on Volume {\bf Test-01} {\bf AND} {\bf (}Client records for
212 {\bf My machine} {\bf OR} {\bf Backup machine}{\bf )} {\bf AND} {\bf
213 (}FileIndex 1 {\bf OR} 2 {\bf OR} 3 ... {\bf OR} 20 {\bf OR} 35{\bf )}.
215 As previously mentioned above, there may be multiple Volume records in the
216 same bootstrap file. Each new Volume definition begins a new set of filter
217 conditions that apply to that Volume and will be {\bf OR}ed with any other
220 As an example, suppose we query for the current set of tapes to restore all
221 files on Client {\bf Rufus} using the {\bf query} command in the console
226 Using default Catalog name=MySQL DB=bacula
230 2: List where a file is saved:
231 3: List where the most recent copies of a file are saved:
232 4: List total files/bytes by Job:
233 5: List total files/bytes by Volume:
234 6: List last 10 Full Backups for a Client:
235 7: List Volumes used by selected JobId:
236 8: List Volumes to Restore All Files:
237 Choose a query (1-8): 8
238 Enter Client Name: Rufus
239 +-------+------------------+------------+-----------+----------+------------+
240 | JobId | StartTime | VolumeName | StartFile | VolSesId | VolSesTime |
241 +-------+------------------+------------+-----------+----------+------------+
242 | 154 | 2002-05-30 12:08 | test-02 | 0 | 1 | 1022753312 |
243 | 202 | 2002-06-15 10:16 | test-02 | 0 | 2 | 1024128917 |
244 | 203 | 2002-06-15 11:12 | test-02 | 3 | 1 | 1024132350 |
245 | 204 | 2002-06-18 08:11 | test-02 | 4 | 1 | 1024380678 |
246 +-------+------------------+------------+-----------+----------+------------+
250 The output shows us that there are four Jobs that must be restored. The first
251 one is a Full backup, and the following three are all Incremental backups.
253 The following bootstrap file will restore those files:
259 VolSessionTime=1022753312
262 VolSessionTime=1024128917
265 VolSessionTime=1024132350
268 VolSessionTime=1024380678
272 As a final example, assume that the initial Full save spanned two Volumes. The
273 output from {\bf query} might look like:
277 +-------+------------------+------------+-----------+----------+------------+
278 | JobId | StartTime | VolumeName | StartFile | VolSesId | VolSesTime |
279 +-------+------------------+------------+-----------+----------+------------+
280 | 242 | 2002-06-25 16:50 | File0003 | 0 | 1 | 1025016612 |
281 | 242 | 2002-06-25 16:50 | File0004 | 0 | 1 | 1025016612 |
282 | 243 | 2002-06-25 16:52 | File0005 | 0 | 2 | 1025016612 |
283 | 246 | 2002-06-25 19:19 | File0006 | 0 | 2 | 1025025494 |
284 +-------+------------------+------------+-----------+----------+------------+
288 and the following bootstrap file would restore those files:
294 VolSessionTime=1025016612
297 VolSessionTime=1025016612
300 VolSessionTime=1025016612
303 VolSessionTime=1025025494
307 \subsection*{Automatic Generation of Bootstrap Files}
308 \index[general]{Files!Automatic Generation of Bootstrap }
309 \index[general]{Automatic Generation of Bootstrap Files }
310 \addcontentsline{toc}{subsection}{Automatic Generation of Bootstrap Files}
312 One thing that is probably worth knowing: the bootstrap files that are
313 generated automatically at the end of the job are not as optimized as those
314 generated by the restore command. This is because the ones created at the end
315 of the file, contain all files written to the Volume for that job. As a
316 consequence, all the files saved to an Incremental or Differential job will be
317 restored first by the Full save, then by any Incremental or Differential
320 When the bootstrap file is generated for the restore command, only one copy
321 (the most recent) of each file is restored.
323 So if you have spare cycles on your machine, you could optimize the bootstrap
324 files by doing the following:
329 restore client=xxx select all
332 Backup bootstrap file.
336 The above will not work if you have multiple FileSets because that will be an
337 extra prompt. However, the {\bf restore client=xxx select all} builds the
338 in-memory tree, selecting everything and creates the bootstrap file.
340 The {\bf no} answers the {\bf Do you want to run this (yes/mod/no)} question.
342 \subsection*{A Final Example}
343 \index[general]{Example!Final }
344 \index[general]{Final Example }
345 \addcontentsline{toc}{subsection}{Final Example}
347 If you want to extract or copy a single Job, you can do it by selecting by
348 JobId (code not tested) or better yet, if you know the VolSessionTime and the
349 VolSessionId (printed on Job report and in Catalog), specifying this is by far
350 the best. Using the VolSessionTime and VolSessionId is the way Bacula does
351 restores. A bsr file might look like the following:
357 VolSessionTime=1080847820
361 If you know how many files are backed up (on the job report), you can
362 enormously speed up the selection by adding (let's assume there are 157
372 Finally, if you know the File number where the Job starts, you can also cause
373 bcopy to forward space to the right file without reading every record:
381 There is nothing magic or complicated about a BSR file. Parsing it and
382 properly applying it within Bacula *is* magic, but you don't need to worry
385 If you want to see a *real* bsr file, simply fire up the {\bf restore} command
386 in the console program, select something, then answer no when it prompts to
387 run the job. Then look at the file {\bf restore.bsr} in your working
projects / bacula / docs / blob