4 \section*{Configuring the Director}
5 \label{_ChapterStart40}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
8 \addcontentsline{toc}{section}{Configuring the Director}
10 Of all the configuration files needed to run {\bf Bacula}, the Director's is
11 the most complicated, and the one that you will need to modify the most often
12 as you add clients or modify the FileSets.
14 For a general discussion of configuration files and resources including the
15 data types recognized by {\bf Bacula}. Please see the
16 \ilink{Configuration}{_ChapterStart16} chapter of this manual.
18 \subsection*{Director Resource Types}
19 \index[general]{Types!Director Resource}
20 \index[general]{Director Resource Types}
21 \addcontentsline{toc}{subsection}{Director Resource Types}
23 Director resource type may be one of the following:
25 Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
26 Messages. We present them here in the most logical order for defining them:
30 \ilink{Director}{DirectorResource4} -- to define the Director's
31 name and its access password used for authenticating the Console program.
32 Only a single Director resource definition may appear in the Director's
33 configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
34 machine, Bacula will generate a random password during the configuration
35 process, otherwise it will be left blank.
37 \ilink{Job}{JobResource} -- to define the backup/restore Jobs
38 and to tie together the Client, FileSet and Schedule resources to be used
41 \ilink{JobDefs}{JobDefsResource} -- optional resource for
42 providing defaults for Job resources.
44 \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
45 be automatically run by {\bf Bacula's} internal scheduler.
47 \ilink{FileSet}{FileSetResource} -- to define the set of files
48 to be backed up for each Client.
50 \ilink{Client}{ClientResource2} -- to define what Client is to be
53 \ilink{Storage}{StorageResource2} -- to define on what physical
54 device the Volumes should be mounted.
56 \ilink{Pool}{PoolResource} -- to define the pool of Volumes
57 that can be used for a particular Job.
59 \ilink{Catalog}{CatalogResource} -- to define in what database to
60 keep the list of files and the Volume names where they are backed up.
62 \ilink{Messages}{_ChapterStart15} -- to define where error and
63 information messages are to be sent or logged.
66 \subsection*{The Director Resource}
67 \label{DirectorResource4}
68 \index[general]{Director Resource}
69 \index[general]{Resource!Director}
70 \addcontentsline{toc}{subsection}{Director Resource}
72 The Director resource defines the attributes of the Directors running on the
73 network. In the current implementation, there is only a single Director
74 resource, but the final design will contain multiple Directors to maintain
75 index and media database redundancy.
81 Start of the Director resource. One and only one director resource must be
84 \item [Name = \lt{}name\gt{}]
86 \index[dir]{Directive!Name}
87 The director name used by the system administrator. This directive is
90 \item [Description = \lt{}text\gt{}]
91 \index[dir]{Description}
92 \index[dir]{Directive!Description}
93 The text field contains a description of the Director that will be displayed
94 in the graphical user interface. This directive is optional.
96 \item [Password = \lt{}UA-password\gt{}]
98 \index[dir]{Directive!Password}
99 Specifies the password that must be supplied for the default Bacula Console
100 to be authorized. The same password must appear in the {\bf Director}
101 resource of the Console configuration file. For added security, the password
102 is never actually passed across the network but rather a challenge response
103 hash code created with the password. This directive is required. If you have
104 either {\bf /dev/random} or {\bf bc} on your machine, Bacula will generate a
105 random password during the configuration process, otherwise it will be left
106 blank and you must manually supply it.
108 \item [Messages = \lt{}Messages-resource-name\gt{}]
109 \index[dir]{Messages}
110 \index[dir]{Directive!Messages}
111 The messages resource specifies where to deliver Director messages that are
112 not associated with a specific Job. Most messages are specific to a job and
113 will be directed to the Messages resource specified by the job. However,
114 there are a few messages that can occur when no job is running. This
115 directive is required.
117 \item [Working Directory = \lt{}Directory\gt{}]
118 \index[dir]{Working Directory}
119 \index[dir]{Directive!Working Directory}
120 This directive is mandatory and specifies a directory in which the Director
121 may put its status files. This directory should be used only by Bacula but
122 may be shared by other Bacula daemons. However, please note, if this
123 directory is shared with other Bacula daemons (the File daemon and Storage
124 daemon), you must ensure that the {\bf Name} given to each daemon is
125 unique so that the temporary filenames used do not collide. By default
126 the Bacula configure process creates unique daemon names by postfixing them
127 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
128 Directory} is done when the configuration file is read so that values such
129 as {\bf \$HOME} will be properly expanded. This directive is required.
131 If you have specified a Director user and/or a Director group on your
132 ./configure line with {\bf {-}{-}with-dir-user} and/or
133 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
134 be set to those values.
136 \item [Pid Directory = \lt{}Directory\gt{}]
137 \index[dir]{Pid Directory}
138 \index[dir]{Directive!Pid Directory}
139 This directive is mandatory and specifies a directory in which the Director
140 may put its process Id file. The process Id file is used to shutdown
141 Bacula and to prevent multiple copies of Bacula from running simultaneously.
142 Standard shell expansion of the {\bf Directory} is done when the
143 configuration file is read so that values such as {\bf \$HOME} will be
146 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
147 not installing Bacula in the system directories, you can use the {\bf Working
148 Directory} as defined above. This directive is required.
150 \item [Scripts Directory = \lt{}Directory\gt{}]
151 \index[dir]{Scripts Directory}
152 \index[dir]{Directive!Scripts Directory}
153 This directive is optional and, if defined, specifies a directory in
154 which the Director will look for the Python startup script {\bf
155 DirStartup.py}. This directory may be shared by other Bacula daemons.
156 Standard shell expansion of the directory is done when the configuration
157 file is read so that values such as {\bf \$HOME} will be properly
160 \item [QueryFile = \lt{}Path\gt{}]
161 \index[dir]{QueryFile}
162 \index[dir]{Directive!QueryFile}
163 This directive is mandatory and specifies a directory and file in which
164 the Director can find the canned SQL statements for the {\bf Query}
165 command of the Console. Standard shell expansion of the {\bf Path} is
166 done when the configuration file is read so that values such as {\bf
167 \$HOME} will be properly expanded. This directive is required.
169 \label{DirMaxConJobs}
170 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
171 \index[dir]{Maximum Concurrent Jobs}
172 \index[dir]{Directive!Maximum Concurrent Jobs}
173 \index[general]{Simultaneous Jobs}
174 \index[general]{Concurrent Jobs}
175 where \lt{}number\gt{} is the maximum number of total Director Jobs that
176 should run concurrently. The default is set to 1, but you may set it to a
179 Please note that the Volume format becomes much more complicated with
180 multiple simultaneous jobs, consequently, restores can take much longer if
181 Bacula must sort through interleaved volume blocks from multiple simultaneous
182 jobs. This can be avoided by having each simultaneously running job write to
183 a different volume or by using data spooling, which will first spool the data
184 to disk simultaneously, then write each spool file to the volume in
187 There may also still be some cases where directives such as {\bf Maximum
188 Volume Jobs} are not properly synchronized with multiple simultaneous jobs
189 (subtle timing issues can arise), so careful testing is recommended.
191 At the current time, there is no configuration parameter set to limit the
192 number of console connections. A maximum of five simultaneous console
193 connections are permitted.
195 For more details on getting concurrent jobs to run, please see
196 \ilink{Running Concurrent Jobs}{ConcurrentJobs} in the Tips chapter
199 \item [FD Connect Timeout = \lt{}time\gt{}]
200 \index[dir]{FD Connect Timeout}
201 \index[dir]{Directive!FD Connect Timeout}
202 where {\bf time} is the time that the Director should continue
203 attempting to contact the File daemon to start a job, and after which
204 the Director will cancel the job. The default is 30 minutes.
206 \item [SD Connect Timeout = \lt{}time\gt{}]
207 \index[dir]{SD Connect Timeout}
208 \index[dir]{Directive!SD Connect Timeout}
209 where {\bf time} is the time that the Director should continue
210 attempting to contact the Storage daemon to start a job, and after which
211 the Director will cancel the job. The default is 30 minutes.
213 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
214 \index[dir]{DirAddresses}
215 \index[dir]{Directive!DirAddresses}
216 Specify the ports and addresses on which the Director daemon will listen
217 for Bacula Console connections. Probably the simplest way to explain
218 this is to show an example:
222 DirAddresses = { ip = {
223 addr = 1.2.3.4; port = 1205;}
225 addr = 1.2.3.4; port = http;}
238 addr = 201:220:222::2
241 addr = bluedot.thun.net
247 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
248 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
249 a symbolic name (only in the ip specification). Also, port can be specified
250 as a number or as the mnemonic value from the /etc/services file. If a port
251 is not specified, the default will be used. If an ip section is specified,
252 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
253 only IPv4 resolutions will be permitted, and likewise with ip6.
255 Please note that if you use the DirAddresses directive, you must
256 not use either a DirPort or a DirAddress directive in the same
259 \item [DIRport = \lt{}port-number\gt{}]
261 \index[dir]{Directive!DIRport}
262 Specify the port (a positive integer) on which the Director daemon will
263 listen for Bacula Console connections. This same port number must be
264 specified in the Director resource of the Console configuration file. The
265 default is 9101, so normally this directive need not be specified. This
266 directive is not needed if you specify DirAddresses.
268 \item [DirAddress = \lt{}IP-Address\gt{}]
269 \index[dir]{DirAddress}
270 \index[dir]{Directive!DirAddress}
271 This directive is optional, but if it is specified, it will cause the
272 Director server (for the Console program) to bind to the specified {\bf
273 IP-Address}, which is either a domain name or an IP address specified as a
274 dotted quadruple in string or quoted string format. If this directive is not
275 specified, the Director will bind to any available address (the default).
276 Note, unlike the DirAddresses specification noted above, this directive only
277 permits a single address to be specified. This directive is not needed if you
278 specify a DirAddresses (not plural).
281 The following is an example of a valid Director resource definition:
287 WorkingDirectory = "$HOME/bacula/bin/working"
288 Password = UA_password
289 PidDirectory = "$HOME/bacula/bin/working"
290 QueryFile = "$HOME/bacula/bin/query.sql"
296 \subsection*{The Job Resource}
298 \index[general]{Resource!Job}
299 \index[general]{Job Resource}
300 \addcontentsline{toc}{subsection}{Job Resource}
302 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
303 perform. Each Job resource definition contains the name of a Client and
304 a FileSet to backup, the Schedule for the Job, where the data
305 are to be stored, and what media Pool can be used. In effect, each Job
306 resource must specify What, Where, How, and When or FileSet, Storage,
307 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
308 be specified for a restore job for historical reasons, but it is no longer used.
310 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
311 job. If you want to backup multiple FileSets on the same Client or multiple
312 Clients, you must define a Job for each one.
318 \index[dir]{Directive!Job}
319 Start of the Job resource. At least one Job resource is required.
321 \item [Name = \lt{}name\gt{}]
323 \index[dir]{Directive!Name}
324 The Job name. This name can be specified on the {\bf Run} command in the
325 console program to start a job. If the name contains spaces, it must be
326 specified between quotes. It is generally a good idea to give your job the
327 same name as the Client that it will backup. This permits easy
328 identification of jobs.
330 When the job actually runs, the unique Job Name will consist of the name you
331 specify here followed by the date and time the job was scheduled for
332 execution. This directive is required.
334 \item [Enabled = \lt{}yes|no\gt{}]
336 \index[dir]{Directive!Enable}
337 This directive allows you to enable or disable automatic execution
338 via the scheduler of a Job.
340 \item [Type = \lt{}job-type\gt{}]
342 \index[dir]{Directive!Type}
343 The {\bf Type} directive specifies the Job type, which may be one of the
344 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
345 directive is required. Within a particular Job Type, there are also Levels
346 as discussed in the next item.
352 Run a backup Job. Normally you will have at least one Backup job for each
353 client you want to save. Normally, unless you turn off cataloging, most all
354 the important statistics and data concerning files backed up will be placed
359 Run a restore Job. Normally, you will specify only one Restore job which
361 as a sort of prototype that you will modify using the console program in
362 order to perform restores. Although certain basic information from a Restore
363 job is saved in the catalog, it is very minimal compared to the information
364 stored for a Backup job -- for example, no File database entries are
365 generated since no Files are saved.
369 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
370 contents of the catalog to the file system, or to what was backed up. In
371 addition, to verifying that a tape that was written can be read, you can
372 also use {\bf verify} as a sort of tripwire intrusion detection.
376 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
377 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
378 Although an Admin job is recorded in the catalog, very little data is saved.
383 \item [Level = \lt{}job-level\gt{}]
385 \index[dir]{Directive!Level}
386 The Level directive specifies the default Job level to be run. Each
387 different Job Type (Backup, Restore, ...) has a different set of Levels
388 that can be specified. The Level is normally overridden by a different
389 value that is specified in the {\bf Schedule} resource. This directive
390 is not required, but must be specified either by a {\bf Level} directive
391 or as an override specified in the {\bf Schedule} resource.
393 For a {\bf Backup} Job, the Level may be one of the following:
399 When the Level is set to Full all files in the FileSet whether or not
400 they have changed will be backed up.
403 \index[dir]{Incremental}
404 When the Level is set to Incremental all files specified in the FileSet
405 that have changed since the last successful backup of the the same Job
406 using the same FileSet and Client, will be backed up. If the Director
407 cannot find a previous valid Full backup then the job will be upgraded
408 into a Full backup. When the Director looks for a valid backup record
409 in the catalog database, it looks for a previous Job with:
412 \item The same Job name.
413 \item The same Client name.
414 \item The same FileSet (any change to the definition of the FileSet such as
415 adding or deleting a file in the Include or Exclude sections constitutes a
417 \item The Job was a Full, Differential, or Incremental backup.
418 \item The Job terminated normally (i.e. did not fail or was not canceled).
421 If all the above conditions do not hold, the Director will upgrade the
422 Incremental to a Full save. Otherwise, the Incremental backup will be
423 performed as requested.
425 The File daemon (Client) decides which files to backup for an
426 Incremental backup by comparing start time of the prior Job (Full,
427 Differential, or Incremental) against the time each file was last
428 "modified" (st\_mtime) and the time its attributes were last
429 "changed"(st\_ctime). If the file was modified or its attributes
430 changed on or after this start time, it will then be backed up.
432 Some virus scanning software may change st\_ctime while
433 doing the scan. For example, if the virus scanning program attempts to
434 reset the access time (st\_atime), which Bacula does not use, it will
435 cause st\_ctime to change and hence Bacula will backup the file during
436 an Incremental or Differential backup. In the case of Sophos virus
437 scanning, you can prevent it from resetting the access time (st\_atime)
438 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
439 option. For other software, please see their manual.
441 When Bacula does an Incremental backup, all modified files that are
442 still on the system are backed up. However, any file that has been
443 deleted since the last Full backup remains in the Bacula catalog, which
444 means that if between a Full save and the time you do a restore, some
445 files are deleted, those deleted files will also be restored. The
446 deleted files will no longer appear in the catalog after doing another
447 Full save. However, to remove deleted files from the catalog during an
448 Incremental backup is quite a time consuming process and not currently
449 implemented in Bacula.
451 In addition, if you move a directory rather than copy it, the files in
452 it do not have their modification time (st\_mtime) or their attribute
453 change time (st\_ctime) changed. As a consequence, those files will
454 probably not be backed up by an Incremental or Differential backup which
455 depend solely on these time stamps. If you move a directory, and wish
456 it to be properly backed up, it is generally preferable to copy it, then
460 \index[dir]{Differential}
461 When the Level is set to Differential
462 all files specified in the FileSet that have changed since the last
463 successful Full backup of the same Job will be backed up.
464 If the Director cannot find a
465 valid previous Full backup for the same Job, FileSet, and Client,
466 backup, then the Differential job will be upgraded into a Full backup.
467 When the Director looks for a valid Full backup record in the catalog
468 database, it looks for a previous Job with:
471 \item The same Job name.
472 \item The same Client name.
473 \item The same FileSet (any change to the definition of the FileSet such as
474 adding or deleting a file in the Include or Exclude sections constitutes a
476 \item The Job was a FULL backup.
477 \item The Job terminated normally (i.e. did not fail or was not canceled).
480 If all the above conditions do not hold, the Director will upgrade the
481 Differential to a Full save. Otherwise, the Differential backup will be
482 performed as requested.
484 The File daemon (Client) decides which files to backup for a
485 differential backup by comparing the start time of the prior Full backup
486 Job against the time each file was last "modified" (st\_mtime) and the
487 time its attributes were last "changed" (st\_ctime). If the file was
488 modified or its attributes were changed on or after this start time, it
489 will then be backed up. The start time used is displayed after the {\bf
490 Since} on the Job report. In rare cases, using the start time of the
491 prior backup may cause some files to be backed up twice, but it ensures
492 that no change is missed. As with the Incremental option, you should
493 ensure that the clocks on your server and client are synchronized or as
494 close as possible to avoid the possibility of a file being skipped.
495 Note, on versions 1.33 or greater Bacula automatically makes the
496 necessary adjustments to the time between the server and the client so
497 that the times Bacula uses are synchronized.
499 When Bacula does a Differential backup, all modified files that are
500 still on the system are backed up. However, any file that has been
501 deleted since the last Full backup remains in the Bacula catalog, which
502 means that if between a Full save and the time you do a restore, some
503 files are deleted, those deleted files will also be restored. The
504 deleted files will no longer appear in the catalog after doing another
505 Full save. However, to remove deleted files from the catalog during a
506 Differential backup is quite a time consuming process and not currently
507 implemented in Bacula. It is, however, a planned future feature.
509 As noted above, if you move a directory rather than copy it, the
510 files in it do not have their modification time (st\_mtime) or
511 their attribute change time (st\_ctime) changed. As a
512 consequence, those files will probably not be backed up by an
513 Incremental or Differential backup which depend solely on these
514 time stamps. If you move a directory, and wish it to be
515 properly backed up, it is generally preferable to copy it, then
516 delete the original. Alternatively, you can move the directory, then
517 use the {\bf touch} program to update the timestamps.
519 Every once and a while, someone asks why we need Differential
520 backups as long as Incremental backups pickup all changed files.
521 There are possibly many answers to this question, but the one
522 that is the most important for me is that a Differential backup
524 all the Incremental and Differential backups since the last Full backup
525 into a single Differential backup. This has two effects: 1. It gives
526 some redundancy since the old backups could be used if the merged backup
527 cannot be read. 2. More importantly, it reduces the number of Volumes
528 that are needed to do a restore effectively eliminating the need to read
529 all the volumes on which the preceding Incremental and Differential
530 backups since the last Full are done.
534 For a {\bf Restore} Job, no level needs to be specified.
536 For a {\bf Verify} Job, the Level may be one of the following:
541 \index[dir]{InitCatalog}
542 does a scan of the specified {\bf FileSet} and stores the file
543 attributes in the Catalog database. Since no file data is saved, you
544 might ask why you would want to do this. It turns out to be a very
545 simple and easy way to have a {\bf Tripwire} like feature using {\bf
546 Bacula}. In other words, it allows you to save the state of a set of
547 files defined by the {\bf FileSet} and later check to see if those files
548 have been modified or deleted and if any new files have been added.
549 This can be used to detect system intrusion. Typically you would
550 specify a {\bf FileSet} that contains the set of system files that
551 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
552 run the {\bf InitCatalog} level verify one time when your system is
553 first setup, and then once again after each modification (upgrade) to
554 your system. Thereafter, when your want to check the state of your
555 system files, you use a {\bf Verify} {\bf level = Catalog}. This
556 compares the results of your {\bf InitCatalog} with the current state of
561 Compares the current state of the files against the state previously
562 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
563 items reported are determined by the {\bf verify} options specified on
564 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
565 FileSet} resource below for more details). Typically this command will
566 be run once a day (or night) to check for any changes to your system
569 Please note! If you run two Verify Catalog jobs on the same client at
570 the same time, the results will certainly be incorrect. This is because
571 Verify Catalog modifies the Catalog database while running in order to
574 \item [VolumeToCatalog]
575 \index[dir]{VolumeToCatalog}
576 This level causes Bacula to read the file attribute data written to the
577 Volume from the last Job. The file attribute data are compared to the
578 values saved in the Catalog database and any differences are reported.
579 This is similar to the {\bf Catalog} level except that instead of
580 comparing the disk file attributes to the catalog database, the
581 attribute data written to the Volume is read and compared to the catalog
582 database. Although the attribute data including the signatures (MD5 or
583 SHA1) are compared, the actual file data is not compared (it is not in
586 Please note! If you run two Verify VolumeToCatalog jobs on the same
587 client at the same time, the results will certainly be incorrect. This
588 is because the Verify VolumeToCatalog modifies the Catalog database
591 \item [DiskToCatalog]
592 \index[dir]{DiskToCatalog}
593 This level causes Bacula to read the files as they currently are on
594 disk, and to compare the current file attributes with the attributes
595 saved in the catalog from the last backup for the job specified on the
596 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
597 level described above by the fact that it doesn't compare against a
598 previous Verify job but against a previous backup. When you run this
599 level, you must supply the verify options on your Include statements.
600 Those options determine what attribute fields are compared.
602 This command can be very useful if you have disk problems because it
603 will compare the current state of your disk against the last successful
604 backup, which may be several jobs.
606 Note, the current implementation (1.32c) does not identify files that
610 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
611 \index[dir]{Verify Job}
612 \index[dir]{Directive!Verify Job}
613 If you run a verify job without this directive, the last job run will be
614 compared with the catalog, which means that you must immediately follow
615 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
616 will find the last job with that name that ran. This permits you to run
617 all your backups, then run Verify jobs on those that you wish to be
618 verified (most often a {\bf VolumeToCatalog}) so that the tape just
621 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
623 \index[dir]{Directive!JobDefs}
624 If a JobDefs-Resource-Name is specified, all the values contained in the
625 named JobDefs resource will be used as the defaults for the current Job.
626 Any value that you explicitly define in the current Job resource, will
627 override any defaults specified in the JobDefs resource. The use of
628 this directive permits writing much more compact Job resources where the
629 bulk of the directives are defined in one or more JobDefs. This is
630 particularly useful if you have many similar Jobs but with minor
631 variations such as different Clients. A simple example of the use of
632 JobDefs is provided in the default bacula-dir.conf file.
634 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
635 \index[dir]{Bootstrap}
636 \index[dir]{Directive!Bootstrap}
637 The Bootstrap directive specifies a bootstrap file that, if provided,
638 will be used during {\bf Restore} Jobs and is ignored in other Job
639 types. The {\bf bootstrap} file contains the list of tapes to be used
640 in a restore Job as well as which files are to be restored.
641 Specification of this directive is optional, and if specified, it is
642 used only for a restore job. In addition, when running a Restore job
643 from the console, this value can be changed.
645 If you use the {\bf Restore} command in the Console program, to start a
646 restore job, the {\bf bootstrap} file will be created automatically from
647 the files you select to be restored.
649 For additional details of the {\bf bootstrap} file, please see
650 \ilink{Restoring Files with the Bootstrap File}{_ChapterStart43} chapter
653 \label{writebootstrap}
654 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
655 \index[dir]{Write Bootstrap}
656 \index[dir]{Directive!Write Bootstrap}
657 The {\bf writebootstrap} directive specifies a file name where Bacula
658 will write a {\bf bootstrap} file for each Backup job run. Thus this
659 directive applies only to Backup Jobs. If the Backup job is a Full
660 save, Bacula will erase any current contents of the specified file
661 before writing the bootstrap records. If the Job is an Incremental
662 save, Bacula will append the current bootstrap record to the end of the
665 Using this feature, permits you to constantly have a bootstrap file that
666 can recover the current state of your system. Normally, the file
667 specified should be a mounted drive on another machine, so that if your
668 hard disk is lost, you will immediately have a bootstrap record
669 available. Alternatively, you should copy the bootstrap file to another
670 machine after it is updated.
672 If the {\bf bootstrap-file-specification} begins with a vertical bar
673 (|), Bacula will use the specification as the name of a program to which
674 it will pipe the bootstrap record. It could for example be a shell
675 script that emails you the bootstrap record.
677 For more details on using this file, please see the chapter entitled
678 \ilink{The Bootstrap File}{_ChapterStart43} of this manual.
680 \item [Client = \lt{}client-resource-name\gt{}]
682 \index[dir]{Directive!Client}
683 The Client directive specifies the Client (File daemon) that will be used in
684 the current Job. Only a single Client may be specified in any one Job. The
685 Client runs on the machine to be backed up, and sends the requested files to
686 the Storage daemon for backup, or receives them when restoring. For
687 additional details, see the
688 \ilink{Client Resource section}{ClientResource2} of this chapter.
689 This directive is required.
691 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
694 The FileSet directive specifies the FileSet that will be used in the
695 current Job. The FileSet specifies which directories (or files) are to
696 be backed up, and what options to use (e.g. compression, ...). Only a
697 single FileSet resource may be specified in any one Job. For additional
698 details, see the \ilink{FileSet Resource section}{FileSetResource} of
699 this chapter. This directive is required.
701 \item [Messages = \lt{}messages-resource-name\gt{}]
702 \index[dir]{Messages}
703 \index[dir]{Directive!Messages}
704 The Messages directive defines what Messages resource should be used for
705 this job, and thus how and where the various messages are to be
706 delivered. For example, you can direct some messages to a log file, and
707 others can be sent by email. For additional details, see the
708 \ilink{Messages Resource}{_ChapterStart15} Chapter of this manual. This
709 directive is required.
711 \item [Pool = \lt{}pool-resource-name\gt{}]
713 \index[dir]{Directive!Pool}
714 The Pool directive defines the pool of Volumes where your data can be
715 backed up. Many Bacula installations will use only the {\bf Default}
716 pool. However, if you want to specify a different set of Volumes for
717 different Clients or different Jobs, you will probably want to use
718 Pools. For additional details, see the \ilink{Pool Resource
719 section}{PoolResource} of this chapter. This directive is required.
721 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
722 \index[dir]{Full Backup Pool}
723 \index[dir]{Directive!Full Backup Pool}
724 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
725 It will override any Pool specification during a Full backup. This
726 directive is optional.
728 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
729 \index[dir]{Differential Backup Pool}
730 \index[dir]{Directive!Differential Backup Pool}
731 The {\it Differential Backup Pool} specifies a Pool to be used for
732 Differential backups. It will override any Pool specification during a
733 Differential backup. This directive is optional.
735 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
736 \index[dir]{Incremental Backup Pool}
737 \index[dir]{Directive!Incremental Backup Pool}
738 The {\it Incremental Backup Pool} specifies a Pool to be used for
739 Incremental backups. It will override any Pool specification during an
740 Incremental backup. This directive is optional.
742 \item [Schedule = \lt{}schedule-name\gt{}]
743 \index[dir]{Schedule}
744 \index[dir]{Directive!Schedule}
745 The Schedule directive defines what schedule is to be used for the Job.
746 The schedule in turn determines when the Job will be automatically
747 started and what Job level (i.e. Full, Incremental, ...) is to be run.
748 This directive is optional, and if left out, the Job can only be started
749 manually using the Console program. Although you may specify only a
750 single Schedule resource for any one job, the Schedule resource may
751 contain multiple {\bf Run} directives, which allow you to run the Job at
752 many different times, and each {\bf run} directive permits overriding
753 the default Job Level Pool, Storage, and Messages resources. This gives
754 considerable flexibility in what can be done with a single Job. For
755 additional details, see the \ilink{Schedule Resource
756 Chapter}{ScheduleResource} of this manual.
759 \item [Storage = \lt{}storage-resource-name\gt{}]
761 \index[dir]{Directive!Storage}
762 The Storage directive defines the name of the storage services where you
763 want to backup the FileSet data. For additional details, see the
764 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
765 This directive is required.
767 \item [Max Start Delay = \lt{}time\gt{}]
768 \index[dir]{Max Start Delay}
769 \index[dir]{Directive!Max Start Delay}
770 The time specifies the maximum delay between the scheduled time and the
771 actual start time for the Job. For example, a job can be scheduled to
772 run at 1:00am, but because other jobs are running, it may wait to run.
773 If the delay is set to 3600 (one hour) and the job has not begun to run
774 by 2:00am, the job will be canceled. This can be useful, for example,
775 to prevent jobs from running during day time hours. The default is 0
776 which indicates no limit.
778 \item [Max Run Time = \lt{}time\gt{}]
779 \index[dir]{Max Run Time}
780 \index[dir]{Directive!Max Run Time}
781 The time specifies the maximum allowed time that a job may run, counted
782 from when the job starts, ({\bf not} necessarily the same as when the
783 job was scheduled). This directive is implemented in version 1.33 and
786 \item [Max Wait Time = \lt{}time\gt{}]
787 \index[dir]{Max Wait Time}
788 \index[dir]{Directive!Max Wait Time}
789 The time specifies the maximum allowed time that a job may block waiting
790 for a resource (such as waiting for a tape to be mounted, or waiting for
791 the storage or file daemons to perform their duties), counted from the
792 when the job starts, ({\bf not} necessarily the same as when the job was
793 scheduled). This directive is implemented only in version 1.33 and
796 \item [Incremental Max Wait Time = \lt{}time\gt{}]
797 \index[dir]{Incremental Max Wait Time}
798 \index[dir]{Directive!Incremental Max Wait Time}
799 The time specifies the maximum allowed time that an Incremental backup
800 job may block waiting for a resource (such as waiting for a tape to be
801 mounted, or waiting for the storage or file daemons to perform their
802 duties), counted from the when the job starts, ({\bf not} necessarily
803 the same as when the job was scheduled). Please note that if there is a
804 {\bf Max Wait Time} it may also be applied to the job.
806 \item [Differential Max Wait Time = \lt{}time\gt{}]
807 \index[dir]{Differential Max Wait Time}
808 \index[dir]{Directive!Differential Max Wait Time}
809 The time specifies the maximum allowed time that a Differential backup
810 job may block waiting for a resource (such as waiting for a tape to be
811 mounted, or waiting for the storage or file daemons to perform their
812 duties), counted from the when the job starts, ({\bf not} necessarily
813 the same as when the job was scheduled). Please note that if there is a
814 {\bf Max Wait Time} it may also be applied to the job.
816 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
817 \index[dir]{Prefer Mounted Volumes}
818 \index[dir]{Directive!Prefer Mounted Volumes}
819 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
820 yes), the Storage daemon is requested to select either an Autochanger or
821 a drive with a valid Volume already mounted in preference to a drive
822 that is not ready. If no drive with a suitable Volume is available, it
823 will select the first available drive.
825 If the directive is set to {\bf no}, the Storage daemon will prefer
826 finding an unused drive, otherwise, each job started will append to the
827 same Volume (assuming the Pool is the same for all jobs). Setting
828 Prefer Mounted Volumes to no can be useful for those sites particularly
829 with multiple drive autochangers that prefer to maximumize backup
830 throughput at the expense of using additional drives and Volumes. As an
831 optimization, when using multiple drives, you will probably want to
832 start each of your jobs one after another with approximately 5 second
833 intervals. This will help ensure that each night, the same drive
834 (Volume) is selected for the same job, otherwise, when you do a restore,
835 you may find the files spread over many more Volumes than necessary.
838 \item [Prune Jobs = \lt{}yes|no\gt{}]
839 \index[dir]{Prune Jobs}
840 \index[dir]{Directive!Prune Jobs}
841 Normally, pruning of Jobs from the Catalog is specified on a Client by
842 Client basis in the Client resource with the {\bf AutoPrune} directive.
843 If this directive is specified (not normally) and the value is {\bf
844 yes}, it will override the value specified in the Client resource. The
848 \item [Prune Files = \lt{}yes|no\gt{}]
849 \index[dir]{Prune Files}
850 \index[dir]{Directive!Prune Files}
851 Normally, pruning of Files from the Catalog is specified on a Client by
852 Client basis in the Client resource with the {\bf AutoPrune} directive.
853 If this directive is specified (not normally) and the value is {\bf
854 yes}, it will override the value specified in the Client resource. The
857 \item [Prune Volumes = \lt{}yes|no\gt{}]
858 \index[dir]{Prune Volumes}
859 \index[dir]{Directive!Prune Volumes}
860 Normally, pruning of Volumes from the Catalog is specified on a Client
861 by Client basis in the Client resource with the {\bf AutoPrune}
862 directive. If this directive is specified (not normally) and the value
863 is {\bf yes}, it will override the value specified in the Client
864 resource. The default is {\bf no}.
866 \item [RunScript \{...\}]
867 \index[dir]{RunScript}
868 \index[dir]{Directive!Run Script}
870 The specified {\bf command} is run as an external program prior or after the
871 current Job. This directive is optional.
873 You can use following options:\\
875 \begin{tabular}{|c|c|c|l}
876 Options & Value & Default & Informations \\
879 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
881 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
883 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
885 Runs When & Before|After|Always & {\it Never} & When run commands\\
887 Abort Job On Error & Yes/No & {\it Yes} & Abort job if script return
888 something different from 0 \\
890 Command & & & Path to your script\\
895 Any output sent by the command to standard output will be included in the
896 Bacula job report. The command string must be a valid program name or name
899 In addition, the command string is parsed then fed to the execvp() function,
900 which means that the path will be searched to execute your specified
901 command, but there is no shell interpretation, as a consequence, if you
902 invoke complicated commands or want any shell features such as redirection
903 or piping, you must call a shell script and do it inside that script.
905 Before submitting the specified command to the operating system, Bacula
906 performs character substitution of the following characters:
919 %t = Job type (Backup, ...)
925 The Job Exit Status code \%e edits the following values:
927 \index[dir]{Exit Status}
934 \item Unknown term code
937 Thus if you edit it on a command line, you will need to enclose
938 it within some sort of quotes.
941 You can use these following shortcuts:\\
943 \begin{tabular}{|c|c|c|c|c|c}
944 Keyword & RunsOnSuccess & RunsOnFailure & AbortJobOnError & Runs On Client & RunsWhen \\
946 Run Before Job & & & Yes & No & Before \\
948 Run After Job & Yes & No & & No & After \\
950 Run After Failed Job & No & Yes & & No & After \\
952 Client Run Before Job & & & Yes & Yes & Before \\
954 Client Run After Job & Yes & No & & Yes & After \\
956 Client Run After Failed Job & No & Yes & & Yes & After \\
964 Command = "/etc/init.d/apache stop"
970 Command = "/etc/init.d/apache start"
974 {\bf Special Windows Considerations}
976 In addition, for a Windows client on version 1.33 and above, please take
977 careful note that you must ensure a correct path to your script. The
978 script or program can be a .com, .exe or a .bat file. However, if you
979 specify a path, you must also specify the full extension. Unix like
980 commands will not work unless you have installed and properly configured
981 Cygwin in addition to and separately from Bacula.
983 The command can be anything that cmd.exe or command.com will recognize
984 as an executable file. Specifying the executable's extension is
985 optional, unless there is an ambiguity. (i.e. ls.bat, ls.exe)
987 The System \%Path\% will be searched for the command. (under the
988 environment variable dialog you have have both System Environment and
989 User Environment, we believe that only the System environment will be
990 available to bacula-fd, if it is running as a service.)
992 System environment variables can be referenced with \%var\% and
993 used as either part of the command name or arguments.
998 ClientRunBeforeJob = "\"C:/Program Files/Software
999 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1003 The special characters \&()[]\{\}\^{}=;!'+,`\~{} will need to be quoted
1004 if they are part of a filename or argument.
1006 If someone is logged in, a blank "command" window running the commands
1007 will be present during the execution of the command.
1009 Some Suggestions from Phil Stracchino for running on Win32 machines with
1010 the native Win32 File daemon:
1013 \item You might want the ClientRunBeforeJob directive to specify a .bat
1014 file which runs the actual client-side commands, rather than trying
1015 to run (for example) regedit /e directly.
1016 \item The batch file should explicitly 'exit 0' on successful completion.
1017 \item The path to the batch file should be specified in Unix form:
1019 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1021 rather than DOS/Windows form:
1023 ClientRunBeforeJob =
1025 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1029 The following example of the use of the Client Run Before Job directive was
1030 submitted by a user:\\
1031 You could write a shell script to back up a DB2 database to a FIFO. The shell
1041 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1046 The following line in the Job resource in the bacula-dir.conf file:
1049 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1054 When the job is run, you will get messages from the output of the script
1055 stating that the backup has started. Even though the command being run is
1056 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1057 command, thus the backup stalls.
1059 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1064 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1069 It is important to redirect the input and outputs of a backgrounded command to
1070 /dev/null to prevent the script from blocking.
1072 \item [Run Before Job = \lt{}command\gt{}]
1073 \index[dir]{Run Before Job}
1074 \index[dir]{Directive!Run Before Job}
1075 \index[dir]{Directive!Run Before Job}
1076 The specified {\bf command} is run as an external program prior to running the
1077 current Job. This directive is not required, but if it is defined, and if the
1078 exit code of the program run is non-zero, the current Bacula job will be
1082 Run Before Job = "echo test"
1084 it's equivalent to :
1087 Command = "echo test"
1093 Lutz Kittler has pointed out that using the RunBeforJob directive can be a
1094 simple way to modify your schedules during a holiday. For example, suppose
1095 that you normally do Full backups on Fridays, but Thursday and Friday are
1096 holidays. To avoid having to change tapes between Thursday and Friday when
1097 no one is in the office, you can create a RunBeforeJob that returns a
1098 non-zero status on Thursday and zero on all other days. That way, the
1099 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1100 before leaving will be used.
1102 \item [Run After Job = \lt{}command\gt{}]
1103 \index[dir]{Run After Job}
1104 \index[dir]{Directive!Run After Job}
1105 The specified {\bf command} is run as an external program if the current
1106 job terminates normally (without error or without being canceled). This
1107 directive is not required. If the exit code of the program run is
1108 non-zero, Bacula will print a warning message. Before submitting the
1109 specified command to the operating system, Bacula performs character
1110 substitution as described above for the {\bf RunScript} directive.
1112 An example of the use of this directive is given in the
1113 \ilink{Tips Chapter}{JobNotification} of this manual.
1115 See the {\bf Run After Failed Job} if you
1116 want to run a script after the job has terminated with any
1119 \item [Run After Failed Job = \lt{}command\gt{}]
1120 \index[dir]{Run After Job}
1121 \index[dir]{Directive!Run After Job}
1122 The specified {\bf command} is run as an external program after the current
1123 job terminates with any error status. This directive is not required. The
1124 command string must be a valid program name or name of a shell script. If
1125 the exit code of the program run is non-zero, Bacula will print a
1126 warning message. Before submitting the specified command to the
1127 operating system, Bacula performs character substitution as described above
1128 for the {\bf RunScript} directive. Note, if you wish that your script
1129 will run regardless of the exit status of the Job, you can use this :
1132 Command = "echo test"
1136 RunsOnSuccess = yes # default, you can drop this line
1140 An example of the use of this directive is given in the
1141 \ilink{Tips Chapter}{JobNotification} of this manual.
1144 \item [Client Run Before Job = \lt{}command\gt{}]
1145 \index[dir]{Client Run Before Job}
1146 \index[dir]{Directive!Client Run Before Job}
1147 This directive is the same as {\bf Run Before Job} except that the
1148 program is run on the client machine. The same restrictions apply to
1149 Unix systems as noted above for the {\bf RunScript}.
1151 \item [Client Run After Job = \lt{}command\gt{}]
1152 \index[dir]{Client Run After Job}
1153 \index[dir]{Directive!Client Run After Job}
1154 This directive is the same as {\bf Run After Job} except that it is run on
1155 the client machine. Note, please see the notes above in {\bf RunScript}
1156 concerning Windows clients.
1158 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
1159 \index[dir]{Rerun Failed Levels}
1160 \index[dir]{Directive!Rerun Failed Levels}
1161 If this directive is set to {\bf yes} (default no), and Bacula detects that
1162 a previous job at a higher level (i.e. Full or Differential) has failed,
1163 the current job level will be upgraded to the higher level. This is
1164 particularly useful for Laptops where they may often be unreachable, and if
1165 a prior Full save has failed, you wish the very next backup to be a Full
1166 save rather than whatever level it is started as.
1168 \item [Spool Data = \lt{}yes|no\gt{}]
1169 \index[dir]{Spool Data}
1170 \index[dir]{Directive!Spool Data}
1171 If this directive is set to {\bf yes} (default no), the Storage daemon will
1172 be requested to spool the data for this Job to disk rather than write it
1173 directly to tape. Once all the data arrives or the spool files' maximum sizes
1174 are reached, the data will be despooled and written to tape. When this
1175 directive is set to yes, the Spool Attributes is also automatically set to
1176 yes. Spooling data prevents tape shoe-shine (start and stop) during
1177 Incremental saves. This option should not be used if you are writing to a
1180 \item [Spool Attributes = \lt{}yes|no\gt{}]
1181 \index[dir]{Spool Attributes}
1182 \index[dir]{Directive!Spool Attributes}
1184 \index[general]{slow}
1185 \index[dir]{Backups!slow}
1186 \index[general]{Backups!slow}
1187 The default is set to {\bf no}, which means that the File attributes are
1189 by the Storage daemon to the Director as they are stored on tape. However,
1190 if you want to avoid the possibility that database updates will slow down
1191 writing to the tape, you may want to set the value to {\bf yes}, in which
1192 case the Storage daemon will buffer the File attributes and Storage
1193 coordinates to a temporary file in the Working Directory, then when writing
1194 the Job data to the tape is completed, the attributes and storage coordinates
1195 will be sent to the Director.
1197 \item [Where = \lt{}directory\gt{}]
1199 \index[dir]{Directive!Where}
1200 This directive applies only to a Restore job and specifies a prefix to
1201 the directory name of all files being restored. This permits files to
1202 be restored in a different location from which they were saved. If {\bf
1203 Where} is not specified or is set to backslash ({\bf /}), the files will
1204 be restored to their original location. By default, we have set {\bf
1205 Where} in the example configuration files to be {\bf
1206 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1209 \item [Replace = \lt{}replace-option\gt{}]
1210 \index[dir]{Replace}
1211 \index[dir]{Directive!Replace}
1212 This directive applies only to a Restore job and specifies what happens
1213 when Bacula wants to restore a file or directory that already exists.
1214 You have the following options for {\bf replace-option}:
1220 when the file to be restored already exists, it is deleted and then
1221 replaced by the copy that was backed up.
1224 \index[dir]{ifnewer}
1225 if the backed up file (on tape) is newer than the existing file, the
1226 existing file is deleted and replaced by the back up.
1229 \index[dir]{ifolder}
1230 if the backed up file (on tape) is older than the existing file, the
1231 existing file is deleted and replaced by the back up.
1235 if the backed up file already exists, Bacula skips restoring this file.
1238 \item [Prefix Links=\lt{}yes|no\gt{}]
1239 \index[dir]{Prefix Links}
1240 \index[dir]{Directive!Prefix Links}
1241 If a {\bf Where} path prefix is specified for a recovery job, apply it
1242 to absolute links as well. The default is {\bf No}. When set to {\bf
1243 Yes} then while restoring files to an alternate directory, any absolute
1244 soft links will also be modified to point to the new alternate
1245 directory. Normally this is what is desired -- i.e. everything is self
1246 consistent. However, if you wish to later move the files to their
1247 original locations, all files linked with absolute names will be broken.
1249 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1250 \index[dir]{Maximum Concurrent Jobs}
1251 \index[dir]{Directive!Maximum Concurrent Jobs}
1252 where \lt{}number\gt{} is the maximum number of Jobs from the current
1253 Job resource that can run concurrently. Note, this directive limits
1254 only Jobs with the same name as the resource in which it appears. Any
1255 other restrictions on the maximum concurrent jobs such as in the
1256 Director, Client, or Storage resources will also apply in addition to
1257 the limit specified here. The default is set to 1, but you may set it
1258 to a larger number. We strongly recommend that you read the WARNING
1259 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1260 Director's resource.
1262 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1263 \index[dir]{Reschedule On Error}
1264 \index[dir]{Directive!Reschedule On Error}
1265 If this directive is enabled, and the job terminates in error, the job
1266 will be rescheduled as determined by the {\bf Reschedule Interval} and
1267 {\bf Reschedule Times} directives. If you cancel the job, it will not
1268 be rescheduled. The default is {\bf no} (i.e. the job will not be
1272 This specification can be useful for portables, laptops, or other
1273 machines that are not always connected to the network or switched on.
1275 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1276 \index[dir]{Reschedule Interval}
1277 \index[dir]{Directive!Reschedule Interval}
1278 If you have specified {\bf Reschedule On Error = yes} and the job
1279 terminates in error, it will be rescheduled after the interval of time
1280 specified by {\bf time-specification}. See \ilink{the time
1281 specification formats}{Time} in the Configure chapter for details of
1282 time specifications. If no interval is specified, the job will not be
1283 rescheduled on error.
1285 \item [Reschedule Times = \lt{}count\gt{}]
1286 \index[dir]{Reschedule Times}
1287 \index[dir]{Directive!Reschedule Times}
1288 This directive specifies the maximum number of times to reschedule the
1289 job. If it is set to zero (the default) the job will be rescheduled an
1290 indefinite number of times.
1292 \item [Run = \lt{}job-name\gt{}]
1294 \index[dir]{Directive!Run}
1295 \index[dir]{Clone a Job}
1296 The Run directive (not to be confused with the Run option in a
1297 Schedule) allows you to start other jobs or to clone jobs. By using the
1298 cloning keywords (see below), you can backup
1299 the same data (or almost the same data) to two or more drives
1300 at the same time. The {\bf job-name} is normally the same name
1301 as the current Job resource (thus creating a clone). However, it
1302 may be any Job name, so one job may start other related jobs.
1304 The part after the equal sign must be enclosed in double quotes,
1305 and can contain any string or set of options (overrides) that you
1306 can specify when entering the Run command from the console. For
1307 example {\bf storage=DDS-4 ...}. In addition, there are two special
1308 keywords that permit you to clone the current job. They are {\bf level=\%l}
1309 and {\bf since=\%s}. The \%l in the level keyword permits
1310 entering the actual level of the current job and the \%s in the since
1311 keyword permits putting the same time for comparison as used on the
1312 current job. Note, in the case of the since keyword, the \%s must be
1313 enclosed in double quotes, and thus they must be preceded by a backslash
1314 since they are already inside quotes. For example:
1317 run = "Nightly-backup level=%s since=\"%s\" storage=DDS-4"
1321 A cloned job will not start additional clones, so it is not
1322 possible to recurse.
1327 \item [Priority = \lt{}number\gt{}]
1328 \index[dir]{Priority}
1329 \index[dir]{Directive!Priority}
1330 This directive permits you to control the order in which your jobs run
1331 by specifying a positive non-zero number. The higher the number, the
1332 lower the job priority. Assuming you are not running concurrent jobs,
1333 all queued jobs of priority 1 will run before queued jobs of priority 2
1334 and so on, regardless of the original scheduling order.
1336 The priority only affects waiting jobs that are queued to run, not jobs
1337 that are already running. If one or more jobs of priority 2 are already
1338 running, and a new job is scheduled with priority 1, the currently
1339 running priority 2 jobs must complete before the priority 1 job is run.
1341 The default priority is 10.
1343 If you want to run concurrent jobs you should
1344 keep these points in mind:
1347 \item To run concurrent jobs, you must set Maximum Concurrent Jobs = 2 in 5
1348 or 6 distinct places: in bacula-dir.conf in the Director, the Job, the
1349 Client, the Storage resources; in bacula-fd in the FileDaemon (or
1350 Client) resource, and in bacula-sd.conf in the Storage resource. If any
1351 one is missing, it will throttle the jobs to one at a time. You may, of
1352 course, set the Maximum Concurrent Jobs to more than 2.
1353 \item Bacula concurrently runs jobs of only one priority at a time. It
1354 will not simultaneously run a priority 1 and a priority 2 job.
1355 \item If Bacula is running a priority 2 job and a new priority 1 job is
1356 scheduled, it will wait until the running priority 2 job terminates even
1357 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1358 to run simultaneously.
1359 \item Suppose that bacula is running a priority 2 job and a new priority 1
1360 job is scheduled and queued waiting for the running priority 2 job to
1361 terminate. If you then start a second priority 2 job, the waiting
1362 priority 1 job will prevent the new priority 2 job from running
1363 concurrently with the running priority 2 job. That is: as long as there
1364 is a higher priority job waiting to run, no new lower priority jobs will
1365 start even if the Maximum Concurrent Jobs settings would normally allow
1366 them to run. This ensures that higher priority jobs will be run as soon
1370 If you have several jobs of different priority, it may not best to start
1371 them at exactly the same time, because Bacula must examine them one at a
1372 time. If by Bacula starts a lower priority job first, then it will run
1373 before your high priority jobs. If you experience this problem, you may
1374 avoid it by starting any higher priority jobs a few seconds before lower
1375 priority ones. This insures that Bacula will examine the jobs in the
1376 correct order, and that your priority scheme will be respected.
1378 \label{WritePartAfterJob}
1379 \item [Write Part After Job = \lt{}yes|no\gt{}]
1380 \index[dir]{Write Part After Job}
1381 \index[dir]{Directive!Write Part After Job}
1382 This directive is only implemented in version 1.37 and later.
1383 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1384 will be created after the job is finished.
1386 It should be set to {\bf yes} when writing to devices that require mount
1387 (for example DVD), so you are sure that the current part, containing
1388 this job's data, is written to the device, and that no data is left in
1389 the temporary file on the hard disk. However, on some media, like DVD+R
1390 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1391 written. So, if you run several jobs each after another, you could set
1392 this directive to {\bf no} for all jobs, except the last one, to avoid
1393 wasting too much space, but to ensure that the data is written to the
1394 medium when all jobs are finished.
1396 It is ignored with tape and FIFO devices.
1399 The following is an example of a valid Job resource definition:
1406 Level = Incremental # default
1408 FileSet="Minou Full Set"
1411 Schedule = "MinouWeeklyCycle"
1417 \subsection*{The JobDefs Resource}
1418 \label{JobDefsResource}
1419 \index[general]{JobDefs Resource}
1420 \index[general]{Resource!JobDefs}
1421 \addcontentsline{toc}{subsection}{JobDefs Resource}
1423 The JobDefs resource permits all the same directives that can appear in a Job
1424 resource. However, a JobDefs resource does not create a Job, rather it can be
1425 referenced within a Job to provide defaults for that Job. This permits you to
1426 concisely define several nearly identical Jobs, each one referencing a JobDefs
1427 resource which contains the defaults. Only the changes from the defaults need to
1428 be mentioned in each Job.
1430 \subsection*{The Schedule Resource}
1431 \label{ScheduleResource}
1432 \index[general]{Resource!Schedule}
1433 \index[general]{Schedule Resource}
1434 \addcontentsline{toc}{subsection}{Schedule Resource}
1436 The Schedule resource provides a means of automatically scheduling a Job as
1437 well as the ability to override the default Level, Pool, Storage and Messages
1438 resources. If a Schedule resource is not referenced in a Job, the Job can only
1439 be run manually. In general, you specify an action to be taken and when.
1444 \index[dir]{Schedule}
1445 \index[dir]{Directive!Schedule}
1446 Start of the Schedule directives. No {\bf Schedule} resource is
1447 required, but you will need at least one if you want Jobs to be
1448 automatically started.
1450 \item [Name = \lt{}name\gt{}]
1452 \index[dir]{Directive!Name}
1453 The name of the schedule being defined. The Name directive is required.
1455 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1457 \index[dir]{Directive!Run}
1458 The Run directive defines when a Job is to be run, and what overrides if
1459 any to apply. You may specify multiple {\bf run} directives within a
1460 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1461 multiple schedules). If you have two {\bf Run} directives that start at
1462 the same time, two Jobs will start at the same time (well, within one
1463 second of each other).
1465 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1466 Messages, and the Pool specifications provided in the Job resource. In
1467 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1468 specifications permit overriding the Pool specification according to
1469 what backup Job Level is in effect.
1471 By the use of overrides, you may customize a particular Job. For
1472 example, you may specify a Messages override for your Incremental
1473 backups that outputs messages to a log file, but for your weekly or
1474 monthly Full backups, you may send the output by email by using a
1475 different Messages override.
1477 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1478 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1479 or IncrementalPool, and the {\bf value} is as defined on the respective
1480 directive formats for the Job resource. You may specify multiple {\bf
1481 Job-overrides} on one {\bf Run} directive by separating them with one or
1482 more spaces or by separating them with a trailing comma. For example:
1488 \index[dir]{Directive!Level}
1489 is all files in the FileSet whether or not they have changed.
1491 \item [Level=Incremental]
1493 \index[dir]{Directive!Level}
1494 is all files that have changed since the last backup.
1498 \index[dir]{Directive!Pool}
1499 specifies to use the Pool named {\bf Weekly}.
1501 \item [Storage=DLT\_Drive]
1502 \index[dir]{Storage}
1503 \index[dir]{Directive!Storage}
1504 specifies to use {\bf DLT\_Drive} for the storage device.
1506 \item [Messages=Verbose]
1507 \index[dir]{Messages}
1508 \index[dir]{Directive!Messages}
1509 specifies to use the {\bf Verbose} message resource for the Job.
1511 \item [FullPool=Full]
1512 \index[dir]{FullPool}
1513 \index[dir]{Directive!FullPool}
1514 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1516 upgraded from another type to a full backup.
1518 \item [DifferentialPool=Differential]
1519 \index[dir]{DifferentialPool}
1520 \index[dir]{Directive!DifferentialPool}
1521 specifies to use the Pool named {\bf Differential} if the job is a
1522 differential backup.
1524 \item [IncrementalPool=Incremental]
1525 \index[dir]{IncrementalPool}
1526 \index[dir]{Directive!IncrementalPool}
1527 specifies to use the Pool named {\bf Incremental} if the job is an
1530 \item [SpoolData=yes|no]
1531 \index[dir]{SpoolData}
1532 \index[dir]{Directive!SpoolData}
1533 tells Bacula to request the Storage daemon to spool data to a disk file
1534 before putting it on tape.
1536 \item [WritePartAfterJob=yes|no]
1537 \index[dir]{WritePartAfterJob}
1538 \index[dir]{Directive!WritePartAfterJob}
1539 tells Bacula to request the Storage daemon to write the current part file to
1540 the device when the job is finished (see
1541 \ilink{Write Part After Job directive in the Job
1542 resource}{WritePartAfterJob}). Please note, this directive is implemented
1543 only in version 1.37 and later.
1547 {\bf Date-time-specification} determines when the Job is to be run. The
1548 specification is a repetition, and as a default Bacula is set to run a job at
1549 the beginning of the hour of every hour of every day of every week of every
1550 month of every year. This is not normally what you want, so you must specify
1551 or limit when you want the job to run. Any specification given is assumed to
1552 be repetitive in nature and will serve to override or limit the default
1553 repetition. This is done by specifying masks or times for the hour, day of the
1554 month, day of the week, week of the month, week of the year, and month when
1555 you want the job to run. By specifying one or more of the above, you can
1556 define a schedule to repeat at almost any frequency you want.
1558 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1559 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1560 is special in that you may either specify a day of the month such as 1, 2,
1561 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1562 Sunday. Finally, you may also specify a week qualifier to restrict the
1563 schedule to the first, second, third, fourth, or fifth week of the month.
1565 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1566 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1567 month} and {\bf hour} remain set to the defaults of every month and all
1570 Note, by default with no other specification, your job will run at the
1571 beginning of every hour. If you wish your job to run more than once in any
1572 given hour, you will need to specify multiple {\bf run} specifications each
1573 with a different minute.
1575 The date/time to run the Job can be specified in the following way in
1582 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1583 second | third | forth | fifth
1584 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1585 sunday | monday | tuesday | wednesday |
1586 thursday | friday | saturday
1587 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1588 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1589 aug | sep | oct | nov | dec | january |
1590 february | ... | december
1591 <daily-keyword> = daily
1592 <weekly-keyword> = weekly
1593 <monthly-keyword> = monthly
1594 <hourly-keyword> = hourly
1595 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1596 <number> = <digit> | <digit><number>
1597 <12hour> = 0 | 1 | 2 | ... 12
1598 <hour> = 0 | 1 | 2 | ... 23
1599 <minute> = 0 | 1 | 2 | ... 59
1600 <day> = 1 | 2 | ... 31
1601 <time> = <hour>:<minute> |
1602 <12hour>:<minute>am |
1604 <time-spec> = <at-keyword> <time> |
1606 <date-keyword> = <void-keyword> <weekly-keyword>
1607 <day-range> = <day>-<day>
1608 <month-range> = <month-keyword>-<month-keyword>
1609 <wday-range> = <wday-keyword>-<wday-keyword>
1610 <range> = <day-range> | <month-range> |
1612 <date> = <date-keyword> | <day> | <range>
1613 <date-spec> = <date> | <date-spec>
1614 <day-spec> = <day> | <wday-keyword> |
1615 <day-range> | <wday-range> |
1617 <day-spec> = <day> | <wday-keyword> |
1618 <day> | <wday-range> |
1619 <week-keyword> <wday-keyword> |
1620 <week-keyword> <wday-range>
1621 <month-spec> = <month-keyword> | <month-range> |
1623 <date-time-spec> = <month-spec> <day-spec> <time-spec>
1629 Note, the Week of Year specification wnn follows the ISO standard definition
1630 of the week of the year, where Week 1 is the week in which the first Thursday
1631 of the year occurs, or alternatively, the week which contains the 4th of
1632 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
1633 precedes the first ISO week (i.e. has the first few days of the year if any
1634 occur before Thursday). w00 is not defined by the ISO specification. A week
1635 starts with Monday and ends with Sunday.
1637 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
1638 with level full each Sunday at 1:05am and an incremental job Monday through
1639 Saturday at 1:05am is:
1644 Name = "WeeklyCycle"
1645 Run = Level=Full sun at 1:05
1646 Run = Level=Incremental mon-sat at 1:05
1651 An example of a possible monthly cycle is as follows:
1656 Name = "MonthlyCycle"
1657 Run = Level=Full Pool=Monthly 1st sun at 1:05
1658 Run = Level=Differential 2nd-5th sun at 1:05
1659 Run = Level=Incremental Pool=Daily mon-sat at 1:05
1664 The first of every month:
1670 Run = Level=Full on 1 at 1:05
1671 Run = Level=Incremental on 2-31 at 1:05
1682 Run = Level=Full hourly at 0:05
1683 Run = Level=Full hourly at 0:15
1684 Run = Level=Full hourly at 0:25
1685 Run = Level=Full hourly at 0:35
1686 Run = Level=Full hourly at 0:45
1687 Run = Level=Full hourly at 0:55
1692 \subsection*{Technical Notes on Schedules}
1693 \index[general]{Schedules!Technical Notes on}
1694 \index[general]{Technical Notes on Schedules}
1695 \addcontentsline{toc}{subsection}{Technical Notes on Schedules}
1697 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
1698 minute field to each schedule. The masks are hour, day of the month (mday),
1699 month, day of the week (wday), week of the month (wom), and week of the year
1700 (woy). The schedule is initialized to have the bits of each of these masks
1701 set, which means that at the beginning of every hour, the job will run. When
1702 you specify a month for the first time, the mask will be cleared and the bit
1703 corresponding to your selected month will be selected. If you specify a second
1704 month, the bit corresponding to it will also be added to the mask. Thus when
1705 Bacula checks the masks to see if the bits are set corresponding to the
1706 current time, your job will run only in the two months you have set. Likewise,
1707 if you set a time (hour), the hour mask will be cleared, and the hour you
1708 specify will be set in the bit mask and the minutes will be stored in the
1711 For any schedule you have defined, you can see how these bits are set by doing
1712 a {\bf show schedules} command in the Console program. Please note that the
1713 bit mask is zero based, and Sunday is the first day of the week (bit zero).
1717 \subsection*{The Client Resource}
1718 \label{ClientResource2}
1719 \index[general]{Resource!Client}
1720 \index[general]{Client Resource}
1721 \addcontentsline{toc}{subsection}{Client Resource}
1723 The Client resource defines the attributes of the Clients that are served by
1724 this Director; that is the machines that are to be backed up. You will need
1725 one Client resource definition for each machine to be backed up.
1729 \item [Client (or FileDaemon)]
1730 \index[dir]{Client (or FileDaemon)}
1731 \index[dir]{Directive!Client (or FileDaemon)}
1732 Start of the Client directives.
1734 \item [Name = \lt{}name\gt{}]
1736 \index[dir]{Directive!Name}
1737 The client name which will be used in the Job resource directive or in the
1738 console run command. This directive is required.
1740 \item [Address = \lt{}address\gt{}]
1741 \index[dir]{Address}
1742 \index[dir]{Directive!Address}
1743 Where the address is a host name, a fully qualified domain name, or a
1745 address in dotted quad notation for a Bacula File server daemon. This
1746 directive is required.
1748 \item [FD Port = \lt{}port-number\gt{}]
1749 \index[dir]{FD Port}
1750 \index[dir]{Directive!FD Port}
1751 Where the port is a port number at which the Bacula File server daemon can
1753 contacted. The default is 9102.
1755 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
1756 \index[dir]{Catalog}
1757 \index[dir]{Directive!Catalog}
1758 This specifies the name of the catalog resource to be used for this Client.
1759 This directive is required.
1761 \item [Password = \lt{}password\gt{}]
1762 \index[dir]{Password}
1763 \index[dir]{Directive!Password}
1764 This is the password to be used when establishing a connection with the File
1765 services, so the Client configuration file on the machine to be backed up
1766 must have the same password defined for this Director. This directive is
1767 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1768 Bacula will generate a random password during the configuration process,
1769 otherwise it will be left blank.
1770 \label{FileRetention}
1772 \item [File Retention = \lt{}time-period-specification\gt{}]
1773 \index[dir]{File Retention}
1774 \index[dir]{Directive!File Retention}
1775 The File Retention directive defines the length of time that Bacula will
1777 File records in the Catalog database. When this time period expires, and if
1778 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
1779 that are older than the specified File Retention period. Note, this affects
1780 only records in the catalog database. It does not affect your archive
1783 File records may actually be retained for a shorter period than you specify
1784 on this directive if you specify either a shorter {\bf Job Retention} or a
1785 shorter {\bf Volume Retention} period. The shortest retention period of the
1786 three takes precedence. The time may be expressed in seconds, minutes,
1787 hours, days, weeks, months, quarters, or years. See the
1788 \ilink{ Configuration chapter}{Time} of this manual for
1789 additional details of time specification.
1791 The default is 60 days.
1792 \label{JobRetention}
1794 \item [Job Retention = \lt{}time-period-specification\gt{}]
1795 \index[dir]{Job Retention}
1796 \index[dir]{Directive!Job Retention}
1797 The Job Retention directive defines the length of time that Bacula will keep
1798 Job records in the Catalog database. When this time period expires, and if
1799 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) Job records
1800 that are older than the specified File Retention period. As with the other
1801 retention periods, this affects only records in the catalog and not data in
1802 your archive backup.
1804 If a Job record is selected for pruning, all associated File and JobMedia
1805 records will also be pruned regardless of the File Retention period set.
1806 As a consequence, you normally will set the File retention period to be
1807 less than the Job retention period. The Job retention period can actually
1808 be less than the value you specify here if you set the {\bf Volume
1809 Retention} directive in the Pool resource to a smaller duration. This is
1810 because the Job retention period and the Volume retention period are
1811 independently applied, so the smaller of the two takes precedence.
1813 The Job retention period is specified as seconds, minutes, hours, days,
1814 weeks, months, quarters, or years. See the
1815 \ilink{ Configuration chapter}{Time} of this manual for
1816 additional details of time specification.
1818 The default is 180 days.
1821 \item [AutoPrune = \lt{}yes|no\gt{}]
1822 \index[dir]{AutoPrune}
1823 \index[dir]{Directive!AutoPrune}
1824 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
1825 will automatically apply the File retention period and the Job retention
1826 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
1827 pruning will not be done, and your Catalog will grow in size each time you
1828 run a Job. Pruning affects only information in the catalog and not data
1829 stored in the backup archives (on Volumes).
1831 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1832 \index[dir]{Maximum Concurrent Jobs}
1833 \index[dir]{Directive!Maximum Concurrent Jobs}
1834 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
1835 that can run concurrently. Note, this directive limits only Jobs for Clients
1836 with the same name as the resource in which it appears. Any other
1837 restrictions on the maximum concurrent jobs such as in the Director, Job, or
1838 Storage resources will also apply in addition to any limit specified here.
1839 The default is set to 1, but you may set it to a larger number. We strongly
1840 recommend that you read the WARNING documented under
1841 \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
1844 \item [Priority = \lt{}number\gt{}]
1845 \index[dir]{Priority}
1846 \index[dir]{Directive!Priority}
1847 The number specifies the priority of this client relative to other clients
1848 that the Director is processing simultaneously. The priority can range from
1849 1 to 1000. The clients are ordered such that the smaller number priorities
1850 are performed first (not currently implemented).
1853 The following is an example of a valid Client resource definition:
1861 Password = very_good
1866 \subsection*{The Storage Resource}
1867 \label{StorageResource2}
1868 \index[general]{Resource!Storage}
1869 \index[general]{Storage Resource}
1870 \addcontentsline{toc}{subsection}{Storage Resource}
1872 The Storage resource defines which Storage daemons are available for use by
1878 \index[dir]{Storage}
1879 \index[dir]{Directive!Storage}
1880 Start of the Storage resources. At least one storage resource must be
1883 \item [Name = \lt{}name\gt{}]
1885 \index[dir]{Directive!Name}
1886 The name of the storage resource. This name appears on the Storage directive
1887 specified in the Job resource and is required.
1889 \item [Address = \lt{}address\gt{}]
1890 \index[dir]{Address}
1891 \index[dir]{Directive!Address}
1892 Where the address is a host name, a {\bf fully qualified domain name}, or an
1893 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
1894 will be transmitted to the File daemon who will then use it to contact the
1895 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
1896 the name but rather a fully qualified machine name or an IP address. This
1897 directive is required.
1899 \item [SD Port = \lt{}port\gt{}]
1900 \index[dir]{SD Port}
1901 \index[dir]{Directive!SD Port}
1902 Where port is the port to use to contact the storage daemon for information
1903 and to start jobs. This same port number must appear in the Storage resource
1904 of the Storage daemon's configuration file. The default is 9103.
1906 \item [Password = \lt{}password\gt{}]
1907 \index[dir]{Password}
1908 \index[dir]{Directive!Password}
1909 This is the password to be used when establishing a connection with the
1910 Storage services. This same password also must appear in the Director
1911 resource of the Storage daemon's configuration file. This directive is
1912 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1913 Bacula will generate a random password during the configuration process,
1914 otherwise it will be left blank.
1916 \item [Device = \lt{}device-name\gt{}]
1918 \index[dir]{Directive!Device}
1919 This directive specifies the Storage daemon's name of the device resource
1920 to be used for the storage. This name is not the physical device name, but
1921 the logical device name as defined on the {\bf Name} directive contained in
1922 the {\bf Device} resource definition of the {\bf Storage daemon}
1923 configuration file or if the device is an Autochanger, you must put the
1924 name as defined on the {\bf Name} directive contained in the {\bf
1925 Autochanger} resource definition of the {\bf Storage daemon}. You can
1926 specify any name you would like (even the device name if you prefer) up to
1927 a maximum of 127 characters in length. The physical device name associated
1928 with this device is specified in the {\bf Storage daemon} configuration
1929 file (as {\bf Archive Device}). Please take care not to define two
1930 different Storage resource directives in the Director that point to the
1931 same Device in the Storage daemon. Doing so may cause the Storage daemon
1932 to block (or hang) attempting to open the same device that is already open.
1933 This directive is required.
1936 \item [Media Type = \lt{}MediaType\gt{}]
1937 \index[dir]{Media Type}
1938 \index[dir]{Directive!Media Type}
1939 This directive specifies the Media Type to be used to store the data.
1940 This is an arbitrary string of characters up to 127 maximum that you
1941 define. It can be anything you want. However, it is best to make it
1942 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
1943 ...). In addition, it is essential that you make the {\bf Media Type}
1944 specification unique for each storage media type. If you have two DDS-4
1945 drives that have incompatible formats, or if you have a DDS-4 drive and
1946 a DDS-4 autochanger, you almost certainly should specify different {\bf
1947 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
1948 associated with the Job, Bacula can decide to use any Storage daemon
1949 that supports Media Type {\bf DDS-4} and on any drive that supports it.
1951 Currently Bacula permits only a single Media Type. Consequently, if
1952 you have a drive that supports more than one Media Type, you can
1953 give a unique string to Volumes with different intrinsic Media
1954 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
1955 those volumes will only be mounted on drives indicated with the
1956 dual type (DDS-3-4).
1958 If you want to tie Bacula to using a single Storage daemon or drive, you
1959 must specify a unique Media Type for that drive. This is an important
1960 point that should be carefully understood. Note, this applies equally
1961 to Disk Volumes. If you define more than one disk Device resource in
1962 your Storage daemon's conf file, the Volumes on those two devices are in
1963 fact incompatible because one can not be mounted on the other device
1964 since they are found in different directories. For this reason, you
1965 probably should use two different Media Types for your two disk Devices
1966 (even though you might think of them as both being File types). You can
1967 find more on this subject in the \ilink{Basic Volume
1968 Management}{_ChapterStart39} chapter of this manual.
1970 The {\bf MediaType} specified here, {\bf must} correspond to the {\bf
1971 Media Type} specified in the {\bf Device} resource of the {\bf Storage
1972 daemon} configuration file. This directive is required, and it is used
1973 by the Director and the Storage daemon to ensure that a Volume
1974 automatically selected from the Pool corresponds to the physical device.
1975 If a Storage daemon handles multiple devices (e.g. will write to
1976 various file Volumes on different partitions), this directive allows you
1977 to specify exactly which device.
1979 As mentioned above, the value specified in the Director's Storage resource
1980 must agree with the value specified in the Device resource in the {\bf
1981 Storage daemon's} configuration file. It is also an additional check so that
1982 you don't try to write data for a DLT onto an 8mm device.
1984 \label{Autochanger1}
1985 \item [Autochanger = \lt{}yes|no\gt{}]
1986 \index[dir]{Autochanger}
1987 \index[dir]{Directive!Autochanger}
1988 If you specify {\bf yes} for this command (the default is {\bf no}), when
1989 you use the {\bf label} command or the {\bf add} command to create a new
1990 Volume, {\bf Bacula} will also request the Autochanger Slot number.
1991 This simplifies creating database entries for Volumes in an autochanger.
1992 If you forget to specify the Slot, the autochanger will not be used.
1993 However, you may modify the Slot associated with a Volume at any time by
1994 using the {\bf update volume} command in the console program. When {\bf
1995 autochanger} is enabled, the algorithm used by Bacula to search for
1996 available volumes will be modified to consider only Volumes that are
1997 known to be in the autochanger's magazine. If no {\bf in changer}
1998 volume is found, Bacula will attempt recycling, pruning, ..., and if
1999 still no volume is found, Bacula will search for any volume whether or
2000 not in the magazine. By privileging in changer volumes, this procedure
2001 minimizes operator intervention. The default is {\bf no}.
2003 For the autochanger to be used, you must also specify {\bf Autochanger =
2004 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2005 configuration file as well as other important Storage daemon
2006 configuration information. Please consult the \ilink{Using
2007 Autochangers}{_ChapterStart18} manual of this chapter for the details of
2010 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2011 \index[dir]{Maximum Concurrent Jobs}
2012 \index[dir]{Directive!Maximum Concurrent Jobs}
2013 where \lt{}number\gt{} is the maximum number of Jobs with the current
2015 resource that can run concurrently. Note, this directive limits only Jobs
2016 for Jobs using this Storage daemon. Any other restrictions on the maximum
2017 concurrent jobs such as in the Director, Job, or Client resources will also
2018 apply in addition to any limit specified here. The default is set to 1, but
2019 you may set it to a larger number. However, if you set the Storage
2020 daemon's number of concurrent jobs greater than one,
2021 we recommend that you read the
2022 waring documented under \ilink{Maximum Concurrent Jobs}{DirMaxConJobs}
2023 in the Director's resource or simply turn data spooling on as documented
2024 in the \ilink{Data Spooling}{SpoolingChapter} chapter of this manual.
2027 The following is an example of a valid Storage resource definition:
2031 # Definition of tape storage device
2035 Password = storage_password # password for Storage daemon
2036 Device = "HP DLT 80" # same as Device in Storage daemon
2037 Media Type = DLT8000 # same as MediaType in Storage daemon
2042 \subsection*{The Pool Resource}
2043 \label{PoolResource}
2044 \index[general]{Resource!Pool}
2045 \index[general]{Pool Resource}
2046 \addcontentsline{toc}{subsection}{Pool Resource}
2048 The Pool resource defines the set of storage Volumes (tapes or files) to be
2049 used by Bacula to write the data. By configuring different Pools, you can
2050 determine which set of Volumes (media) receives the backup data. This permits,
2051 for example, to store all full backup data on one set of Volumes and all
2052 incremental backups on another set of Volumes. Alternatively, you could assign
2053 a different set of Volumes to each machine that you backup. This is most
2054 easily done by defining multiple Pools.
2056 Another important aspect of a Pool is that it contains the default attributes
2057 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2058 Volume when it is created. This avoids the need for you to answer a large
2059 number of questions when labeling a new Volume. Each of these attributes can
2060 later be changed on a Volume by Volume basis using the {\bf update} command in
2061 the console program. Note that you must explicitly specify which Pool Bacula
2062 is to use with each Job. Bacula will not automatically search for the correct
2065 Most often in Bacula installations all backups for all machines (Clients) go
2066 to a single set of Volumes. In this case, you will probably only use the {\bf
2067 Default} Pool. If your backup strategy calls for you to mount a different tape
2068 each day, you will probably want to define a separate Pool for each day. For
2069 more information on this subject, please see the
2070 \ilink{Backup Strategies}{_ChapterStart3} chapter of this
2074 To use a Pool, there are three distinct steps. First the Pool must be defined
2075 in the Director's configuration file. Then the Pool must be written to the
2076 Catalog database. This is done automatically by the Director each time that it
2077 starts, or alternatively can be done using the {\bf create} command in the
2078 console program. Finally, if you change the Pool definition in the Director's
2079 configuration file and restart Bacula, the pool will be updated alternatively
2080 you can use the {\bf update pool} console command to refresh the database
2081 image. It is this database image rather than the Director's resource image
2082 that is used for the default Volume attributes. Note, for the pool to be
2083 automatically created or updated, it must be explicitly referenced by a Job
2086 Next the physical media must be labeled. The labeling can either be done with
2087 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2088 program. The preferred method is to use the {\bf label} command in the {\bf
2091 Finally, you must add Volume names (and their attributes) to the Pool. For
2092 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2093 archive device specified for the job (i.e. if you are going to back up to a
2094 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2095 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2096 are backing up to files. When running a Job, you must explicitly specify which
2097 Pool to use. Bacula will then automatically select the next Volume to use from
2098 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2099 from the Pool is identical to that required by the Storage resource you have
2100 specified for the Job.
2102 If you use the {\bf label} command in the console program to label the
2103 Volumes, they will automatically be added to the Pool, so this last step is
2104 not normally required.
2106 It is also possible to add Volumes to the database without explicitly labeling
2107 the physical volume. This is done with the {\bf add} console command.
2109 As previously mentioned, each time Bacula starts, it scans all the Pools
2110 associated with each Catalog, and if the database record does not already
2111 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2112 probably should do an {\bf update pool} if you change the Pool definition, but
2113 currently, you must do this manually using the {\bf update pool} command in
2114 the Console program.
2116 The Pool Resource defined in the Director's configuration file
2117 (bacula-dir.conf) may contain the following directives:
2123 \index[dir]{Directive!Pool}
2124 Start of the Pool resource. There must be at least one Pool resource
2128 \item [Name = \lt{}name\gt{}]
2130 \index[dir]{Directive!Name}
2131 The name of the pool. For most applications, you will use the default
2132 pool name {\bf Default}. This directive is required.
2135 \item [Maximum Volumes = \lt{}number\gt{}]
2136 \index[dir]{Maximum Volumes}
2137 \index[dir]{Directive!Maximum Volumes}
2138 This directive specifies the maximum number of volumes (tapes or files)
2139 contained in the pool. This directive is optional, if omitted or set to
2140 zero, any number of volumes will be permitted. In general, this
2141 directive is useful for Autochangers where there is a fixed number of
2142 Volumes, or for File storage where you wish to ensure that the backups
2143 made to disk files do not become too numerous or consume too much space.
2145 \item [Pool Type = \lt{}type\gt{}]
2146 \index[dir]{Pool Type}
2147 \index[dir]{Directive!Pool Type}
2148 This directive defines the pool type, which corresponds to the type of
2149 Job being run. It is required and may be one of the following:
2160 \item [Use Volume Once = \lt{}yes|no\gt{}]
2161 \index[dir]{Use Volume Once}
2162 \index[dir]{Directive!Use Volume Once}
2163 This directive if set to {\bf yes} specifies that each volume is to be
2164 used only once. This is most useful when the Media is a file and you
2165 want a new file for each backup that is done. The default is {\bf no}
2166 (i.e. use volume any number of times). This directive will most likely
2167 be phased out (deprecated), so you are recommended to use {\bf Maximum
2168 Volume Jobs = 1} instead.
2170 The value defined by this directive in the bacula-dir.conf file is the
2171 default value used when a Volume is created. Once the volume is
2172 created, changing the value in the bacula-dir.conf file will not change
2173 what is stored for the Volume. To change the value for an existing
2174 Volume you must use the {\bf update} command in the Console.
2176 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2177 \index[dir]{Maximum Volume Jobs}
2178 \index[dir]{Directive!Maximum Volume Jobs}
2179 This directive specifies the maximum number of Jobs that can be written
2180 to the Volume. If you specify zero (the default), there is no limit.
2181 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2182 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2183 is marked {\bf Used} it can no longer be used for appending Jobs, much
2184 like the {\bf Full} status but it can be recycled if recycling is
2185 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2186 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2188 The value defined by this directive in the bacula-dir.conf
2189 file is the default value used when a Volume is created. Once the volume is
2190 created, changing the value in the bacula-dir.conf file will not change what
2191 is stored for the Volume. To change the value for an existing Volume you
2192 must use the {\bf update} command in the Console.
2194 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2195 \index[dir]{Maximum Volume Files}
2196 \index[dir]{Directive!Maximum Volume Files}
2197 This directive specifies the maximum number of files that can be written
2198 to the Volume. If you specify zero (the default), there is no limit.
2199 Otherwise, when the number of files written to the Volume equals {\bf
2200 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2201 is marked {\bf Used} it can no longer be used for appending Jobs, much
2202 like the {\bf Full} status but it can be recycled if recycling is
2203 enabled and thus used again. This value is checked and the {\bf Used}
2204 status is set only at the end of a job that writes to the particular
2207 The value defined by this directive in the bacula-dir.conf file is the
2208 default value used when a Volume is created. Once the volume is
2209 created, changing the value in the bacula-dir.conf file will not change
2210 what is stored for the Volume. To change the value for an existing
2211 Volume you must use the {\bf update} command in the Console.
2213 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2214 \index[dir]{Maximum Volume Bytes}
2215 \index[dir]{Directive!Maximum Volume Bytes}
2216 This directive specifies the maximum number of bytes that can be written
2217 to the Volume. If you specify zero (the default), there is no limit
2218 except the physical size of the Volume. Otherwise, when the number of
2219 bytes written to the Volume equals {\bf size} the Volume will be marked
2220 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2221 used for appending Jobs, much like the {\bf Full} status but it can be
2222 recycled if recycling is enabled, and thus the Volume can be re-used
2223 after recycling. This value is checked and the {\bf Used} status set
2224 while the job is writing to the particular volume.
2226 The value defined by this directive in the bacula-dir.conf file is the
2227 default value used when a Volume is created. Once the volume is
2228 created, changing the value in the bacula-dir.conf file will not change
2229 what is stored for the Volume. To change the value for an existing
2230 Volume you must use the {\bf update} command in the Console.
2232 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2233 \index[dir]{Volume Use Duration}
2234 \index[dir]{Directive!Volume Use Duration}
2235 The Volume Use Duration directive defines the time period that the
2236 Volume can be written beginning from the time of first data write to the
2237 Volume. If the time-period specified is zero (the default), the Volume
2238 can be written indefinitely. Otherwise, the next time a job
2239 runs that wants to access this Volume, and the time period from the
2240 first write to the volume (the first Job written) exceeds the
2241 time-period-specification, the Volume will be marked {\bf Used}, which
2242 means that no more Jobs can be appended to the Volume, but it may be
2243 recycled if recycling is enabled. Using the command {\bf
2244 status dir} applies algorithms similar to running jobs, so
2245 during such a command, the Volume status may also be changed.
2247 recycled, it will be available for use again.
2249 You might use this directive, for example, if you have a Volume used for
2250 Incremental backups, and Volumes used for Weekly Full backups. Once the
2251 Full backup is done, you will want to use a different Incremental
2252 Volume. This can be accomplished by setting the Volume Use Duration for
2253 the Incremental Volume to six days. I.e. it will be used for the 6
2254 days following a Full save, then a different Incremental volume will be
2255 used. Be careful about setting the duration to short periods such as 23
2256 hours, or you might experience problems of Bacula waiting for a tape
2257 over the weekend only to complete the backups Monday morning when an
2258 operator mounts a new tape.
2260 The use duration is checked and the {\bf Used} status is set only at the
2261 end of a job that writes to the particular volume, which means that even
2262 though the use duration may have expired, the catalog entry will not be
2263 updated until the next job that uses this volume is run.
2265 Please note that the value defined by this directive in the bacula-dir.conf
2266 file is the default value used when a Volume is created. Once the volume is
2267 created, changing the value in the bacula-dir.conf file will not change what
2268 is stored for the Volume. To change the value for an existing Volume you
2270 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2272 \item [Catalog Files = \lt{}yes|no\gt{}]
2273 \index[dir]{Catalog Files}
2274 \index[dir]{Directive!Catalog Files}
2275 This directive defines whether or not you want the names of the files
2276 that were saved to be put into the catalog. The default is {\bf yes}.
2277 The advantage of specifying {\bf Catalog Files = No} is that you will
2278 have a significantly smaller Catalog database. The disadvantage is that
2279 you will not be able to produce a Catalog listing of the files backed up
2280 for each Job (this is often called Browsing). Also, without the File
2281 entries in the catalog, you will not be able to use the Console {\bf
2282 restore} command nor any other command that references File entries.
2284 \label{PoolAutoPrune}
2285 \item [AutoPrune = \lt{}yes|no\gt{}]
2286 \index[dir]{AutoPrune}
2287 \index[dir]{Directive!AutoPrune}
2288 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2289 will automatically apply the Volume Retention period when new Volume is
2290 needed and no appendable Volumes exist in the Pool. Volume pruning causes
2291 expired Jobs (older than the {\bf Volume Retention} period) to be deleted
2292 from the Catalog and permits possible recycling of the Volume.
2294 \label{VolRetention}
2295 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2296 \index[dir]{Volume Retention}
2297 \index[dir]{Directive!Volume Retention}
2298 The Volume Retention directive defines the length of time that {\bf
2299 Bacula} will keep Job records associated with the Volume in the Catalog
2300 database. When this time period expires, and if {\bf AutoPrune} is set
2301 to {\bf yes} Bacula may prune (remove) Job records that are older than
2302 the specified Volume Retention period if it is necessary to free up a
2303 Volume. Recycling will not occur until it is absolutely necessary to
2304 free up a volume. All File records associated with pruned Jobs are also
2305 pruned. The time may be specified as seconds, minutes, hours, days,
2306 weeks, months, quarters, or years. The {\bf Volume Retention} is
2307 applied independently of the {\bf Job Retention} and the {\bf File
2308 Retention} periods defined in the Client resource. This means that all
2309 the retentions periods are applied in turn and that the shorter period
2310 is the one that effectively takes precedence. Note, that when the {\bf
2311 Volume Retention} period has been reached, and it is necessary to obtain
2312 a new volume, Bacula will prune both the Job and the File records.
2313 This pruning could also occur during a {\bf status dir}
2314 command because it uses similar algorithms for finding the
2315 next available Volume.
2317 It is important to know that when the Volume Retention period expires,
2318 Bacula does not automatically recycle a Volume. It attempts to keep the
2319 Volume data intact as long as possible before over writing the Volume.
2321 The default Volume retention period is 365 days. Note, this directive
2322 sets the default value for each Volume entry in the Catalog when the
2323 Volume is created. The value in the catalog may be later individually
2324 changed for each Volume using the Console program.
2326 By defining multiple Pools with different Volume Retention periods, you
2327 may effectively have a set of tapes that is recycled weekly, another
2328 Pool of tapes that is recycled monthly and so on. However, one must
2329 keep in mind that if your {\bf Volume Retention} period is too short, it
2330 may prune the last valid Full backup, and hence until the next Full
2331 backup is done, you will not have a complete backup of your system, and
2332 in addition, the next Incremental or Differential backup will be
2333 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2334 Retention} period should be at twice the interval of your Full backups.
2335 This means that if you do a Full backup once a month, the minimum Volume
2336 retention period should be two months.
2338 Please note that the value defined by this directive in the bacula-dir.conf
2339 file is the default value used when a Volume is created. Once the volume is
2340 created, changing the value in the bacula-dir.conf file will not change what
2341 is stored for the Volume. To change the value for an existing Volume you
2342 must use the {\bf update} command in the Console.
2345 \item [Recycle = \lt{}yes|no\gt{}]
2346 \index[dir]{Recycle}
2347 \index[dir]{Directive!Recycle}
2348 This directive specifies whether or not Purged Volumes may be recycled.
2349 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2350 none that are appendable, it will search for and recycle (reuse) Purged
2351 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2352 deleted from the Catalog). If the Volume is recycled, all previous data
2353 written to that Volume will be overwritten. If Recycle is set to {\bf
2354 no}, the Volume will not be recycled, and hence, the data will remain
2355 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2356 is no (0 in the catalog), you may manually set the recycle flag (update
2357 command) for a Volume to be reused.
2359 Please note that the value defined by this directive in the
2360 bacula-dir.conf file is the default value used when a Volume is created.
2361 Once the volume is created, changing the value in the bacula-dir.conf
2362 file will not change what is stored for the Volume. To change the value
2363 for an existing Volume you must use the {\bf update} command in the
2366 \label{RecycleOldest}
2367 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2368 \index[dir]{Recycle Oldest Volume}
2369 \index[dir]{Directive!Recycle Oldest Volume}
2370 This directive instructs the Director to search for the oldest used
2371 Volume in the Pool when another Volume is requested by the Storage
2372 daemon and none are available. The catalog is then {\bf pruned}
2373 respecting the retention periods of all Files and Jobs written to this
2374 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2375 Volume is recycled and will be used as the next Volume to be written.
2376 This directive respects any Job, File, or Volume retention periods that
2377 you may have specified, and as such it is {\bf much} better to use this
2378 directive than the Purge Oldest Volume.
2380 This directive can be useful if you have a fixed number of Volumes in the
2381 Pool and you want to cycle through them and you have specified the correct
2384 However, if you use this directive and have only one
2385 Volume in the Pool, you will immediately recycle your Volume if you fill
2386 it and Bacula needs another one. Thus your backup will be totally invalid.
2387 Please use this directive with care. The default is {\bf no}.
2389 \label{RecycleCurrent}
2391 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2392 \index[dir]{Recycle Current Volume}
2393 \index[dir]{Directive!Recycle Current Volume}
2394 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2395 the volume respecting the Job and File retention periods. If all Jobs
2396 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2397 will be used as the next Volume to be written. This directive respects
2398 any Job, File, or Volume retention periods that you may have specified,
2399 and thus it is {\bf much} better to use it rather than the Purge Oldest
2402 This directive can be useful if you have: a fixed number of Volumes in
2403 the Pool, you want to cycle through them, and you have specified
2404 retention periods that prune Volumes before you have cycled through the
2407 However, if you use this directive and have only one Volume in the Pool,
2408 you will immediately recycle your Volume if you fill it and Bacula needs
2409 another one. Thus your backup will be totally invalid. Please use this
2410 directive with care. The default is {\bf no}.
2414 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2415 \index[dir]{Purge Oldest Volume}
2416 \index[dir]{Directive!Purge Oldest Volume}
2417 This directive instructs the Director to search for the oldest used
2418 Volume in the Pool when another Volume is requested by the Storage
2419 daemon and none are available. The catalog is then {\bf purged}
2420 irrespective of retention periods of all Files and Jobs written to this
2421 Volume. The Volume is then recycled and will be used as the next Volume
2422 to be written. This directive overrides any Job, File, or Volume
2423 retention periods that you may have specified.
2425 This directive can be useful if you have a fixed number of Volumes in
2426 the Pool and you want to cycle through them and reusing the oldest one
2427 when all Volumes are full, but you don't want to worry about setting
2428 proper retention periods. However, by using this option you risk losing
2431 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2432 periods. If you have only a single Volume defined and you turn this
2433 variable on, that Volume will always be immediately overwritten when it
2434 fills! So at a minimum, ensure that you have a decent number of Volumes
2435 in your Pool before running any jobs. If you want retention periods to
2436 apply do not use this directive. To specify a retention period, use the
2437 {\bf Volume Retention} directive (see above).
2439 We {\bf highly} recommend against using this directive, because it is
2440 sure that some day, Bacula will recycle a Volume that contains current
2441 data. The default is {\bf no}.
2443 \item [Cleaning Prefix = \lt{}string\gt{}]
2444 \index[dir]{Cleaning Prefix}
2445 \index[dir]{Directive!Cleaning Prefix}
2446 This directive defines a prefix string, which if it matches the
2447 beginning of a Volume name during labeling of a Volume, the Volume will
2448 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2449 never attempt to use this tape. This is primarily for use with
2450 autochangers that accept barcodes where the convention is that barcodes
2451 beginning with {\bf CLN} are treated as cleaning tapes.
2454 \item [Label Format = \lt{}format\gt{}]
2455 \index[dir]{Label Format}
2456 \index[dir]{Directive!Label Format}
2457 This directive specifies the format of the labels contained in this
2458 pool. The format directive is used as a sort of template to create new
2459 Volume names during automatic Volume labeling.
2461 The {\bf format} should be specified in double quotes, and consists of
2462 letters, numbers and the special characters hyphen ({\bf -}), underscore
2463 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2464 characters for a Volume name. The {\bf format} should be enclosed in
2467 In addition, the format may contain a number of variable expansion
2468 characters which will be expanded by a complex algorithm allowing you to
2469 create Volume names of many different formats. In all cases, the
2470 expansion process must resolve to the set of characters noted above that
2471 are legal Volume names. Generally, these variable expansion characters
2472 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2473 specify variable expansion characters, you should always enclose the
2474 format with double quote characters ({\bf "}). For more details on
2475 variable expansion, please see the \ilink{Variable
2476 Expansion}{_ChapterStart50} Chapter of this manual.
2478 If no variable expansion characters are found in the string, the Volume
2479 name will be formed from the {\bf format} string appended with the
2480 number of volumes in the pool plus one, which will be edited as four
2481 digits with leading zeros. For example, with a {\bf Label Format =
2482 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2485 With the exception of Job specific variables, you can test your {\bf
2486 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2489 In almost all cases, you should enclose the format specification (part
2490 after the equal sign) in double quotes. Please note that this directive
2491 is deprecated and is replaced in version 1.37 and greater with a Python
2492 script for creating volume names.
2496 In order for a Pool to be used during a Backup Job, the Pool must have at
2497 least one Volume associated with it. Volumes are created for a Pool using
2498 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2499 program. In addition to adding Volumes to the Pool (i.e. putting the
2500 Volume names in the Catalog database), the physical Volume must be labeled
2501 with a valid Bacula software volume label before {\bf Bacula} will accept
2502 the Volume. This will be automatically done if you use the {\bf label}
2503 command. Bacula can automatically label Volumes if instructed to do so,
2504 but this feature is not yet fully implemented.
2506 The following is an example of a valid Pool resource definition:
2518 \subsubsection*{The Scratch Pool}
2519 \addcontentsline{toc}{subsection}{Scratch Pool}
2520 \index[general]{Scratch Pool}
2521 In general, you can give your Pools any name you wish, but there is one
2522 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2523 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2524 writing and it cannot find one, it will look in the Scratch pool, and if
2525 it finds an available Volume, it will move it out of the Scratch pool into
2526 the Pool currently being used by the job.
2529 \subsection*{The Catalog Resource}
2530 \label{CatalogResource}
2531 \index[general]{Resource!Catalog}
2532 \index[general]{Catalog Resource}
2533 \addcontentsline{toc}{subsection}{Catalog Resource}
2535 The Catalog Resource defines what catalog to use for the current job.
2536 Currently, Bacula can only handle a single database server (SQLite, MySQL,
2537 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
2538 may be as many Catalogs (databases) defined as you wish. For example, you
2539 may want each Client to have its own Catalog database, or you may want
2540 backup jobs to use one database and verify or restore jobs to use another
2546 \index[dir]{Catalog}
2547 \index[dir]{Directive!Catalog}
2548 Start of the Catalog resource. At least one Catalog resource must be
2552 \item [Name = \lt{}name\gt{}]
2554 \index[dir]{Directive!Name}
2555 The name of the Catalog. No necessary relation to the database server
2556 name. This name will be specified in the Client resource directive
2557 indicating that all catalog data for that Client is maintained in this
2558 Catalog. This directive is required.
2560 \item [password = \lt{}password\gt{}]
2561 \index[dir]{password}
2562 \index[dir]{Directive!password}
2563 This specifies the password to use when logging into the database. This
2564 directive is required.
2566 \item [DB Name = \lt{}name\gt{}]
2567 \index[dir]{DB Name}
2568 \index[dir]{Directive!DB Name}
2569 This specifies the name of the database. If you use multiple catalogs
2570 (databases), you specify which one here. If you are using an external
2571 database server rather than the internal one, you must specify a name
2572 that is known to the server (i.e. you explicitly created the Bacula
2573 tables using this name. This directive is required.
2575 \item [user = \lt{}user\gt{}]
2577 \index[dir]{Directive!user}
2578 This specifies what user name to use to log into the database. This
2579 directive is required.
2581 \item [DB Socket = \lt{}socket-name\gt{}]
2582 \index[dir]{DB Socket}
2583 \index[dir]{Directive!DB Socket}
2584 This is the name of a socket to use on the local host to connect to the
2585 database. This directive is used only by MySQL and is ignored by SQLite.
2586 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
2587 will use the default socket.
2589 \item [DB Address = \lt{}address\gt{}]
2590 \index[dir]{DB Address}
2591 \index[dir]{Directive!DB Address}
2592 This is the host address of the database server. Normally, you would specify
2593 this instead of {\bf DB Socket} if the database server is on another machine.
2594 In that case, you will also specify {\bf DB Port}. This directive is used
2595 only by MySQL and is ignored by SQLite if provided. This directive is
2598 \item [DB Port = \lt{}port\gt{}]
2599 \index[dir]{DB Port}
2600 \index[dir]{Directive!DB Port}
2601 This defines the port to be used in conjunction with {\bf DB Address} to
2602 access the database if it is on another machine. This directive is used only
2603 by MySQL and is ignored by SQLite if provided. This directive is optional.
2605 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
2606 %% \index[dir]{Multiple Connections}
2607 %% \index[dir]{Directive!Multiple Connections}
2608 %% By default, this directive is set to no. In that case, each job that uses
2610 %% same Catalog will use a single connection to the catalog. It will be shared,
2611 %% and Bacula will allow only one Job at a time to communicate. If you set this
2612 %% directive to yes, Bacula will permit multiple connections to the database,
2613 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
2614 %% this is no problem. For MySQL, you must be *very* careful to have the
2615 %% multi-thread version of the client library loaded on your system. When this
2616 %% directive is set yes, each Job will have a separate connection to the
2617 %% database, and the database will control the interaction between the
2619 %% Jobs. This can significantly speed up the database operations if you are
2620 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
2621 %% Bacula will automatically enable transactions. This can significantly speed
2622 %% up insertion of attributes in the database either for a single Job or
2623 %% multiple simultaneous Jobs.
2625 %% This directive has not been tested. Please test carefully before running it
2626 %% in production and report back your results.
2630 The following is an example of a valid Catalog resource definition:
2639 password = "" # no password = no security
2644 or for a Catalog on another machine:
2654 DB Address = remote.acme.com
2660 \subsection*{The Messages Resource}
2661 \label{MessagesResource2}
2662 \index[general]{Resource!Messages}
2663 \index[general]{Messages Resource}
2664 \addcontentsline{toc}{subsection}{Messages Resource}
2666 For the details of the Messages Resource, please see the
2667 \ilink{Messages Resource Chapter}{_ChapterStart15} of this
2670 \subsection*{The Console Resource}
2671 \label{ConsoleResource1}
2672 \index[general]{Console Resource}
2673 \index[general]{Resource!Console}
2674 \addcontentsline{toc}{subsection}{Console Resource}
2676 As of Bacula version 1.33 and higher, there are three different kinds of
2677 consoles, which the administrator or user can use to interact with the
2678 Director. These three kinds of consoles comprise three different security
2682 \item The first console type is an {\bf anonymous} or {\bf default} console,
2683 which has full privileges. There is no console resource necessary for
2684 this type since the password is specified in the Director's resource and
2685 consequently such consoles do not have a name as defined on a {\bf Name
2686 =} directive. This is the kind of console that was initially
2687 implemented in versions prior to 1.33 and remains valid. Typically you
2688 would use it only for administrators.
2690 \item The second type of console, and new to version 1.33 and higher is a
2691 "named" console defined within a Console resource in both the Director's
2692 configuration file and in the Console's configuration file. Both the
2693 names and the passwords in these two entries must match much as is the
2694 case for Client programs.
2696 This second type of console begins with absolutely no privileges except
2697 those explicitly specified in the Director's Console resource. Thus you
2698 can have multiple Consoles with different names and passwords, sort of
2699 like multiple users, each with different privileges. As a default,
2700 these consoles can do absolutely nothing -- no commands whatsoever. You
2701 give them privileges or rather access to commands and resources by
2702 specifying access control lists in the Director's Console resource. The
2703 ACLs are specified by a directive followed by a list of access names.
2704 Examples of this are shown below.
2706 \item The third type of console is similar to the above mentioned one in that
2707 it requires a Console resource definition in both the Director and the
2708 Console. In addition, if the console name, provided on the {\bf Name =}
2709 directive, is the same as a Client name, that console is permitted to
2710 use the {\bf SetIP} command to change the Address directive in the
2711 Director's client resource to the IP address of the Console. This
2712 permits portables or other machines using DHCP (non-fixed IP addresses)
2713 to "notify" the Director of their current IP address.
2716 The Console resource is optional and need not be specified. The following
2717 directives are permitted within the Director's configuration resource:
2721 \item [Name = \lt{}name\gt{}]
2723 \index[dir]{Directive!Name}
2724 The name of the console. This name must match the name specified in the
2725 Console's configuration resource (much as is the case with Client
2728 \item [Password = \lt{}password\gt{}]
2729 \index[dir]{Password}
2730 \index[dir]{Directive!Password}
2731 Specifies the password that must be supplied for a named Bacula Console
2732 to be authorized. The same password must appear in the {\bf Console}
2733 resource of the Console configuration file. For added security, the
2734 password is never actually passed across the network but rather a
2735 challenge response hash code created with the password. This directive
2736 is required. If you have either {\bf /dev/random} {\bf bc} on your
2737 machine, Bacula will generate a random password during the configuration
2738 process, otherwise it will be left blank.
2740 \item [JobACL = \lt{}name-list\gt{}]
2742 \index[dir]{Directive!JobACL}
2743 This directive is used to specify a list of Job resource names that can
2744 be accessed by the console. Without this directive, the console cannot
2745 access any of the Director's Job resources. Multiple Job resource names
2746 may be specified by separating them with commas, and/or by specifying
2747 multiple JobACL directives. For example, the directive may be specified
2752 JobACL = kernsave, "Backup client 1", "Backup client 2"
2753 JobACL = "RestoreFiles"
2758 With the above specification, the console can access the Director's resources
2759 for the four jobs named on the JobACL directives, but for no others.
2761 \item [ClientACL = \lt{}name-list\gt{}]
2762 \index[dir]{ClientACL}
2763 \index[dir]{Directive!ClientACL}
2764 This directive is used to specify a list of Client resource names that can
2766 accessed by the console.
2768 \item [StorageACL = \lt{}name-list\gt{}]
2769 \index[dir]{StorageACL}
2770 \index[dir]{Directive!StorageACL}
2771 This directive is used to specify a list of Storage resource names that can
2772 be accessed by the console.
2774 \item [ScheduleACL = \lt{}name-list\gt{}]
2775 \index[dir]{ScheduleACL}
2776 \index[dir]{Directive!ScheduleACL}
2777 This directive is used to specify a list of Schedule resource names that can
2778 be accessed by the console.
2780 \item [PoolACL = \lt{}name-list\gt{}]
2781 \index[dir]{PoolACL}
2782 \index[dir]{Directive!PoolACL}
2783 This directive is used to specify a list of Pool resource names that can be
2784 accessed by the console.
2786 \item [FileSetACL = \lt{}name-list\gt{}]
2787 \index[dir]{FileSetACL}
2788 \index[dir]{Directive!FileSetACL}
2789 This directive is used to specify a list of FileSet resource names that can
2790 be accessed by the console.
2792 \item [CatalogACL = \lt{}name-list\gt{}]
2793 \index[dir]{CatalogACL}
2794 \index[dir]{Directive!CatalogACL}
2795 This directive is used to specify a list of Catalog resource names that can
2796 be accessed by the console.
2798 \item [CommandACL = \lt{}name-list\gt{}]
2799 \index[dir]{CommandACL}
2800 \index[dir]{Directive!CommandACL}
2801 This directive is used to specify a list of of console commands that can be
2802 executed by the console.
2805 Aside from Director resource names and console command names, the special
2806 keyword {\bf *all*} can be specified in any of the above access control lists.
2807 When this keyword is present, any resource or command name (which ever is
2808 appropriate) will be accepted. For an example configuration file, please see
2810 \ilink{Console Configuration}{_ChapterStart36} chapter of this
2813 \subsection*{The Counter Resource}
2814 \label{CounterResource}
2815 \index[general]{Resource!Counter}
2816 \index[general]{Counter Resource}
2817 \addcontentsline{toc}{subsection}{Counter Resource}
2819 The Counter Resource defines a counter variable that can be accessed by
2820 variable expansion used for creating Volume labels with the {\bf LabelFormat}
2822 \ilink{LabelFormat}{Label} directive in this chapter for more
2828 \index[dir]{Counter}
2829 \index[dir]{Directive!Counter}
2830 Start of the Counter resource. Counter directives are optional.
2832 \item [Name = \lt{}name\gt{}]
2834 \index[dir]{Directive!Name}
2835 The name of the Counter. This is the name you will use in the variable
2836 expansion to reference the counter value.
2838 \item [Minimum = \lt{}integer\gt{}]
2839 \index[dir]{Minimum}
2840 \index[dir]{Directive!Minimum}
2841 This specifies the minimum value that the counter can have. It also becomes
2842 the default. If not supplied, zero is assumed.
2844 \item [Maximum = \lt{}integer\gt{}]
2845 \index[dir]{Maximum}
2846 \index[dir]{Directive!Maximum}
2847 \index[dir]{Directive!Maximum}
2848 This is the maximum value value that the counter can have. If not specified
2849 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
2850 the 31 power). When the counter is incremented past this value, it is reset
2853 \item [*WrapCounter = \lt{}counter-name\gt{}]
2854 \index[dir]{*WrapCounter}
2855 \index[dir]{Directive!*WrapCounter}
2856 If this value is specified, when the counter is incremented past the
2858 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
2859 is incremented. (This is not currently implemented).
2861 \item [Catalog = \lt{}catalog-name\gt{}]
2862 \index[dir]{Catalog}
2863 \index[dir]{Directive!Catalog}
2864 If this directive is specified, the counter and its values will be saved in
2865 the specified catalog. If this directive is not present, the counter will be
2866 redefined each time that Bacula is started.
2869 \subsection*{Example Director Configuration File}
2870 \label{SampleDirectorConfiguration}
2871 \index[general]{File!Example Director Configuration}
2872 \index[general]{Example Director Configuration File}
2873 \addcontentsline{toc}{subsection}{Example Director Configuration File}
2875 An example Director configuration file might be the following:
2880 # Default Bacula Director Configuration file
2882 # The only thing that MUST be changed is to add one or more
2883 # file or directory names in the Include directive of the
2886 # For Bacula release 1.15 (5 March 2002) -- redhat
2888 # You might also want to change the default email address
2889 # from root to your address. See the "mail" and "operator"
2890 # directives in the Messages resource.
2892 Director { # define myself
2894 QueryFile = "/home/kern/bacula/bin/query.sql"
2895 WorkingDirectory = "/home/kern/bacula/bin/working"
2896 PidDirectory = "/home/kern/bacula/bin/working"
2897 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
2899 # Define the backup Job
2901 Name = "NightlySave"
2903 Level = Incremental # default
2906 Schedule = "WeeklyCycle"
2916 Where = /tmp/bacula-restores
2922 # List of files to be backed up
2926 Options { signature=SHA1}
2928 # Put your list of files here, one per line or include an
2929 # external list with:
2933 # Note: / backs up everything
2938 # When to do the backups
2940 Name = "WeeklyCycle"
2941 Run = Full sun at 1:05
2942 Run = Incremental mon-sat at 1:05
2944 # Client (File Services) to backup
2949 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
2950 File Retention = 60d # sixty day file retention
2951 Job Retention = 1y # 1 year Job retention
2952 AutoPrune = yes # Auto apply retention periods
2954 # Definition of DLT tape storage device
2958 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2959 Device = "HP DLT 80" # same as Device in Storage daemon
2960 Media Type = DLT8000 # same as MediaType in Storage daemon
2962 # Definition for a DLT autochanger device
2966 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2967 Device = "Autochanger" # same as Device in Storage daemon
2968 Media Type = DLT-8000 # Different from DLTDrive
2971 # Definition of DDS tape storage device
2975 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2976 Device = SDT-10000 # same as Device in Storage daemon
2977 Media Type = DDS-4 # same as MediaType in Storage daemon
2979 # Definition of 8mm tape storage device
2983 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2984 Device = "Exabyte 8mm"
2987 # Definition of file storage device
2991 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2992 Device = FileStorage
2995 # Generic catalog service
2998 dbname = bacula; user = bacula; password = ""
3000 # Reasonable message delivery -- send most everything to
3001 # the email address and to the console
3004 mail = root@localhost = all, !skipped, !terminate
3005 operator = root@localhost = mount
3006 console = all, !skipped, !saved
3009 # Default pool definition
3017 # Restricted console used by tray-monitor to get the status of the director
3021 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3022 CommandACL = status, .status