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}
216 \index[general]{Address}
217 \index[dir]{Directive!DirAddresses}
218 Specify the ports and addresses on which the Director daemon will listen
219 for Bacula Console connections. Probably the simplest way to explain
220 this is to show an example:
225 ip = { addr = 1.2.3.4; port = 1205;}
227 addr = 1.2.3.4; port = http;}
236 ip = { addr = 1.2.3.4 }
237 ip = { addr = 201:220:222::2 }
239 addr = bluedot.thun.net
245 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
246 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
247 a symbolic name (only in the ip specification). Also, port can be specified
248 as a number or as the mnemonic value from the /etc/services file. If a port
249 is not specified, the default will be used. If an ip section is specified,
250 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
251 only IPv4 resolutions will be permitted, and likewise with ip6.
253 Please note that if you use the DirAddresses directive, you must
254 not use either a DirPort or a DirAddress directive in the same
257 \item [DirPort = \lt{}port-number\gt{}]
259 \index[dir]{Directive!DirPort}
260 Specify the port (a positive integer) on which the Director daemon will
261 listen for Bacula Console connections. This same port number must be
262 specified in the Director resource of the Console configuration file. The
263 default is 9101, so normally this directive need not be specified. This
264 directive should not be used if you specify DirAddresses (not plural)
267 \item [DirAddress = \lt{}IP-Address\gt{}]
268 \index[dir]{DirAddress}
269 \index[dir]{Directive!DirAddress}
270 This directive is optional, but if it is specified, it will cause the
271 Director server (for the Console program) to bind to the specified {\bf
272 IP-Address}, which is either a domain name or an IP address specified as a
273 dotted quadruple in string or quoted string format. If this directive is not
274 specified, the Director will bind to any available address (the default).
275 Note, unlike the DirAddresses specification noted above, this directive only
276 permits a single address to be specified. This directive should not be used if you
277 specify a DirAddresses (note plural) directive.
280 The following is an example of a valid Director resource definition:
286 WorkingDirectory = "$HOME/bacula/bin/working"
287 Password = UA_password
288 PidDirectory = "$HOME/bacula/bin/working"
289 QueryFile = "$HOME/bacula/bin/query.sql"
295 \subsection*{The Job Resource}
297 \index[general]{Resource!Job}
298 \index[general]{Job Resource}
299 \addcontentsline{toc}{subsection}{Job Resource}
301 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
302 perform. Each Job resource definition contains the name of a Client and
303 a FileSet to backup, the Schedule for the Job, where the data
304 are to be stored, and what media Pool can be used. In effect, each Job
305 resource must specify What, Where, How, and When or FileSet, Storage,
306 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
307 be specified for a restore job for historical reasons, but it is no longer used.
309 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
310 job. If you want to backup multiple FileSets on the same Client or multiple
311 Clients, you must define a Job for each one.
317 \index[dir]{Directive!Job}
318 Start of the Job resource. At least one Job resource is required.
320 \item [Name = \lt{}name\gt{}]
322 \index[dir]{Directive!Name}
323 The Job name. This name can be specified on the {\bf Run} command in the
324 console program to start a job. If the name contains spaces, it must be
325 specified between quotes. It is generally a good idea to give your job the
326 same name as the Client that it will backup. This permits easy
327 identification of jobs.
329 When the job actually runs, the unique Job Name will consist of the name you
330 specify here followed by the date and time the job was scheduled for
331 execution. This directive is required.
333 \item [Enabled = \lt{}yes|no\gt{}]
335 \index[dir]{Directive!Enable}
336 This directive allows you to enable or disable automatic execution
337 via the scheduler of a Job.
339 \item [Type = \lt{}job-type\gt{}]
341 \index[dir]{Directive!Type}
342 The {\bf Type} directive specifies the Job type, which may be one of the
343 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
344 directive is required. Within a particular Job Type, there are also Levels
345 as discussed in the next item.
351 Run a backup Job. Normally you will have at least one Backup job for each
352 client you want to save. Normally, unless you turn off cataloging, most all
353 the important statistics and data concerning files backed up will be placed
358 Run a restore Job. Normally, you will specify only one Restore job
359 which acts as a sort of prototype that you will modify using the console
360 program in order to perform restores. Although certain basic
361 information from a Restore job is saved in the catalog, it is very
362 minimal compared to the information stored for a Backup job -- for
363 example, no File database entries are generated since no Files are
368 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
369 contents of the catalog to the file system, or to what was backed up. In
370 addition, to verifying that a tape that was written can be read, you can
371 also use {\bf verify} as a sort of tripwire intrusion detection.
375 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
376 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
377 Although an Admin job is recorded in the catalog, very little data is saved.
382 \item [Level = \lt{}job-level\gt{}]
384 \index[dir]{Directive!Level}
385 The Level directive specifies the default Job level to be run. Each
386 different Job Type (Backup, Restore, ...) has a different set of Levels
387 that can be specified. The Level is normally overridden by a different
388 value that is specified in the {\bf Schedule} resource. This directive
389 is not required, but must be specified either by a {\bf Level} directive
390 or as an override specified in the {\bf Schedule} resource.
392 For a {\bf Backup} Job, the Level may be one of the following:
398 When the Level is set to Full all files in the FileSet whether or not
399 they have changed will be backed up.
402 \index[dir]{Incremental}
403 When the Level is set to Incremental all files specified in the FileSet
404 that have changed since the last successful backup of the the same Job
405 using the same FileSet and Client, will be backed up. If the Director
406 cannot find a previous valid Full backup then the job will be upgraded
407 into a Full backup. When the Director looks for a valid backup record
408 in the catalog database, it looks for a previous Job with:
411 \item The same Job name.
412 \item The same Client name.
413 \item The same FileSet (any change to the definition of the FileSet such as
414 adding or deleting a file in the Include or Exclude sections constitutes a
416 \item The Job was a Full, Differential, or Incremental backup.
417 \item The Job terminated normally (i.e. did not fail or was not canceled).
420 If all the above conditions do not hold, the Director will upgrade the
421 Incremental to a Full save. Otherwise, the Incremental backup will be
422 performed as requested.
424 The File daemon (Client) decides which files to backup for an
425 Incremental backup by comparing start time of the prior Job (Full,
426 Differential, or Incremental) against the time each file was last
427 "modified" (st\_mtime) and the time its attributes were last
428 "changed"(st\_ctime). If the file was modified or its attributes
429 changed on or after this start time, it will then be backed up.
431 Some virus scanning software may change st\_ctime while
432 doing the scan. For example, if the virus scanning program attempts to
433 reset the access time (st\_atime), which Bacula does not use, it will
434 cause st\_ctime to change and hence Bacula will backup the file during
435 an Incremental or Differential backup. In the case of Sophos virus
436 scanning, you can prevent it from resetting the access time (st\_atime)
437 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
438 option. For other software, please see their manual.
440 When Bacula does an Incremental backup, all modified files that are
441 still on the system are backed up. However, any file that has been
442 deleted since the last Full backup remains in the Bacula catalog, which
443 means that if between a Full save and the time you do a restore, some
444 files are deleted, those deleted files will also be restored. The
445 deleted files will no longer appear in the catalog after doing another
446 Full save. However, to remove deleted files from the catalog during an
447 Incremental backup is quite a time consuming process and not currently
448 implemented in Bacula.
450 In addition, if you move a directory rather than copy it, the files in
451 it do not have their modification time (st\_mtime) or their attribute
452 change time (st\_ctime) changed. As a consequence, those files will
453 probably not be backed up by an Incremental or Differential backup which
454 depend solely on these time stamps. If you move a directory, and wish
455 it to be properly backed up, it is generally preferable to copy it, then
459 \index[dir]{Differential}
460 When the Level is set to Differential
461 all files specified in the FileSet that have changed since the last
462 successful Full backup of the same Job will be backed up.
463 If the Director cannot find a
464 valid previous Full backup for the same Job, FileSet, and Client,
465 backup, then the Differential job will be upgraded into a Full backup.
466 When the Director looks for a valid Full backup record in the catalog
467 database, it looks for a previous Job with:
470 \item The same Job name.
471 \item The same Client name.
472 \item The same FileSet (any change to the definition of the FileSet such as
473 adding or deleting a file in the Include or Exclude sections constitutes a
475 \item The Job was a FULL backup.
476 \item The Job terminated normally (i.e. did not fail or was not canceled).
479 If all the above conditions do not hold, the Director will upgrade the
480 Differential to a Full save. Otherwise, the Differential backup will be
481 performed as requested.
483 The File daemon (Client) decides which files to backup for a
484 differential backup by comparing the start time of the prior Full backup
485 Job against the time each file was last "modified" (st\_mtime) and the
486 time its attributes were last "changed" (st\_ctime). If the file was
487 modified or its attributes were changed on or after this start time, it
488 will then be backed up. The start time used is displayed after the {\bf
489 Since} on the Job report. In rare cases, using the start time of the
490 prior backup may cause some files to be backed up twice, but it ensures
491 that no change is missed. As with the Incremental option, you should
492 ensure that the clocks on your server and client are synchronized or as
493 close as possible to avoid the possibility of a file being skipped.
494 Note, on versions 1.33 or greater Bacula automatically makes the
495 necessary adjustments to the time between the server and the client so
496 that the times Bacula uses are synchronized.
498 When Bacula does a Differential backup, all modified files that are
499 still on the system are backed up. However, any file that has been
500 deleted since the last Full backup remains in the Bacula catalog, which
501 means that if between a Full save and the time you do a restore, some
502 files are deleted, those deleted files will also be restored. The
503 deleted files will no longer appear in the catalog after doing another
504 Full save. However, to remove deleted files from the catalog during a
505 Differential backup is quite a time consuming process and not currently
506 implemented in Bacula. It is, however, a planned future feature.
508 As noted above, if you move a directory rather than copy it, the
509 files in it do not have their modification time (st\_mtime) or
510 their attribute change time (st\_ctime) changed. As a
511 consequence, those files will probably not be backed up by an
512 Incremental or Differential backup which depend solely on these
513 time stamps. If you move a directory, and wish it to be
514 properly backed up, it is generally preferable to copy it, then
515 delete the original. Alternatively, you can move the directory, then
516 use the {\bf touch} program to update the timestamps.
518 Every once and a while, someone asks why we need Differential
519 backups as long as Incremental backups pickup all changed files.
520 There are possibly many answers to this question, but the one
521 that is the most important for me is that a Differential backup
523 all the Incremental and Differential backups since the last Full backup
524 into a single Differential backup. This has two effects: 1. It gives
525 some redundancy since the old backups could be used if the merged backup
526 cannot be read. 2. More importantly, it reduces the number of Volumes
527 that are needed to do a restore effectively eliminating the need to read
528 all the volumes on which the preceding Incremental and Differential
529 backups since the last Full are done.
533 For a {\bf Restore} Job, no level needs to be specified.
535 For a {\bf Verify} Job, the Level may be one of the following:
540 \index[dir]{InitCatalog}
541 does a scan of the specified {\bf FileSet} and stores the file
542 attributes in the Catalog database. Since no file data is saved, you
543 might ask why you would want to do this. It turns out to be a very
544 simple and easy way to have a {\bf Tripwire} like feature using {\bf
545 Bacula}. In other words, it allows you to save the state of a set of
546 files defined by the {\bf FileSet} and later check to see if those files
547 have been modified or deleted and if any new files have been added.
548 This can be used to detect system intrusion. Typically you would
549 specify a {\bf FileSet} that contains the set of system files that
550 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
551 run the {\bf InitCatalog} level verify one time when your system is
552 first setup, and then once again after each modification (upgrade) to
553 your system. Thereafter, when your want to check the state of your
554 system files, you use a {\bf Verify} {\bf level = Catalog}. This
555 compares the results of your {\bf InitCatalog} with the current state of
560 Compares the current state of the files against the state previously
561 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
562 items reported are determined by the {\bf verify} options specified on
563 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
564 FileSet} resource below for more details). Typically this command will
565 be run once a day (or night) to check for any changes to your system
568 Please note! If you run two Verify Catalog jobs on the same client at
569 the same time, the results will certainly be incorrect. This is because
570 Verify Catalog modifies the Catalog database while running in order to
573 \item [VolumeToCatalog]
574 \index[dir]{VolumeToCatalog}
575 This level causes Bacula to read the file attribute data written to the
576 Volume from the last Job. The file attribute data are compared to the
577 values saved in the Catalog database and any differences are reported.
578 This is similar to the {\bf Catalog} level except that instead of
579 comparing the disk file attributes to the catalog database, the
580 attribute data written to the Volume is read and compared to the catalog
581 database. Although the attribute data including the signatures (MD5 or
582 SHA1) are compared, the actual file data is not compared (it is not in
585 Please note! If you run two Verify VolumeToCatalog jobs on the same
586 client at the same time, the results will certainly be incorrect. This
587 is because the Verify VolumeToCatalog modifies the Catalog database
590 \item [DiskToCatalog]
591 \index[dir]{DiskToCatalog}
592 This level causes Bacula to read the files as they currently are on
593 disk, and to compare the current file attributes with the attributes
594 saved in the catalog from the last backup for the job specified on the
595 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
596 level described above by the fact that it doesn't compare against a
597 previous Verify job but against a previous backup. When you run this
598 level, you must supply the verify options on your Include statements.
599 Those options determine what attribute fields are compared.
601 This command can be very useful if you have disk problems because it
602 will compare the current state of your disk against the last successful
603 backup, which may be several jobs.
605 Note, the current implementation (1.32c) does not identify files that
609 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
610 \index[dir]{Verify Job}
611 \index[dir]{Directive!Verify Job}
612 If you run a verify job without this directive, the last job run will be
613 compared with the catalog, which means that you must immediately follow
614 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
615 will find the last job with that name that ran. This permits you to run
616 all your backups, then run Verify jobs on those that you wish to be
617 verified (most often a {\bf VolumeToCatalog}) so that the tape just
620 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
622 \index[dir]{Directive!JobDefs}
623 If a JobDefs-Resource-Name is specified, all the values contained in the
624 named JobDefs resource will be used as the defaults for the current Job.
625 Any value that you explicitly define in the current Job resource, will
626 override any defaults specified in the JobDefs resource. The use of
627 this directive permits writing much more compact Job resources where the
628 bulk of the directives are defined in one or more JobDefs. This is
629 particularly useful if you have many similar Jobs but with minor
630 variations such as different Clients. A simple example of the use of
631 JobDefs is provided in the default bacula-dir.conf file.
633 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
634 \index[dir]{Bootstrap}
635 \index[dir]{Directive!Bootstrap}
636 The Bootstrap directive specifies a bootstrap file that, if provided,
637 will be used during {\bf Restore} Jobs and is ignored in other Job
638 types. The {\bf bootstrap} file contains the list of tapes to be used
639 in a restore Job as well as which files are to be restored.
640 Specification of this directive is optional, and if specified, it is
641 used only for a restore job. In addition, when running a Restore job
642 from the console, this value can be changed.
644 If you use the {\bf Restore} command in the Console program, to start a
645 restore job, the {\bf bootstrap} file will be created automatically from
646 the files you select to be restored.
648 For additional details of the {\bf bootstrap} file, please see
649 \ilink{Restoring Files with the Bootstrap File}{_ChapterStart43} chapter
652 \label{writebootstrap}
653 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
654 \index[dir]{Write Bootstrap}
655 \index[dir]{Directive!Write Bootstrap}
656 The {\bf writebootstrap} directive specifies a file name where Bacula
657 will write a {\bf bootstrap} file for each Backup job run. Thus this
658 directive applies only to Backup Jobs. If the Backup job is a Full
659 save, Bacula will erase any current contents of the specified file
660 before writing the bootstrap records. If the Job is an Incremental
661 save, Bacula will append the current bootstrap record to the end of the
664 Using this feature, permits you to constantly have a bootstrap file that
665 can recover the current state of your system. Normally, the file
666 specified should be a mounted drive on another machine, so that if your
667 hard disk is lost, you will immediately have a bootstrap record
668 available. Alternatively, you should copy the bootstrap file to another
669 machine after it is updated.
671 If the {\bf bootstrap-file-specification} begins with a vertical bar
672 (|), Bacula will use the specification as the name of a program to which
673 it will pipe the bootstrap record. It could for example be a shell
674 script that emails you the bootstrap record.
676 For more details on using this file, please see the chapter entitled
677 \ilink{The Bootstrap File}{_ChapterStart43} of this manual.
679 \item [Client = \lt{}client-resource-name\gt{}]
681 \index[dir]{Directive!Client}
682 The Client directive specifies the Client (File daemon) that will be used in
683 the current Job. Only a single Client may be specified in any one Job. The
684 Client runs on the machine to be backed up, and sends the requested files to
685 the Storage daemon for backup, or receives them when restoring. For
686 additional details, see the
687 \ilink{Client Resource section}{ClientResource2} of this chapter.
688 This directive is required.
690 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
693 The FileSet directive specifies the FileSet that will be used in the
694 current Job. The FileSet specifies which directories (or files) are to
695 be backed up, and what options to use (e.g. compression, ...). Only a
696 single FileSet resource may be specified in any one Job. For additional
697 details, see the \ilink{FileSet Resource section}{FileSetResource} of
698 this chapter. This directive is required.
700 \item [Messages = \lt{}messages-resource-name\gt{}]
701 \index[dir]{Messages}
702 \index[dir]{Directive!Messages}
703 The Messages directive defines what Messages resource should be used for
704 this job, and thus how and where the various messages are to be
705 delivered. For example, you can direct some messages to a log file, and
706 others can be sent by email. For additional details, see the
707 \ilink{Messages Resource}{_ChapterStart15} Chapter of this manual. This
708 directive is required.
710 \item [Pool = \lt{}pool-resource-name\gt{}]
712 \index[dir]{Directive!Pool}
713 The Pool directive defines the pool of Volumes where your data can be
714 backed up. Many Bacula installations will use only the {\bf Default}
715 pool. However, if you want to specify a different set of Volumes for
716 different Clients or different Jobs, you will probably want to use
717 Pools. For additional details, see the \ilink{Pool Resource
718 section}{PoolResource} of this chapter. This directive is required.
720 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
721 \index[dir]{Full Backup Pool}
722 \index[dir]{Directive!Full Backup Pool}
723 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
724 It will override any Pool specification during a Full backup. This
725 directive is optional.
727 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
728 \index[dir]{Differential Backup Pool}
729 \index[dir]{Directive!Differential Backup Pool}
730 The {\it Differential Backup Pool} specifies a Pool to be used for
731 Differential backups. It will override any Pool specification during a
732 Differential backup. This directive is optional.
734 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
735 \index[dir]{Incremental Backup Pool}
736 \index[dir]{Directive!Incremental Backup Pool}
737 The {\it Incremental Backup Pool} specifies a Pool to be used for
738 Incremental backups. It will override any Pool specification during an
739 Incremental backup. This directive is optional.
741 \item [Schedule = \lt{}schedule-name\gt{}]
742 \index[dir]{Schedule}
743 \index[dir]{Directive!Schedule}
744 The Schedule directive defines what schedule is to be used for the Job.
745 The schedule in turn determines when the Job will be automatically
746 started and what Job level (i.e. Full, Incremental, ...) is to be run.
747 This directive is optional, and if left out, the Job can only be started
748 manually using the Console program. Although you may specify only a
749 single Schedule resource for any one job, the Schedule resource may
750 contain multiple {\bf Run} directives, which allow you to run the Job at
751 many different times, and each {\bf run} directive permits overriding
752 the default Job Level Pool, Storage, and Messages resources. This gives
753 considerable flexibility in what can be done with a single Job. For
754 additional details, see the \ilink{Schedule Resource
755 Chapter}{ScheduleResource} of this manual.
758 \item [Storage = \lt{}storage-resource-name\gt{}]
760 \index[dir]{Directive!Storage}
761 The Storage directive defines the name of the storage services where you
762 want to backup the FileSet data. For additional details, see the
763 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
764 This directive is required.
766 \item [Max Start Delay = \lt{}time\gt{}]
767 \index[dir]{Max Start Delay}
768 \index[dir]{Directive!Max Start Delay}
769 The time specifies the maximum delay between the scheduled time and the
770 actual start time for the Job. For example, a job can be scheduled to
771 run at 1:00am, but because other jobs are running, it may wait to run.
772 If the delay is set to 3600 (one hour) and the job has not begun to run
773 by 2:00am, the job will be canceled. This can be useful, for example,
774 to prevent jobs from running during day time hours. The default is 0
775 which indicates no limit.
777 \item [Max Run Time = \lt{}time\gt{}]
778 \index[dir]{Max Run Time}
779 \index[dir]{Directive!Max Run Time}
780 The time specifies the maximum allowed time that a job may run, counted
781 from when the job starts, ({\bf not} necessarily the same as when the
782 job was scheduled). This directive is implemented in version 1.33 and
785 \item [Max Wait Time = \lt{}time\gt{}]
786 \index[dir]{Max Wait Time}
787 \index[dir]{Directive!Max Wait Time}
788 The time specifies the maximum allowed time that a job may block waiting
789 for a resource (such as waiting for a tape to be mounted, or waiting for
790 the storage or file daemons to perform their duties), counted from the
791 when the job starts, ({\bf not} necessarily the same as when the job was
792 scheduled). This directive is implemented only in version 1.33 and
795 \item [Incremental Max Wait Time = \lt{}time\gt{}]
796 \index[dir]{Incremental Max Wait Time}
797 \index[dir]{Directive!Incremental Max Wait Time}
798 The time specifies the maximum allowed time that an Incremental backup
799 job may block waiting for a resource (such as waiting for a tape to be
800 mounted, or waiting for the storage or file daemons to perform their
801 duties), counted from the when the job starts, ({\bf not} necessarily
802 the same as when the job was scheduled). Please note that if there is a
803 {\bf Max Wait Time} it may also be applied to the job.
805 \item [Differential Max Wait Time = \lt{}time\gt{}]
806 \index[dir]{Differential Max Wait Time}
807 \index[dir]{Directive!Differential Max Wait Time}
808 The time specifies the maximum allowed time that a Differential backup
809 job may block waiting for a resource (such as waiting for a tape to be
810 mounted, or waiting for the storage or file daemons to perform their
811 duties), counted from the when the job starts, ({\bf not} necessarily
812 the same as when the job was scheduled). Please note that if there is a
813 {\bf Max Wait Time} it may also be applied to the job.
815 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
816 \index[dir]{Prefer Mounted Volumes}
817 \index[dir]{Directive!Prefer Mounted Volumes}
818 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
819 yes), the Storage daemon is requested to select either an Autochanger or
820 a drive with a valid Volume already mounted in preference to a drive
821 that is not ready. If no drive with a suitable Volume is available, it
822 will select the first available drive.
824 If the directive is set to {\bf no}, the Storage daemon will prefer
825 finding an unused drive, otherwise, each job started will append to the
826 same Volume (assuming the Pool is the same for all jobs). Setting
827 Prefer Mounted Volumes to no can be useful for those sites particularly
828 with multiple drive autochangers that prefer to maximumize backup
829 throughput at the expense of using additional drives and Volumes. As an
830 optimization, when using multiple drives, you will probably want to
831 start each of your jobs one after another with approximately 5 second
832 intervals. This will help ensure that each night, the same drive
833 (Volume) is selected for the same job, otherwise, when you do a restore,
834 you may find the files spread over many more Volumes than necessary.
837 \item [Prune Jobs = \lt{}yes|no\gt{}]
838 \index[dir]{Prune Jobs}
839 \index[dir]{Directive!Prune Jobs}
840 Normally, pruning of Jobs from the Catalog is specified on a Client by
841 Client basis in the Client resource with the {\bf AutoPrune} directive.
842 If this directive is specified (not normally) and the value is {\bf
843 yes}, it will override the value specified in the Client resource. The
847 \item [Prune Files = \lt{}yes|no\gt{}]
848 \index[dir]{Prune Files}
849 \index[dir]{Directive!Prune Files}
850 Normally, pruning of Files from the Catalog is specified on a Client by
851 Client basis in the Client resource with the {\bf AutoPrune} directive.
852 If this directive is specified (not normally) and the value is {\bf
853 yes}, it will override the value specified in the Client resource. The
856 \item [Prune Volumes = \lt{}yes|no\gt{}]
857 \index[dir]{Prune Volumes}
858 \index[dir]{Directive!Prune Volumes}
859 Normally, pruning of Volumes from the Catalog is specified on a Client
860 by Client basis in the Client resource with the {\bf AutoPrune}
861 directive. If this directive is specified (not normally) and the value
862 is {\bf yes}, it will override the value specified in the Client
863 resource. The default is {\bf no}.
865 \item [RunScript \{...\}]
866 \index[dir]{RunScript}
867 \index[dir]{Directive!Run Script}
869 The specified {\bf command} is run as an external program prior or after the
870 current Job. This directive is optional.
872 You can use following options:\\
874 \begin{tabular}{|c|c|c|l}
875 Options & Value & Default & Informations \\
878 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
880 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
882 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
884 Runs When & Before|After|Always & {\it Never} & When run commands\\
886 Abort Job On Error & Yes/No & {\it Yes} & Abort job if script return
887 something different from 0 \\
889 Command & & & Path to your script\\
894 Any output sent by the command to standard output will be included in the
895 Bacula job report. The command string must be a valid program name or name
898 In addition, the command string is parsed then fed to the execvp() function,
899 which means that the path will be searched to execute your specified
900 command, but there is no shell interpretation, as a consequence, if you
901 invoke complicated commands or want any shell features such as redirection
902 or piping, you must call a shell script and do it inside that script.
904 Before submitting the specified command to the operating system, Bacula
905 performs character substitution of the following characters:
918 %t = Job type (Backup, ...)
924 The Job Exit Status code \%e edits the following values:
926 \index[dir]{Exit Status}
933 \item Unknown term code
936 Thus if you edit it on a command line, you will need to enclose
937 it within some sort of quotes.
940 You can use these following shortcuts:\\
942 \begin{tabular}{|c|c|c|c|c|c}
943 Keyword & RunsOnSuccess & RunsOnFailure & AbortJobOnError & Runs On Client & RunsWhen \\
945 Run Before Job & & & Yes & No & Before \\
947 Run After Job & Yes & No & & No & After \\
949 Run After Failed Job & No & Yes & & No & After \\
951 Client Run Before Job & & & Yes & Yes & Before \\
953 Client Run After Job & Yes & No & & Yes & After \\
955 Client Run After Failed Job & No & Yes & & Yes & After \\
963 Command = "/etc/init.d/apache stop"
969 Command = "/etc/init.d/apache start"
973 {\bf Special Windows Considerations}
975 In addition, for a Windows client on version 1.33 and above, please take
976 careful note that you must ensure a correct path to your script. The
977 script or program can be a .com, .exe or a .bat file. However, if you
978 specify a path, you must also specify the full extension. Unix like
979 commands will not work unless you have installed and properly configured
980 Cygwin in addition to and separately from Bacula.
982 The command can be anything that cmd.exe or command.com will recognize
983 as an executable file. Specifying the executable's extension is
984 optional, unless there is an ambiguity. (i.e. ls.bat, ls.exe)
986 The System \%Path\% will be searched for the command. (under the
987 environment variable dialog you have have both System Environment and
988 User Environment, we believe that only the System environment will be
989 available to bacula-fd, if it is running as a service.)
991 System environment variables can be referenced with \%var\% and
992 used as either part of the command name or arguments.
997 ClientRunBeforeJob = "\"C:/Program Files/Software
998 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1002 The special characters \&()[]\{\}\^{}=;!'+,`\~{} will need to be quoted
1003 if they are part of a filename or argument.
1005 If someone is logged in, a blank "command" window running the commands
1006 will be present during the execution of the command.
1008 Some Suggestions from Phil Stracchino for running on Win32 machines with
1009 the native Win32 File daemon:
1012 \item You might want the ClientRunBeforeJob directive to specify a .bat
1013 file which runs the actual client-side commands, rather than trying
1014 to run (for example) regedit /e directly.
1015 \item The batch file should explicitly 'exit 0' on successful completion.
1016 \item The path to the batch file should be specified in Unix form:
1018 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1020 rather than DOS/Windows form:
1022 ClientRunBeforeJob =
1024 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1028 The following example of the use of the Client Run Before Job directive was
1029 submitted by a user:\\
1030 You could write a shell script to back up a DB2 database to a FIFO. The shell
1040 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1045 The following line in the Job resource in the bacula-dir.conf file:
1048 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1053 When the job is run, you will get messages from the output of the script
1054 stating that the backup has started. Even though the command being run is
1055 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1056 command, thus the backup stalls.
1058 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1063 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1068 It is important to redirect the input and outputs of a backgrounded command to
1069 /dev/null to prevent the script from blocking.
1071 \item [Run Before Job = \lt{}command\gt{}]
1072 \index[dir]{Run Before Job}
1073 \index[dir]{Directive!Run Before Job}
1074 \index[dir]{Directive!Run Before Job}
1075 The specified {\bf command} is run as an external program prior to running the
1076 current Job. This directive is not required, but if it is defined, and if the
1077 exit code of the program run is non-zero, the current Bacula job will be
1081 Run Before Job = "echo test"
1083 it's equivalent to :
1086 Command = "echo test"
1092 Lutz Kittler has pointed out that using the RunBeforJob directive can be a
1093 simple way to modify your schedules during a holiday. For example, suppose
1094 that you normally do Full backups on Fridays, but Thursday and Friday are
1095 holidays. To avoid having to change tapes between Thursday and Friday when
1096 no one is in the office, you can create a RunBeforeJob that returns a
1097 non-zero status on Thursday and zero on all other days. That way, the
1098 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1099 before leaving will be used.
1101 \item [Run After Job = \lt{}command\gt{}]
1102 \index[dir]{Run After Job}
1103 \index[dir]{Directive!Run After Job}
1104 The specified {\bf command} is run as an external program if the current
1105 job terminates normally (without error or without being canceled). This
1106 directive is not required. If the exit code of the program run is
1107 non-zero, Bacula will print a warning message. Before submitting the
1108 specified command to the operating system, Bacula performs character
1109 substitution as described above for the {\bf RunScript} directive.
1111 An example of the use of this directive is given in the
1112 \ilink{Tips Chapter}{JobNotification} of this manual.
1114 See the {\bf Run After Failed Job} if you
1115 want to run a script after the job has terminated with any
1118 \item [Run After Failed Job = \lt{}command\gt{}]
1119 \index[dir]{Run After Job}
1120 \index[dir]{Directive!Run After Job}
1121 The specified {\bf command} is run as an external program after the current
1122 job terminates with any error status. This directive is not required. The
1123 command string must be a valid program name or name of a shell script. If
1124 the exit code of the program run is non-zero, Bacula will print a
1125 warning message. Before submitting the specified command to the
1126 operating system, Bacula performs character substitution as described above
1127 for the {\bf RunScript} directive. Note, if you wish that your script
1128 will run regardless of the exit status of the Job, you can use this :
1131 Command = "echo test"
1135 RunsOnSuccess = yes # default, you can drop this line
1139 An example of the use of this directive is given in the
1140 \ilink{Tips Chapter}{JobNotification} of this manual.
1143 \item [Client Run Before Job = \lt{}command\gt{}]
1144 \index[dir]{Client Run Before Job}
1145 \index[dir]{Directive!Client Run Before Job}
1146 This directive is the same as {\bf Run Before Job} except that the
1147 program is run on the client machine. The same restrictions apply to
1148 Unix systems as noted above for the {\bf RunScript}.
1150 \item [Client Run After Job = \lt{}command\gt{}]
1151 \index[dir]{Client Run After Job}
1152 \index[dir]{Directive!Client Run After Job}
1153 This directive is the same as {\bf Run After Job} except that it is run on
1154 the client machine. Note, please see the notes above in {\bf RunScript}
1155 concerning Windows clients.
1157 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
1158 \index[dir]{Rerun Failed Levels}
1159 \index[dir]{Directive!Rerun Failed Levels}
1160 If this directive is set to {\bf yes} (default no), and Bacula detects that
1161 a previous job at a higher level (i.e. Full or Differential) has failed,
1162 the current job level will be upgraded to the higher level. This is
1163 particularly useful for Laptops where they may often be unreachable, and if
1164 a prior Full save has failed, you wish the very next backup to be a Full
1165 save rather than whatever level it is started as.
1167 \item [Spool Data = \lt{}yes|no\gt{}]
1168 \index[dir]{Spool Data}
1169 \index[dir]{Directive!Spool Data}
1170 If this directive is set to {\bf yes} (default no), the Storage daemon will
1171 be requested to spool the data for this Job to disk rather than write it
1172 directly to tape. Once all the data arrives or the spool files' maximum sizes
1173 are reached, the data will be despooled and written to tape. When this
1174 directive is set to yes, the Spool Attributes is also automatically set to
1175 yes. Spooling data prevents tape shoe-shine (start and stop) during
1176 Incremental saves. This option should not be used if you are writing to a
1179 \item [Spool Attributes = \lt{}yes|no\gt{}]
1180 \index[dir]{Spool Attributes}
1181 \index[dir]{Directive!Spool Attributes}
1183 \index[general]{slow}
1184 \index[dir]{Backups!slow}
1185 \index[general]{Backups!slow}
1186 The default is set to {\bf no}, which means that the File attributes are
1188 by the Storage daemon to the Director as they are stored on tape. However,
1189 if you want to avoid the possibility that database updates will slow down
1190 writing to the tape, you may want to set the value to {\bf yes}, in which
1191 case the Storage daemon will buffer the File attributes and Storage
1192 coordinates to a temporary file in the Working Directory, then when writing
1193 the Job data to the tape is completed, the attributes and storage coordinates
1194 will be sent to the Director.
1196 \item [Where = \lt{}directory\gt{}]
1198 \index[dir]{Directive!Where}
1199 This directive applies only to a Restore job and specifies a prefix to
1200 the directory name of all files being restored. This permits files to
1201 be restored in a different location from which they were saved. If {\bf
1202 Where} is not specified or is set to backslash ({\bf /}), the files will
1203 be restored to their original location. By default, we have set {\bf
1204 Where} in the example configuration files to be {\bf
1205 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1208 \item [Replace = \lt{}replace-option\gt{}]
1209 \index[dir]{Replace}
1210 \index[dir]{Directive!Replace}
1211 This directive applies only to a Restore job and specifies what happens
1212 when Bacula wants to restore a file or directory that already exists.
1213 You have the following options for {\bf replace-option}:
1219 when the file to be restored already exists, it is deleted and then
1220 replaced by the copy that was backed up.
1223 \index[dir]{ifnewer}
1224 if the backed up file (on tape) is newer than the existing file, the
1225 existing file is deleted and replaced by the back up.
1228 \index[dir]{ifolder}
1229 if the backed up file (on tape) is older than the existing file, the
1230 existing file is deleted and replaced by the back up.
1234 if the backed up file already exists, Bacula skips restoring this file.
1237 \item [Prefix Links=\lt{}yes|no\gt{}]
1238 \index[dir]{Prefix Links}
1239 \index[dir]{Directive!Prefix Links}
1240 If a {\bf Where} path prefix is specified for a recovery job, apply it
1241 to absolute links as well. The default is {\bf No}. When set to {\bf
1242 Yes} then while restoring files to an alternate directory, any absolute
1243 soft links will also be modified to point to the new alternate
1244 directory. Normally this is what is desired -- i.e. everything is self
1245 consistent. However, if you wish to later move the files to their
1246 original locations, all files linked with absolute names will be broken.
1248 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1249 \index[dir]{Maximum Concurrent Jobs}
1250 \index[dir]{Directive!Maximum Concurrent Jobs}
1251 where \lt{}number\gt{} is the maximum number of Jobs from the current
1252 Job resource that can run concurrently. Note, this directive limits
1253 only Jobs with the same name as the resource in which it appears. Any
1254 other restrictions on the maximum concurrent jobs such as in the
1255 Director, Client, or Storage resources will also apply in addition to
1256 the limit specified here. The default is set to 1, but you may set it
1257 to a larger number. We strongly recommend that you read the WARNING
1258 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1259 Director's resource.
1261 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1262 \index[dir]{Reschedule On Error}
1263 \index[dir]{Directive!Reschedule On Error}
1264 If this directive is enabled, and the job terminates in error, the job
1265 will be rescheduled as determined by the {\bf Reschedule Interval} and
1266 {\bf Reschedule Times} directives. If you cancel the job, it will not
1267 be rescheduled. The default is {\bf no} (i.e. the job will not be
1271 This specification can be useful for portables, laptops, or other
1272 machines that are not always connected to the network or switched on.
1274 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1275 \index[dir]{Reschedule Interval}
1276 \index[dir]{Directive!Reschedule Interval}
1277 If you have specified {\bf Reschedule On Error = yes} and the job
1278 terminates in error, it will be rescheduled after the interval of time
1279 specified by {\bf time-specification}. See \ilink{the time
1280 specification formats}{Time} in the Configure chapter for details of
1281 time specifications. If no interval is specified, the job will not be
1282 rescheduled on error.
1284 \item [Reschedule Times = \lt{}count\gt{}]
1285 \index[dir]{Reschedule Times}
1286 \index[dir]{Directive!Reschedule Times}
1287 This directive specifies the maximum number of times to reschedule the
1288 job. If it is set to zero (the default) the job will be rescheduled an
1289 indefinite number of times.
1291 \item [Run = \lt{}job-name\gt{}]
1293 \index[dir]{Directive!Run}
1294 \index[dir]{Clone a Job}
1295 The Run directive (not to be confused with the Run option in a
1296 Schedule) allows you to start other jobs or to clone jobs. By using the
1297 cloning keywords (see below), you can backup
1298 the same data (or almost the same data) to two or more drives
1299 at the same time. The {\bf job-name} is normally the same name
1300 as the current Job resource (thus creating a clone). However, it
1301 may be any Job name, so one job may start other related jobs.
1303 The part after the equal sign must be enclosed in double quotes,
1304 and can contain any string or set of options (overrides) that you
1305 can specify when entering the Run command from the console. For
1306 example {\bf storage=DDS-4 ...}. In addition, there are two special
1307 keywords that permit you to clone the current job. They are {\bf level=\%l}
1308 and {\bf since=\%s}. The \%l in the level keyword permits
1309 entering the actual level of the current job and the \%s in the since
1310 keyword permits putting the same time for comparison as used on the
1311 current job. Note, in the case of the since keyword, the \%s must be
1312 enclosed in double quotes, and thus they must be preceded by a backslash
1313 since they are already inside quotes. For example:
1316 run = "Nightly-backup level=%s since=\"%s\" storage=DDS-4"
1320 A cloned job will not start additional clones, so it is not
1321 possible to recurse.
1326 \item [Priority = \lt{}number\gt{}]
1327 \index[dir]{Priority}
1328 \index[dir]{Directive!Priority}
1329 This directive permits you to control the order in which your jobs run
1330 by specifying a positive non-zero number. The higher the number, the
1331 lower the job priority. Assuming you are not running concurrent jobs,
1332 all queued jobs of priority 1 will run before queued jobs of priority 2
1333 and so on, regardless of the original scheduling order.
1335 The priority only affects waiting jobs that are queued to run, not jobs
1336 that are already running. If one or more jobs of priority 2 are already
1337 running, and a new job is scheduled with priority 1, the currently
1338 running priority 2 jobs must complete before the priority 1 job is run.
1340 The default priority is 10.
1342 If you want to run concurrent jobs you should
1343 keep these points in mind:
1346 \item To run concurrent jobs, you must set Maximum Concurrent Jobs = 2 in 5
1347 or 6 distinct places: in bacula-dir.conf in the Director, the Job, the
1348 Client, the Storage resources; in bacula-fd in the FileDaemon (or
1349 Client) resource, and in bacula-sd.conf in the Storage resource. If any
1350 one is missing, it will throttle the jobs to one at a time. You may, of
1351 course, set the Maximum Concurrent Jobs to more than 2.
1352 \item Bacula concurrently runs jobs of only one priority at a time. It
1353 will not simultaneously run a priority 1 and a priority 2 job.
1354 \item If Bacula is running a priority 2 job and a new priority 1 job is
1355 scheduled, it will wait until the running priority 2 job terminates even
1356 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1357 to run simultaneously.
1358 \item Suppose that bacula is running a priority 2 job and a new priority 1
1359 job is scheduled and queued waiting for the running priority 2 job to
1360 terminate. If you then start a second priority 2 job, the waiting
1361 priority 1 job will prevent the new priority 2 job from running
1362 concurrently with the running priority 2 job. That is: as long as there
1363 is a higher priority job waiting to run, no new lower priority jobs will
1364 start even if the Maximum Concurrent Jobs settings would normally allow
1365 them to run. This ensures that higher priority jobs will be run as soon
1369 If you have several jobs of different priority, it may not best to start
1370 them at exactly the same time, because Bacula must examine them one at a
1371 time. If by Bacula starts a lower priority job first, then it will run
1372 before your high priority jobs. If you experience this problem, you may
1373 avoid it by starting any higher priority jobs a few seconds before lower
1374 priority ones. This insures that Bacula will examine the jobs in the
1375 correct order, and that your priority scheme will be respected.
1377 \label{WritePartAfterJob}
1378 \item [Write Part After Job = \lt{}yes|no\gt{}]
1379 \index[dir]{Write Part After Job}
1380 \index[dir]{Directive!Write Part After Job}
1381 This directive is only implemented in version 1.37 and later.
1382 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1383 will be created after the job is finished.
1385 It should be set to {\bf yes} when writing to devices that require mount
1386 (for example DVD), so you are sure that the current part, containing
1387 this job's data, is written to the device, and that no data is left in
1388 the temporary file on the hard disk. However, on some media, like DVD+R
1389 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1390 written. So, if you run several jobs each after another, you could set
1391 this directive to {\bf no} for all jobs, except the last one, to avoid
1392 wasting too much space, but to ensure that the data is written to the
1393 medium when all jobs are finished.
1395 It is ignored with tape and FIFO devices.
1398 The following is an example of a valid Job resource definition:
1405 Level = Incremental # default
1407 FileSet="Minou Full Set"
1410 Schedule = "MinouWeeklyCycle"
1416 \subsection*{The JobDefs Resource}
1417 \label{JobDefsResource}
1418 \index[general]{JobDefs Resource}
1419 \index[general]{Resource!JobDefs}
1420 \addcontentsline{toc}{subsection}{JobDefs Resource}
1422 The JobDefs resource permits all the same directives that can appear in a Job
1423 resource. However, a JobDefs resource does not create a Job, rather it can be
1424 referenced within a Job to provide defaults for that Job. This permits you to
1425 concisely define several nearly identical Jobs, each one referencing a JobDefs
1426 resource which contains the defaults. Only the changes from the defaults need to
1427 be mentioned in each Job.
1429 \subsection*{The Schedule Resource}
1430 \label{ScheduleResource}
1431 \index[general]{Resource!Schedule}
1432 \index[general]{Schedule Resource}
1433 \addcontentsline{toc}{subsection}{Schedule Resource}
1435 The Schedule resource provides a means of automatically scheduling a Job as
1436 well as the ability to override the default Level, Pool, Storage and Messages
1437 resources. If a Schedule resource is not referenced in a Job, the Job can only
1438 be run manually. In general, you specify an action to be taken and when.
1443 \index[dir]{Schedule}
1444 \index[dir]{Directive!Schedule}
1445 Start of the Schedule directives. No {\bf Schedule} resource is
1446 required, but you will need at least one if you want Jobs to be
1447 automatically started.
1449 \item [Name = \lt{}name\gt{}]
1451 \index[dir]{Directive!Name}
1452 The name of the schedule being defined. The Name directive is required.
1454 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1456 \index[dir]{Directive!Run}
1457 The Run directive defines when a Job is to be run, and what overrides if
1458 any to apply. You may specify multiple {\bf run} directives within a
1459 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1460 multiple schedules). If you have two {\bf Run} directives that start at
1461 the same time, two Jobs will start at the same time (well, within one
1462 second of each other).
1464 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1465 Messages, and the Pool specifications provided in the Job resource. In
1466 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1467 specifications permit overriding the Pool specification according to
1468 what backup Job Level is in effect.
1470 By the use of overrides, you may customize a particular Job. For
1471 example, you may specify a Messages override for your Incremental
1472 backups that outputs messages to a log file, but for your weekly or
1473 monthly Full backups, you may send the output by email by using a
1474 different Messages override.
1476 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1477 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1478 or IncrementalPool, and the {\bf value} is as defined on the respective
1479 directive formats for the Job resource. You may specify multiple {\bf
1480 Job-overrides} on one {\bf Run} directive by separating them with one or
1481 more spaces or by separating them with a trailing comma. For example:
1487 \index[dir]{Directive!Level}
1488 is all files in the FileSet whether or not they have changed.
1490 \item [Level=Incremental]
1492 \index[dir]{Directive!Level}
1493 is all files that have changed since the last backup.
1497 \index[dir]{Directive!Pool}
1498 specifies to use the Pool named {\bf Weekly}.
1500 \item [Storage=DLT\_Drive]
1501 \index[dir]{Storage}
1502 \index[dir]{Directive!Storage}
1503 specifies to use {\bf DLT\_Drive} for the storage device.
1505 \item [Messages=Verbose]
1506 \index[dir]{Messages}
1507 \index[dir]{Directive!Messages}
1508 specifies to use the {\bf Verbose} message resource for the Job.
1510 \item [FullPool=Full]
1511 \index[dir]{FullPool}
1512 \index[dir]{Directive!FullPool}
1513 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1515 upgraded from another type to a full backup.
1517 \item [DifferentialPool=Differential]
1518 \index[dir]{DifferentialPool}
1519 \index[dir]{Directive!DifferentialPool}
1520 specifies to use the Pool named {\bf Differential} if the job is a
1521 differential backup.
1523 \item [IncrementalPool=Incremental]
1524 \index[dir]{IncrementalPool}
1525 \index[dir]{Directive!IncrementalPool}
1526 specifies to use the Pool named {\bf Incremental} if the job is an
1529 \item [SpoolData=yes|no]
1530 \index[dir]{SpoolData}
1531 \index[dir]{Directive!SpoolData}
1532 tells Bacula to request the Storage daemon to spool data to a disk file
1533 before putting it on tape.
1535 \item [WritePartAfterJob=yes|no]
1536 \index[dir]{WritePartAfterJob}
1537 \index[dir]{Directive!WritePartAfterJob}
1538 tells Bacula to request the Storage daemon to write the current part file to
1539 the device when the job is finished (see
1540 \ilink{Write Part After Job directive in the Job
1541 resource}{WritePartAfterJob}). Please note, this directive is implemented
1542 only in version 1.37 and later.
1546 {\bf Date-time-specification} determines when the Job is to be run. The
1547 specification is a repetition, and as a default Bacula is set to run a job at
1548 the beginning of the hour of every hour of every day of every week of every
1549 month of every year. This is not normally what you want, so you must specify
1550 or limit when you want the job to run. Any specification given is assumed to
1551 be repetitive in nature and will serve to override or limit the default
1552 repetition. This is done by specifying masks or times for the hour, day of the
1553 month, day of the week, week of the month, week of the year, and month when
1554 you want the job to run. By specifying one or more of the above, you can
1555 define a schedule to repeat at almost any frequency you want.
1557 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1558 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1559 is special in that you may either specify a day of the month such as 1, 2,
1560 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1561 Sunday. Finally, you may also specify a week qualifier to restrict the
1562 schedule to the first, second, third, fourth, or fifth week of the month.
1564 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1565 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1566 month} and {\bf hour} remain set to the defaults of every month and all
1569 Note, by default with no other specification, your job will run at the
1570 beginning of every hour. If you wish your job to run more than once in any
1571 given hour, you will need to specify multiple {\bf run} specifications each
1572 with a different minute.
1574 The date/time to run the Job can be specified in the following way in
1581 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1582 second | third | forth | fifth
1583 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1584 sunday | monday | tuesday | wednesday |
1585 thursday | friday | saturday
1586 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1587 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1588 aug | sep | oct | nov | dec | january |
1589 february | ... | december
1590 <daily-keyword> = daily
1591 <weekly-keyword> = weekly
1592 <monthly-keyword> = monthly
1593 <hourly-keyword> = hourly
1594 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1595 <number> = <digit> | <digit><number>
1596 <12hour> = 0 | 1 | 2 | ... 12
1597 <hour> = 0 | 1 | 2 | ... 23
1598 <minute> = 0 | 1 | 2 | ... 59
1599 <day> = 1 | 2 | ... 31
1600 <time> = <hour>:<minute> |
1601 <12hour>:<minute>am |
1603 <time-spec> = <at-keyword> <time> |
1605 <date-keyword> = <void-keyword> <weekly-keyword>
1606 <day-range> = <day>-<day>
1607 <month-range> = <month-keyword>-<month-keyword>
1608 <wday-range> = <wday-keyword>-<wday-keyword>
1609 <range> = <day-range> | <month-range> |
1611 <date> = <date-keyword> | <day> | <range>
1612 <date-spec> = <date> | <date-spec>
1613 <day-spec> = <day> | <wday-keyword> |
1614 <day-range> | <wday-range> |
1616 <day-spec> = <day> | <wday-keyword> |
1617 <day> | <wday-range> |
1618 <week-keyword> <wday-keyword> |
1619 <week-keyword> <wday-range>
1620 <month-spec> = <month-keyword> | <month-range> |
1622 <date-time-spec> = <month-spec> <day-spec> <time-spec>
1628 Note, the Week of Year specification wnn follows the ISO standard definition
1629 of the week of the year, where Week 1 is the week in which the first Thursday
1630 of the year occurs, or alternatively, the week which contains the 4th of
1631 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
1632 precedes the first ISO week (i.e. has the first few days of the year if any
1633 occur before Thursday). w00 is not defined by the ISO specification. A week
1634 starts with Monday and ends with Sunday.
1636 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
1637 with level full each Sunday at 1:05am and an incremental job Monday through
1638 Saturday at 1:05am is:
1643 Name = "WeeklyCycle"
1644 Run = Level=Full sun at 1:05
1645 Run = Level=Incremental mon-sat at 1:05
1650 An example of a possible monthly cycle is as follows:
1655 Name = "MonthlyCycle"
1656 Run = Level=Full Pool=Monthly 1st sun at 1:05
1657 Run = Level=Differential 2nd-5th sun at 1:05
1658 Run = Level=Incremental Pool=Daily mon-sat at 1:05
1663 The first of every month:
1669 Run = Level=Full on 1 at 1:05
1670 Run = Level=Incremental on 2-31 at 1:05
1681 Run = Level=Full hourly at 0:05
1682 Run = Level=Full hourly at 0:15
1683 Run = Level=Full hourly at 0:25
1684 Run = Level=Full hourly at 0:35
1685 Run = Level=Full hourly at 0:45
1686 Run = Level=Full hourly at 0:55
1691 \subsection*{Technical Notes on Schedules}
1692 \index[general]{Schedules!Technical Notes on}
1693 \index[general]{Technical Notes on Schedules}
1694 \addcontentsline{toc}{subsection}{Technical Notes on Schedules}
1696 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
1697 minute field to each schedule. The masks are hour, day of the month (mday),
1698 month, day of the week (wday), week of the month (wom), and week of the year
1699 (woy). The schedule is initialized to have the bits of each of these masks
1700 set, which means that at the beginning of every hour, the job will run. When
1701 you specify a month for the first time, the mask will be cleared and the bit
1702 corresponding to your selected month will be selected. If you specify a second
1703 month, the bit corresponding to it will also be added to the mask. Thus when
1704 Bacula checks the masks to see if the bits are set corresponding to the
1705 current time, your job will run only in the two months you have set. Likewise,
1706 if you set a time (hour), the hour mask will be cleared, and the hour you
1707 specify will be set in the bit mask and the minutes will be stored in the
1710 For any schedule you have defined, you can see how these bits are set by doing
1711 a {\bf show schedules} command in the Console program. Please note that the
1712 bit mask is zero based, and Sunday is the first day of the week (bit zero).
1716 \subsection*{The Client Resource}
1717 \label{ClientResource2}
1718 \index[general]{Resource!Client}
1719 \index[general]{Client Resource}
1720 \addcontentsline{toc}{subsection}{Client Resource}
1722 The Client resource defines the attributes of the Clients that are served by
1723 this Director; that is the machines that are to be backed up. You will need
1724 one Client resource definition for each machine to be backed up.
1728 \item [Client (or FileDaemon)]
1729 \index[dir]{Client (or FileDaemon)}
1730 \index[dir]{Directive!Client (or FileDaemon)}
1731 Start of the Client directives.
1733 \item [Name = \lt{}name\gt{}]
1735 \index[dir]{Directive!Name}
1736 The client name which will be used in the Job resource directive or in the
1737 console run command. This directive is required.
1739 \item [Address = \lt{}address\gt{}]
1740 \index[dir]{Address}
1741 \index[dir]{Directive!FD Address}
1742 \index[dir]{File Daemon Address}
1743 \index[dir]{Client Address}
1744 Where the address is a host name, a fully qualified domain name, or a
1745 network address in dotted quad notation for a Bacula File server daemon.
1746 This 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.
1793 \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:
1859 FDAddress = minimatou
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!SD Address}
1892 \index[dir]{Storage daemon Address}
1893 Where the address is a host name, a {\bf fully qualified domain name}, or an
1894 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
1895 will be transmitted to the File daemon who will then use it to contact the
1896 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
1897 the name but rather a fully qualified machine name or an IP address. This
1898 directive is required.
1900 \item [SD Port = \lt{}port\gt{}]
1901 \index[dir]{SD Port}
1902 \index[dir]{Directive!SD Port}
1903 Where port is the port to use to contact the storage daemon for information
1904 and to start jobs. This same port number must appear in the Storage resource
1905 of the Storage daemon's configuration file. The default is 9103.
1907 \item [Password = \lt{}password\gt{}]
1908 \index[dir]{Password}
1909 \index[dir]{Directive!Password}
1910 This is the password to be used when establishing a connection with the
1911 Storage services. This same password also must appear in the Director
1912 resource of the Storage daemon's configuration file. This directive is
1913 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1914 Bacula will generate a random password during the configuration process,
1915 otherwise it will be left blank.
1917 \item [Device = \lt{}device-name\gt{}]
1919 \index[dir]{Directive!Device}
1920 This directive specifies the Storage daemon's name of the device resource
1921 to be used for the storage. This name is not the physical device name, but
1922 the logical device name as defined on the {\bf Name} directive contained in
1923 the {\bf Device} resource definition of the {\bf Storage daemon}
1924 configuration file or if the device is an Autochanger, you must put the
1925 name as defined on the {\bf Name} directive contained in the {\bf
1926 Autochanger} resource definition of the {\bf Storage daemon}. You can
1927 specify any name you would like (even the device name if you prefer) up to
1928 a maximum of 127 characters in length. The physical device name associated
1929 with this device is specified in the {\bf Storage daemon} configuration
1930 file (as {\bf Archive Device}). Please take care not to define two
1931 different Storage resource directives in the Director that point to the
1932 same Device in the Storage daemon. Doing so may cause the Storage daemon
1933 to block (or hang) attempting to open the same device that is already open.
1934 This directive is required.
1937 \item [Media Type = \lt{}MediaType\gt{}]
1938 \index[dir]{Media Type}
1939 \index[dir]{Directive!Media Type}
1940 This directive specifies the Media Type to be used to store the data.
1941 This is an arbitrary string of characters up to 127 maximum that you
1942 define. It can be anything you want. However, it is best to make it
1943 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
1944 ...). In addition, it is essential that you make the {\bf Media Type}
1945 specification unique for each storage media type. If you have two DDS-4
1946 drives that have incompatible formats, or if you have a DDS-4 drive and
1947 a DDS-4 autochanger, you almost certainly should specify different {\bf
1948 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
1949 associated with the Job, Bacula can decide to use any Storage daemon
1950 that supports Media Type {\bf DDS-4} and on any drive that supports it.
1952 Currently Bacula permits only a single Media Type. Consequently, if
1953 you have a drive that supports more than one Media Type, you can
1954 give a unique string to Volumes with different intrinsic Media
1955 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
1956 those volumes will only be mounted on drives indicated with the
1957 dual type (DDS-3-4).
1959 If you want to tie Bacula to using a single Storage daemon or drive, you
1960 must specify a unique Media Type for that drive. This is an important
1961 point that should be carefully understood. Note, this applies equally
1962 to Disk Volumes. If you define more than one disk Device resource in
1963 your Storage daemon's conf file, the Volumes on those two devices are in
1964 fact incompatible because one can not be mounted on the other device
1965 since they are found in different directories. For this reason, you
1966 probably should use two different Media Types for your two disk Devices
1967 (even though you might think of them as both being File types). You can
1968 find more on this subject in the \ilink{Basic Volume
1969 Management}{_ChapterStart39} chapter of this manual.
1971 The {\bf MediaType} specified here, {\bf must} correspond to the {\bf
1972 Media Type} specified in the {\bf Device} resource of the {\bf Storage
1973 daemon} configuration file. This directive is required, and it is used
1974 by the Director and the Storage daemon to ensure that a Volume
1975 automatically selected from the Pool corresponds to the physical device.
1976 If a Storage daemon handles multiple devices (e.g. will write to
1977 various file Volumes on different partitions), this directive allows you
1978 to specify exactly which device.
1980 As mentioned above, the value specified in the Director's Storage resource
1981 must agree with the value specified in the Device resource in the {\bf
1982 Storage daemon's} configuration file. It is also an additional check so that
1983 you don't try to write data for a DLT onto an 8mm device.
1985 \label{Autochanger1}
1986 \item [Autochanger = \lt{}yes|no\gt{}]
1987 \index[dir]{Autochanger}
1988 \index[dir]{Directive!Autochanger}
1989 If you specify {\bf yes} for this command (the default is {\bf no}), when
1990 you use the {\bf label} command or the {\bf add} command to create a new
1991 Volume, {\bf Bacula} will also request the Autochanger Slot number.
1992 This simplifies creating database entries for Volumes in an autochanger.
1993 If you forget to specify the Slot, the autochanger will not be used.
1994 However, you may modify the Slot associated with a Volume at any time by
1995 using the {\bf update volume} command in the console program. When {\bf
1996 autochanger} is enabled, the algorithm used by Bacula to search for
1997 available volumes will be modified to consider only Volumes that are
1998 known to be in the autochanger's magazine. If no {\bf in changer}
1999 volume is found, Bacula will attempt recycling, pruning, ..., and if
2000 still no volume is found, Bacula will search for any volume whether or
2001 not in the magazine. By privileging in changer volumes, this procedure
2002 minimizes operator intervention. The default is {\bf no}.
2004 For the autochanger to be used, you must also specify {\bf Autochanger =
2005 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2006 configuration file as well as other important Storage daemon
2007 configuration information. Please consult the \ilink{Using
2008 Autochangers}{_ChapterStart18} manual of this chapter for the details of
2011 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2012 \index[dir]{Maximum Concurrent Jobs}
2013 \index[dir]{Directive!Maximum Concurrent Jobs}
2014 where \lt{}number\gt{} is the maximum number of Jobs with the current
2016 resource that can run concurrently. Note, this directive limits only Jobs
2017 for Jobs using this Storage daemon. Any other restrictions on the maximum
2018 concurrent jobs such as in the Director, Job, or Client resources will also
2019 apply in addition to any limit specified here. The default is set to 1, but
2020 you may set it to a larger number. However, if you set the Storage
2021 daemon's number of concurrent jobs greater than one,
2022 we recommend that you read the
2023 waring documented under \ilink{Maximum Concurrent Jobs}{DirMaxConJobs}
2024 in the Director's resource or simply turn data spooling on as documented
2025 in the \ilink{Data Spooling}{SpoolingChapter} chapter of this manual.
2028 The following is an example of a valid Storage resource definition:
2032 # Definition of tape storage device
2036 Password = storage_password # password for Storage daemon
2037 Device = "HP DLT 80" # same as Device in Storage daemon
2038 Media Type = DLT8000 # same as MediaType in Storage daemon
2043 \subsection*{The Pool Resource}
2044 \label{PoolResource}
2045 \index[general]{Resource!Pool}
2046 \index[general]{Pool Resource}
2047 \addcontentsline{toc}{subsection}{Pool Resource}
2049 The Pool resource defines the set of storage Volumes (tapes or files) to be
2050 used by Bacula to write the data. By configuring different Pools, you can
2051 determine which set of Volumes (media) receives the backup data. This permits,
2052 for example, to store all full backup data on one set of Volumes and all
2053 incremental backups on another set of Volumes. Alternatively, you could assign
2054 a different set of Volumes to each machine that you backup. This is most
2055 easily done by defining multiple Pools.
2057 Another important aspect of a Pool is that it contains the default attributes
2058 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2059 Volume when it is created. This avoids the need for you to answer a large
2060 number of questions when labeling a new Volume. Each of these attributes can
2061 later be changed on a Volume by Volume basis using the {\bf update} command in
2062 the console program. Note that you must explicitly specify which Pool Bacula
2063 is to use with each Job. Bacula will not automatically search for the correct
2066 Most often in Bacula installations all backups for all machines (Clients) go
2067 to a single set of Volumes. In this case, you will probably only use the {\bf
2068 Default} Pool. If your backup strategy calls for you to mount a different tape
2069 each day, you will probably want to define a separate Pool for each day. For
2070 more information on this subject, please see the
2071 \ilink{Backup Strategies}{_ChapterStart3} chapter of this
2075 To use a Pool, there are three distinct steps. First the Pool must be defined
2076 in the Director's configuration file. Then the Pool must be written to the
2077 Catalog database. This is done automatically by the Director each time that it
2078 starts, or alternatively can be done using the {\bf create} command in the
2079 console program. Finally, if you change the Pool definition in the Director's
2080 configuration file and restart Bacula, the pool will be updated alternatively
2081 you can use the {\bf update pool} console command to refresh the database
2082 image. It is this database image rather than the Director's resource image
2083 that is used for the default Volume attributes. Note, for the pool to be
2084 automatically created or updated, it must be explicitly referenced by a Job
2087 Next the physical media must be labeled. The labeling can either be done with
2088 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2089 program. The preferred method is to use the {\bf label} command in the {\bf
2092 Finally, you must add Volume names (and their attributes) to the Pool. For
2093 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2094 archive device specified for the job (i.e. if you are going to back up to a
2095 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2096 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2097 are backing up to files. When running a Job, you must explicitly specify which
2098 Pool to use. Bacula will then automatically select the next Volume to use from
2099 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2100 from the Pool is identical to that required by the Storage resource you have
2101 specified for the Job.
2103 If you use the {\bf label} command in the console program to label the
2104 Volumes, they will automatically be added to the Pool, so this last step is
2105 not normally required.
2107 It is also possible to add Volumes to the database without explicitly labeling
2108 the physical volume. This is done with the {\bf add} console command.
2110 As previously mentioned, each time Bacula starts, it scans all the Pools
2111 associated with each Catalog, and if the database record does not already
2112 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2113 probably should do an {\bf update pool} if you change the Pool definition, but
2114 currently, you must do this manually using the {\bf update pool} command in
2115 the Console program.
2117 The Pool Resource defined in the Director's configuration file
2118 (bacula-dir.conf) may contain the following directives:
2124 \index[dir]{Directive!Pool}
2125 Start of the Pool resource. There must be at least one Pool resource
2129 \item [Name = \lt{}name\gt{}]
2131 \index[dir]{Directive!Name}
2132 The name of the pool. For most applications, you will use the default
2133 pool name {\bf Default}. This directive is required.
2136 \item [Maximum Volumes = \lt{}number\gt{}]
2137 \index[dir]{Maximum Volumes}
2138 \index[dir]{Directive!Maximum Volumes}
2139 This directive specifies the maximum number of volumes (tapes or files)
2140 contained in the pool. This directive is optional, if omitted or set to
2141 zero, any number of volumes will be permitted. In general, this
2142 directive is useful for Autochangers where there is a fixed number of
2143 Volumes, or for File storage where you wish to ensure that the backups
2144 made to disk files do not become too numerous or consume too much space.
2146 \item [Pool Type = \lt{}type\gt{}]
2147 \index[dir]{Pool Type}
2148 \index[dir]{Directive!Pool Type}
2149 This directive defines the pool type, which corresponds to the type of
2150 Job being run. It is required and may be one of the following:
2161 \item [Use Volume Once = \lt{}yes|no\gt{}]
2162 \index[dir]{Use Volume Once}
2163 \index[dir]{Directive!Use Volume Once}
2164 This directive if set to {\bf yes} specifies that each volume is to be
2165 used only once. This is most useful when the Media is a file and you
2166 want a new file for each backup that is done. The default is {\bf no}
2167 (i.e. use volume any number of times). This directive will most likely
2168 be phased out (deprecated), so you are recommended to use {\bf Maximum
2169 Volume Jobs = 1} instead.
2171 The value defined by this directive in the bacula-dir.conf file is the
2172 default value used when a Volume is created. Once the volume is
2173 created, changing the value in the bacula-dir.conf file will not change
2174 what is stored for the Volume. To change the value for an existing
2175 Volume you must use the {\bf update} command in the Console.
2177 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2178 \index[dir]{Maximum Volume Jobs}
2179 \index[dir]{Directive!Maximum Volume Jobs}
2180 This directive specifies the maximum number of Jobs that can be written
2181 to the Volume. If you specify zero (the default), there is no limit.
2182 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2183 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2184 is marked {\bf Used} it can no longer be used for appending Jobs, much
2185 like the {\bf Full} status but it can be recycled if recycling is
2186 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2187 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2189 The value defined by this directive in the bacula-dir.conf
2190 file is the default value used when a Volume is created. Once the volume is
2191 created, changing the value in the bacula-dir.conf file will not change what
2192 is stored for the Volume. To change the value for an existing Volume you
2193 must use the {\bf update} command in the Console.
2195 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2196 \index[dir]{Maximum Volume Files}
2197 \index[dir]{Directive!Maximum Volume Files}
2198 This directive specifies the maximum number of files that can be written
2199 to the Volume. If you specify zero (the default), there is no limit.
2200 Otherwise, when the number of files written to the Volume equals {\bf
2201 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2202 is marked {\bf Used} it can no longer be used for appending Jobs, much
2203 like the {\bf Full} status but it can be recycled if recycling is
2204 enabled and thus used again. This value is checked and the {\bf Used}
2205 status is set only at the end of a job that writes to the particular
2208 The value defined by this directive in the bacula-dir.conf file is the
2209 default value used when a Volume is created. Once the volume is
2210 created, changing the value in the bacula-dir.conf file will not change
2211 what is stored for the Volume. To change the value for an existing
2212 Volume you must use the {\bf update} command in the Console.
2214 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2215 \index[dir]{Maximum Volume Bytes}
2216 \index[dir]{Directive!Maximum Volume Bytes}
2217 This directive specifies the maximum number of bytes that can be written
2218 to the Volume. If you specify zero (the default), there is no limit
2219 except the physical size of the Volume. Otherwise, when the number of
2220 bytes written to the Volume equals {\bf size} the Volume will be marked
2221 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2222 used for appending Jobs, much like the {\bf Full} status but it can be
2223 recycled if recycling is enabled, and thus the Volume can be re-used
2224 after recycling. This value is checked and the {\bf Used} status set
2225 while the job is writing to the particular volume.
2227 The value defined by this directive in the bacula-dir.conf file is the
2228 default value used when a Volume is created. Once the volume is
2229 created, changing the value in the bacula-dir.conf file will not change
2230 what is stored for the Volume. To change the value for an existing
2231 Volume you must use the {\bf update} command in the Console.
2233 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2234 \index[dir]{Volume Use Duration}
2235 \index[dir]{Directive!Volume Use Duration}
2236 The Volume Use Duration directive defines the time period that the
2237 Volume can be written beginning from the time of first data write to the
2238 Volume. If the time-period specified is zero (the default), the Volume
2239 can be written indefinitely. Otherwise, the next time a job
2240 runs that wants to access this Volume, and the time period from the
2241 first write to the volume (the first Job written) exceeds the
2242 time-period-specification, the Volume will be marked {\bf Used}, which
2243 means that no more Jobs can be appended to the Volume, but it may be
2244 recycled if recycling is enabled. Using the command {\bf
2245 status dir} applies algorithms similar to running jobs, so
2246 during such a command, the Volume status may also be changed.
2248 recycled, it will be available for use again.
2250 You might use this directive, for example, if you have a Volume used for
2251 Incremental backups, and Volumes used for Weekly Full backups. Once the
2252 Full backup is done, you will want to use a different Incremental
2253 Volume. This can be accomplished by setting the Volume Use Duration for
2254 the Incremental Volume to six days. I.e. it will be used for the 6
2255 days following a Full save, then a different Incremental volume will be
2256 used. Be careful about setting the duration to short periods such as 23
2257 hours, or you might experience problems of Bacula waiting for a tape
2258 over the weekend only to complete the backups Monday morning when an
2259 operator mounts a new tape.
2261 The use duration is checked and the {\bf Used} status is set only at the
2262 end of a job that writes to the particular volume, which means that even
2263 though the use duration may have expired, the catalog entry will not be
2264 updated until the next job that uses this volume is run.
2266 Please note that the value defined by this directive in the bacula-dir.conf
2267 file is the default value used when a Volume is created. Once the volume is
2268 created, changing the value in the bacula-dir.conf file will not change what
2269 is stored for the Volume. To change the value for an existing Volume you
2271 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2273 \item [Catalog Files = \lt{}yes|no\gt{}]
2274 \index[dir]{Catalog Files}
2275 \index[dir]{Directive!Catalog Files}
2276 This directive defines whether or not you want the names of the files
2277 that were saved to be put into the catalog. The default is {\bf yes}.
2278 The advantage of specifying {\bf Catalog Files = No} is that you will
2279 have a significantly smaller Catalog database. The disadvantage is that
2280 you will not be able to produce a Catalog listing of the files backed up
2281 for each Job (this is often called Browsing). Also, without the File
2282 entries in the catalog, you will not be able to use the Console {\bf
2283 restore} command nor any other command that references File entries.
2285 \label{PoolAutoPrune}
2286 \item [AutoPrune = \lt{}yes|no\gt{}]
2287 \index[dir]{AutoPrune}
2288 \index[dir]{Directive!AutoPrune}
2289 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2290 will automatically apply the Volume Retention period when new Volume is
2291 needed and no appendable Volumes exist in the Pool. Volume pruning causes
2292 expired Jobs (older than the {\bf Volume Retention} period) to be deleted
2293 from the Catalog and permits possible recycling of the Volume.
2295 \label{VolRetention}
2296 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2297 \index[dir]{Volume Retention}
2298 \index[dir]{Directive!Volume Retention}
2299 The Volume Retention directive defines the length of time that {\bf
2300 Bacula} will keep Job records associated with the Volume in the Catalog
2301 database. When this time period expires, and if {\bf AutoPrune} is set
2302 to {\bf yes} Bacula may prune (remove) Job records that are older than
2303 the specified Volume Retention period if it is necessary to free up a
2304 Volume. Recycling will not occur until it is absolutely necessary to
2305 free up a volume. All File records associated with pruned Jobs are also
2306 pruned. The time may be specified as seconds, minutes, hours, days,
2307 weeks, months, quarters, or years. The {\bf Volume Retention} is
2308 applied independently of the {\bf Job Retention} and the {\bf File
2309 Retention} periods defined in the Client resource. This means that all
2310 the retentions periods are applied in turn and that the shorter period
2311 is the one that effectively takes precedence. Note, that when the {\bf
2312 Volume Retention} period has been reached, and it is necessary to obtain
2313 a new volume, Bacula will prune both the Job and the File records.
2314 This pruning could also occur during a {\bf status dir}
2315 command because it uses similar algorithms for finding the
2316 next available Volume.
2318 It is important to know that when the Volume Retention period expires,
2319 Bacula does not automatically recycle a Volume. It attempts to keep the
2320 Volume data intact as long as possible before over writing the Volume.
2322 The default Volume retention period is 365 days. Note, this directive
2323 sets the default value for each Volume entry in the Catalog when the
2324 Volume is created. The value in the catalog may be later individually
2325 changed for each Volume using the Console program.
2327 By defining multiple Pools with different Volume Retention periods, you
2328 may effectively have a set of tapes that is recycled weekly, another
2329 Pool of tapes that is recycled monthly and so on. However, one must
2330 keep in mind that if your {\bf Volume Retention} period is too short, it
2331 may prune the last valid Full backup, and hence until the next Full
2332 backup is done, you will not have a complete backup of your system, and
2333 in addition, the next Incremental or Differential backup will be
2334 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2335 Retention} period should be at twice the interval of your Full backups.
2336 This means that if you do a Full backup once a month, the minimum Volume
2337 retention period should be two months.
2339 Please note that the value defined by this directive in the bacula-dir.conf
2340 file is the default value used when a Volume is created. Once the volume is
2341 created, changing the value in the bacula-dir.conf file will not change what
2342 is stored for the Volume. To change the value for an existing Volume you
2343 must use the {\bf update} command in the Console.
2346 \item [Recycle = \lt{}yes|no\gt{}]
2347 \index[dir]{Recycle}
2348 \index[dir]{Directive!Recycle}
2349 This directive specifies whether or not Purged Volumes may be recycled.
2350 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2351 none that are appendable, it will search for and recycle (reuse) Purged
2352 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2353 deleted from the Catalog). If the Volume is recycled, all previous data
2354 written to that Volume will be overwritten. If Recycle is set to {\bf
2355 no}, the Volume will not be recycled, and hence, the data will remain
2356 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2357 is no (0 in the catalog), you may manually set the recycle flag (update
2358 command) for a Volume to be reused.
2360 Please note that the value defined by this directive in the
2361 bacula-dir.conf file is the default value used when a Volume is created.
2362 Once the volume is created, changing the value in the bacula-dir.conf
2363 file will not change what is stored for the Volume. To change the value
2364 for an existing Volume you must use the {\bf update} command in the
2367 \label{RecycleOldest}
2368 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2369 \index[dir]{Recycle Oldest Volume}
2370 \index[dir]{Directive!Recycle Oldest Volume}
2371 This directive instructs the Director to search for the oldest used
2372 Volume in the Pool when another Volume is requested by the Storage
2373 daemon and none are available. The catalog is then {\bf pruned}
2374 respecting the retention periods of all Files and Jobs written to this
2375 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2376 Volume is recycled and will be used as the next Volume to be written.
2377 This directive respects any Job, File, or Volume retention periods that
2378 you may have specified, and as such it is {\bf much} better to use this
2379 directive than the Purge Oldest Volume.
2381 This directive can be useful if you have a fixed number of Volumes in the
2382 Pool and you want to cycle through them and you have specified the correct
2385 However, if you use this directive and have only one
2386 Volume in the Pool, you will immediately recycle your Volume if you fill
2387 it and Bacula needs another one. Thus your backup will be totally invalid.
2388 Please use this directive with care. The default is {\bf no}.
2390 \label{RecycleCurrent}
2392 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2393 \index[dir]{Recycle Current Volume}
2394 \index[dir]{Directive!Recycle Current Volume}
2395 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2396 the volume respecting the Job and File retention periods. If all Jobs
2397 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2398 will be used as the next Volume to be written. This directive respects
2399 any Job, File, or Volume retention periods that you may have specified,
2400 and thus it is {\bf much} better to use it rather than the Purge Oldest
2403 This directive can be useful if you have: a fixed number of Volumes in
2404 the Pool, you want to cycle through them, and you have specified
2405 retention periods that prune Volumes before you have cycled through the
2408 However, if you use this directive and have only one Volume in the Pool,
2409 you will immediately recycle your Volume if you fill it and Bacula needs
2410 another one. Thus your backup will be totally invalid. Please use this
2411 directive with care. The default is {\bf no}.
2415 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2416 \index[dir]{Purge Oldest Volume}
2417 \index[dir]{Directive!Purge Oldest Volume}
2418 This directive instructs the Director to search for the oldest used
2419 Volume in the Pool when another Volume is requested by the Storage
2420 daemon and none are available. The catalog is then {\bf purged}
2421 irrespective of retention periods of all Files and Jobs written to this
2422 Volume. The Volume is then recycled and will be used as the next Volume
2423 to be written. This directive overrides any Job, File, or Volume
2424 retention periods that you may have specified.
2426 This directive can be useful if you have a fixed number of Volumes in
2427 the Pool and you want to cycle through them and reusing the oldest one
2428 when all Volumes are full, but you don't want to worry about setting
2429 proper retention periods. However, by using this option you risk losing
2432 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2433 periods. If you have only a single Volume defined and you turn this
2434 variable on, that Volume will always be immediately overwritten when it
2435 fills! So at a minimum, ensure that you have a decent number of Volumes
2436 in your Pool before running any jobs. If you want retention periods to
2437 apply do not use this directive. To specify a retention period, use the
2438 {\bf Volume Retention} directive (see above).
2440 We {\bf highly} recommend against using this directive, because it is
2441 sure that some day, Bacula will recycle a Volume that contains current
2442 data. The default is {\bf no}.
2444 \item [Cleaning Prefix = \lt{}string\gt{}]
2445 \index[dir]{Cleaning Prefix}
2446 \index[dir]{Directive!Cleaning Prefix}
2447 This directive defines a prefix string, which if it matches the
2448 beginning of a Volume name during labeling of a Volume, the Volume will
2449 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2450 never attempt to use this tape. This is primarily for use with
2451 autochangers that accept barcodes where the convention is that barcodes
2452 beginning with {\bf CLN} are treated as cleaning tapes.
2455 \item [Label Format = \lt{}format\gt{}]
2456 \index[dir]{Label Format}
2457 \index[dir]{Directive!Label Format}
2458 This directive specifies the format of the labels contained in this
2459 pool. The format directive is used as a sort of template to create new
2460 Volume names during automatic Volume labeling.
2462 The {\bf format} should be specified in double quotes, and consists of
2463 letters, numbers and the special characters hyphen ({\bf -}), underscore
2464 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2465 characters for a Volume name. The {\bf format} should be enclosed in
2468 In addition, the format may contain a number of variable expansion
2469 characters which will be expanded by a complex algorithm allowing you to
2470 create Volume names of many different formats. In all cases, the
2471 expansion process must resolve to the set of characters noted above that
2472 are legal Volume names. Generally, these variable expansion characters
2473 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2474 specify variable expansion characters, you should always enclose the
2475 format with double quote characters ({\bf "}). For more details on
2476 variable expansion, please see the \ilink{Variable
2477 Expansion}{_ChapterStart50} Chapter of this manual.
2479 If no variable expansion characters are found in the string, the Volume
2480 name will be formed from the {\bf format} string appended with the
2481 number of volumes in the pool plus one, which will be edited as four
2482 digits with leading zeros. For example, with a {\bf Label Format =
2483 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2486 With the exception of Job specific variables, you can test your {\bf
2487 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2490 In almost all cases, you should enclose the format specification (part
2491 after the equal sign) in double quotes. Please note that this directive
2492 is deprecated and is replaced in version 1.37 and greater with a Python
2493 script for creating volume names.
2497 In order for a Pool to be used during a Backup Job, the Pool must have at
2498 least one Volume associated with it. Volumes are created for a Pool using
2499 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2500 program. In addition to adding Volumes to the Pool (i.e. putting the
2501 Volume names in the Catalog database), the physical Volume must be labeled
2502 with a valid Bacula software volume label before {\bf Bacula} will accept
2503 the Volume. This will be automatically done if you use the {\bf label}
2504 command. Bacula can automatically label Volumes if instructed to do so,
2505 but this feature is not yet fully implemented.
2507 The following is an example of a valid Pool resource definition:
2519 \subsubsection*{The Scratch Pool}
2520 \addcontentsline{toc}{subsection}{Scratch Pool}
2521 \index[general]{Scratch Pool}
2522 In general, you can give your Pools any name you wish, but there is one
2523 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2524 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2525 writing and it cannot find one, it will look in the Scratch pool, and if
2526 it finds an available Volume, it will move it out of the Scratch pool into
2527 the Pool currently being used by the job.
2530 \subsection*{The Catalog Resource}
2531 \label{CatalogResource}
2532 \index[general]{Resource!Catalog}
2533 \index[general]{Catalog Resource}
2534 \addcontentsline{toc}{subsection}{Catalog Resource}
2536 The Catalog Resource defines what catalog to use for the current job.
2537 Currently, Bacula can only handle a single database server (SQLite, MySQL,
2538 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
2539 may be as many Catalogs (databases) defined as you wish. For example, you
2540 may want each Client to have its own Catalog database, or you may want
2541 backup jobs to use one database and verify or restore jobs to use another
2547 \index[dir]{Catalog}
2548 \index[dir]{Directive!Catalog}
2549 Start of the Catalog resource. At least one Catalog resource must be
2553 \item [Name = \lt{}name\gt{}]
2555 \index[dir]{Directive!Name}
2556 The name of the Catalog. No necessary relation to the database server
2557 name. This name will be specified in the Client resource directive
2558 indicating that all catalog data for that Client is maintained in this
2559 Catalog. This directive is required.
2561 \item [password = \lt{}password\gt{}]
2562 \index[dir]{password}
2563 \index[dir]{Directive!password}
2564 This specifies the password to use when logging into the database. This
2565 directive is required.
2567 \item [DB Name = \lt{}name\gt{}]
2568 \index[dir]{DB Name}
2569 \index[dir]{Directive!DB Name}
2570 This specifies the name of the database. If you use multiple catalogs
2571 (databases), you specify which one here. If you are using an external
2572 database server rather than the internal one, you must specify a name
2573 that is known to the server (i.e. you explicitly created the Bacula
2574 tables using this name. This directive is required.
2576 \item [user = \lt{}user\gt{}]
2578 \index[dir]{Directive!user}
2579 This specifies what user name to use to log into the database. This
2580 directive is required.
2582 \item [DB Socket = \lt{}socket-name\gt{}]
2583 \index[dir]{DB Socket}
2584 \index[dir]{Directive!DB Socket}
2585 This is the name of a socket to use on the local host to connect to the
2586 database. This directive is used only by MySQL and is ignored by SQLite.
2587 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
2588 will use the default socket.
2590 \item [DB Address = \lt{}address\gt{}]
2591 \index[dir]{DB Address}
2592 \index[dir]{Directive!DB Address}
2593 This is the host address of the database server. Normally, you would specify
2594 this instead of {\bf DB Socket} if the database server is on another machine.
2595 In that case, you will also specify {\bf DB Port}. This directive is used
2596 only by MySQL and is ignored by SQLite if provided. This directive is
2599 \item [DB Port = \lt{}port\gt{}]
2600 \index[dir]{DB Port}
2601 \index[dir]{Directive!DB Port}
2602 This defines the port to be used in conjunction with {\bf DB Address} to
2603 access the database if it is on another machine. This directive is used only
2604 by MySQL and is ignored by SQLite if provided. This directive is optional.
2606 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
2607 %% \index[dir]{Multiple Connections}
2608 %% \index[dir]{Directive!Multiple Connections}
2609 %% By default, this directive is set to no. In that case, each job that uses
2611 %% same Catalog will use a single connection to the catalog. It will be shared,
2612 %% and Bacula will allow only one Job at a time to communicate. If you set this
2613 %% directive to yes, Bacula will permit multiple connections to the database,
2614 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
2615 %% this is no problem. For MySQL, you must be *very* careful to have the
2616 %% multi-thread version of the client library loaded on your system. When this
2617 %% directive is set yes, each Job will have a separate connection to the
2618 %% database, and the database will control the interaction between the
2620 %% Jobs. This can significantly speed up the database operations if you are
2621 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
2622 %% Bacula will automatically enable transactions. This can significantly speed
2623 %% up insertion of attributes in the database either for a single Job or
2624 %% multiple simultaneous Jobs.
2626 %% This directive has not been tested. Please test carefully before running it
2627 %% in production and report back your results.
2631 The following is an example of a valid Catalog resource definition:
2640 password = "" # no password = no security
2645 or for a Catalog on another machine:
2655 DB Address = remote.acme.com
2661 \subsection*{The Messages Resource}
2662 \label{MessagesResource2}
2663 \index[general]{Resource!Messages}
2664 \index[general]{Messages Resource}
2665 \addcontentsline{toc}{subsection}{Messages Resource}
2667 For the details of the Messages Resource, please see the
2668 \ilink{Messages Resource Chapter}{_ChapterStart15} of this
2671 \subsection*{The Console Resource}
2672 \label{ConsoleResource1}
2673 \index[general]{Console Resource}
2674 \index[general]{Resource!Console}
2675 \addcontentsline{toc}{subsection}{Console Resource}
2677 As of Bacula version 1.33 and higher, there are three different kinds of
2678 consoles, which the administrator or user can use to interact with the
2679 Director. These three kinds of consoles comprise three different security
2683 \item The first console type is an {\bf anonymous} or {\bf default} console,
2684 which has full privileges. There is no console resource necessary for
2685 this type since the password is specified in the Director's resource and
2686 consequently such consoles do not have a name as defined on a {\bf Name
2687 =} directive. This is the kind of console that was initially
2688 implemented in versions prior to 1.33 and remains valid. Typically you
2689 would use it only for administrators.
2691 \item The second type of console, and new to version 1.33 and higher is a
2692 "named" console defined within a Console resource in both the Director's
2693 configuration file and in the Console's configuration file. Both the
2694 names and the passwords in these two entries must match much as is the
2695 case for Client programs.
2697 This second type of console begins with absolutely no privileges except
2698 those explicitly specified in the Director's Console resource. Thus you
2699 can have multiple Consoles with different names and passwords, sort of
2700 like multiple users, each with different privileges. As a default,
2701 these consoles can do absolutely nothing -- no commands whatsoever. You
2702 give them privileges or rather access to commands and resources by
2703 specifying access control lists in the Director's Console resource. The
2704 ACLs are specified by a directive followed by a list of access names.
2705 Examples of this are shown below.
2707 \item The third type of console is similar to the above mentioned one in that
2708 it requires a Console resource definition in both the Director and the
2709 Console. In addition, if the console name, provided on the {\bf Name =}
2710 directive, is the same as a Client name, that console is permitted to
2711 use the {\bf SetIP} command to change the Address directive in the
2712 Director's client resource to the IP address of the Console. This
2713 permits portables or other machines using DHCP (non-fixed IP addresses)
2714 to "notify" the Director of their current IP address.
2717 The Console resource is optional and need not be specified. The following
2718 directives are permitted within the Director's configuration resource:
2722 \item [Name = \lt{}name\gt{}]
2724 \index[dir]{Directive!Name}
2725 The name of the console. This name must match the name specified in the
2726 Console's configuration resource (much as is the case with Client
2729 \item [Password = \lt{}password\gt{}]
2730 \index[dir]{Password}
2731 \index[dir]{Directive!Password}
2732 Specifies the password that must be supplied for a named Bacula Console
2733 to be authorized. The same password must appear in the {\bf Console}
2734 resource of the Console configuration file. For added security, the
2735 password is never actually passed across the network but rather a
2736 challenge response hash code created with the password. This directive
2737 is required. If you have either {\bf /dev/random} {\bf bc} on your
2738 machine, Bacula will generate a random password during the configuration
2739 process, otherwise it will be left blank.
2741 \item [JobACL = \lt{}name-list\gt{}]
2743 \index[dir]{Directive!JobACL}
2744 This directive is used to specify a list of Job resource names that can
2745 be accessed by the console. Without this directive, the console cannot
2746 access any of the Director's Job resources. Multiple Job resource names
2747 may be specified by separating them with commas, and/or by specifying
2748 multiple JobACL directives. For example, the directive may be specified
2753 JobACL = kernsave, "Backup client 1", "Backup client 2"
2754 JobACL = "RestoreFiles"
2759 With the above specification, the console can access the Director's resources
2760 for the four jobs named on the JobACL directives, but for no others.
2762 \item [ClientACL = \lt{}name-list\gt{}]
2763 \index[dir]{ClientACL}
2764 \index[dir]{Directive!ClientACL}
2765 This directive is used to specify a list of Client resource names that can
2767 accessed by the console.
2769 \item [StorageACL = \lt{}name-list\gt{}]
2770 \index[dir]{StorageACL}
2771 \index[dir]{Directive!StorageACL}
2772 This directive is used to specify a list of Storage resource names that can
2773 be accessed by the console.
2775 \item [ScheduleACL = \lt{}name-list\gt{}]
2776 \index[dir]{ScheduleACL}
2777 \index[dir]{Directive!ScheduleACL}
2778 This directive is used to specify a list of Schedule resource names that can
2779 be accessed by the console.
2781 \item [PoolACL = \lt{}name-list\gt{}]
2782 \index[dir]{PoolACL}
2783 \index[dir]{Directive!PoolACL}
2784 This directive is used to specify a list of Pool resource names that can be
2785 accessed by the console.
2787 \item [FileSetACL = \lt{}name-list\gt{}]
2788 \index[dir]{FileSetACL}
2789 \index[dir]{Directive!FileSetACL}
2790 This directive is used to specify a list of FileSet resource names that can
2791 be accessed by the console.
2793 \item [CatalogACL = \lt{}name-list\gt{}]
2794 \index[dir]{CatalogACL}
2795 \index[dir]{Directive!CatalogACL}
2796 This directive is used to specify a list of Catalog resource names that can
2797 be accessed by the console.
2799 \item [CommandACL = \lt{}name-list\gt{}]
2800 \index[dir]{CommandACL}
2801 \index[dir]{Directive!CommandACL}
2802 This directive is used to specify a list of of console commands that can be
2803 executed by the console.
2806 Aside from Director resource names and console command names, the special
2807 keyword {\bf *all*} can be specified in any of the above access control lists.
2808 When this keyword is present, any resource or command name (which ever is
2809 appropriate) will be accepted. For an example configuration file, please see
2811 \ilink{Console Configuration}{_ChapterStart36} chapter of this
2814 \subsection*{The Counter Resource}
2815 \label{CounterResource}
2816 \index[general]{Resource!Counter}
2817 \index[general]{Counter Resource}
2818 \addcontentsline{toc}{subsection}{Counter Resource}
2820 The Counter Resource defines a counter variable that can be accessed by
2821 variable expansion used for creating Volume labels with the {\bf LabelFormat}
2823 \ilink{LabelFormat}{Label} directive in this chapter for more
2829 \index[dir]{Counter}
2830 \index[dir]{Directive!Counter}
2831 Start of the Counter resource. Counter directives are optional.
2833 \item [Name = \lt{}name\gt{}]
2835 \index[dir]{Directive!Name}
2836 The name of the Counter. This is the name you will use in the variable
2837 expansion to reference the counter value.
2839 \item [Minimum = \lt{}integer\gt{}]
2840 \index[dir]{Minimum}
2841 \index[dir]{Directive!Minimum}
2842 This specifies the minimum value that the counter can have. It also becomes
2843 the default. If not supplied, zero is assumed.
2845 \item [Maximum = \lt{}integer\gt{}]
2846 \index[dir]{Maximum}
2847 \index[dir]{Directive!Maximum}
2848 \index[dir]{Directive!Maximum}
2849 This is the maximum value value that the counter can have. If not specified
2850 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
2851 the 31 power). When the counter is incremented past this value, it is reset
2854 \item [*WrapCounter = \lt{}counter-name\gt{}]
2855 \index[dir]{*WrapCounter}
2856 \index[dir]{Directive!*WrapCounter}
2857 If this value is specified, when the counter is incremented past the
2859 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
2860 is incremented. (This is not currently implemented).
2862 \item [Catalog = \lt{}catalog-name\gt{}]
2863 \index[dir]{Catalog}
2864 \index[dir]{Directive!Catalog}
2865 If this directive is specified, the counter and its values will be saved in
2866 the specified catalog. If this directive is not present, the counter will be
2867 redefined each time that Bacula is started.
2870 \subsection*{Example Director Configuration File}
2871 \label{SampleDirectorConfiguration}
2872 \index[general]{File!Example Director Configuration}
2873 \index[general]{Example Director Configuration File}
2874 \addcontentsline{toc}{subsection}{Example Director Configuration File}
2876 An example Director configuration file might be the following:
2881 # Default Bacula Director Configuration file
2883 # The only thing that MUST be changed is to add one or more
2884 # file or directory names in the Include directive of the
2887 # For Bacula release 1.15 (5 March 2002) -- redhat
2889 # You might also want to change the default email address
2890 # from root to your address. See the "mail" and "operator"
2891 # directives in the Messages resource.
2893 Director { # define myself
2895 QueryFile = "/home/kern/bacula/bin/query.sql"
2896 WorkingDirectory = "/home/kern/bacula/bin/working"
2897 PidDirectory = "/home/kern/bacula/bin/working"
2898 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
2900 # Define the backup Job
2902 Name = "NightlySave"
2904 Level = Incremental # default
2907 Schedule = "WeeklyCycle"
2917 Where = /tmp/bacula-restores
2923 # List of files to be backed up
2927 Options { signature=SHA1}
2929 # Put your list of files here, one per line or include an
2930 # external list with:
2934 # Note: / backs up everything
2939 # When to do the backups
2941 Name = "WeeklyCycle"
2942 Run = Full sun at 1:05
2943 Run = Incremental mon-sat at 1:05
2945 # Client (File Services) to backup
2950 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
2951 File Retention = 60d # sixty day file retention
2952 Job Retention = 1y # 1 year Job retention
2953 AutoPrune = yes # Auto apply retention periods
2955 # Definition of DLT tape storage device
2959 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2960 Device = "HP DLT 80" # same as Device in Storage daemon
2961 Media Type = DLT8000 # same as MediaType in Storage daemon
2963 # Definition for a DLT autochanger device
2967 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2968 Device = "Autochanger" # same as Device in Storage daemon
2969 Media Type = DLT-8000 # Different from DLTDrive
2972 # Definition of DDS tape storage device
2976 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2977 Device = SDT-10000 # same as Device in Storage daemon
2978 Media Type = DDS-4 # same as MediaType in Storage daemon
2980 # Definition of 8mm tape storage device
2984 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2985 Device = "Exabyte 8mm"
2988 # Definition of file storage device
2992 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2993 Device = FileStorage
2996 # Generic catalog service
2999 dbname = bacula; user = bacula; password = ""
3001 # Reasonable message delivery -- send most everything to
3002 # the email address and to the console
3005 mail = root@localhost = all, !skipped, !terminate
3006 operator = root@localhost = mount
3007 console = all, !skipped, !saved
3010 # Default pool definition
3018 # Restricted console used by tray-monitor to get the status of the director
3022 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3023 CommandACL = status, .status