4 \chapter{Configuring the Director}
5 \label{DirectorChapter}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
9 Of all the configuration files needed to run {\bf Bacula}, the Director's is
10 the most complicated, and the one that you will need to modify the most often
11 as you add clients or modify the FileSets.
13 For a general discussion of configuration files and resources including the
14 data types recognized by {\bf Bacula}. Please see the
15 \ilink{Configuration}{ConfigureChapter} chapter of this manual.
17 \section{Director Resource Types}
18 \index[general]{Types!Director Resource}
19 \index[general]{Director Resource Types}
21 Director resource type may be one of the following:
23 Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
24 Messages. We present them here in the most logical order for defining them:
26 Note, everything revolves around a job and is tied to a job in one
31 \ilink{Director}{DirectorResource4} -- to define the Director's
32 name and its access password used for authenticating the Console program.
33 Only a single Director resource definition may appear in the Director's
34 configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
35 machine, Bacula will generate a random password during the configuration
36 process, otherwise it will be left blank.
38 \ilink{Job}{JobResource} -- to define the backup/restore Jobs
39 and to tie together the Client, FileSet and Schedule resources to be used
40 for each Job. Normally, you will Jobs of different names corresponding
41 to each client (i.e. one Job per client, but a different one with a different name
44 \ilink{JobDefs}{JobDefsResource} -- optional resource for
45 providing defaults for Job resources.
47 \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
48 be automatically run by {\bf Bacula's} internal scheduler. You
49 may have any number of Schedules, but each job will reference only
52 \ilink{FileSet}{FileSetResource} -- to define the set of files
53 to be backed up for each Client. You may have any number of
54 FileSets but each Job will reference only one.
56 \ilink{Client}{ClientResource2} -- to define what Client is to be
57 backed up. You will generally have multiple Client definitions. Each
58 Job will reference only a single client.
60 \ilink{Storage}{StorageResource2} -- to define on what physical
61 device the Volumes should be mounted. You may have one or
62 more Storage definitions.
64 \ilink{Pool}{PoolResource} -- to define the pool of Volumes
65 that can be used for a particular Job. Most people use a
66 single default Pool. However, if you have a large number
67 of clients or volumes, you may want to have multiple Pools.
68 Pools allow you to restrict a Job (or a Client) to use
69 only a particular set of Volumes.
71 \ilink{Catalog}{CatalogResource} -- to define in what database to
72 keep the list of files and the Volume names where they are backed up.
73 Most people only use a single catalog. However, if you want to
74 scale the Director to many clients, multiple catalogs can be helpful.
75 Multiple catalogs require a bit more management because in general
76 you must know what catalog contains what data. Currently, all
77 Pools are defined in each catalog. This restriction will be removed
80 \ilink{Messages}{MessagesChapter} -- to define where error and
81 information messages are to be sent or logged. You may define
82 multiple different message resources and hence direct particular
83 classes of messages to different users or locations (files, ...).
86 \section{The Director Resource}
87 \label{DirectorResource4}
88 \index[general]{Director Resource}
89 \index[general]{Resource!Director}
91 The Director resource defines the attributes of the Directors running on the
92 network. In the current implementation, there is only a single Director
93 resource, but the final design will contain multiple Directors to maintain
94 index and media database redundancy.
100 Start of the Director resource. One and only one director resource must be
103 \item [Name = \lt{}name\gt{}]
105 \index[dir]{Directive!Name}
106 The director name used by the system administrator. This directive is
109 \item [Description = \lt{}text\gt{}]
110 \index[dir]{Description}
111 \index[dir]{Directive!Description}
112 The text field contains a description of the Director that will be displayed
113 in the graphical user interface. This directive is optional.
115 \item [Password = \lt{}UA-password\gt{}]
116 \index[dir]{Password}
117 \index[dir]{Directive!Password}
118 Specifies the password that must be supplied for the default Bacula
119 Console to be authorized. The same password must appear in the {\bf
120 Director} resource of the Console configuration file. For added
121 security, the password is never passed across the network but instead a
122 challenge response hash code created with the password. This directive
123 is required. If you have either {\bf /dev/random} or {\bf bc} on your
124 machine, Bacula will generate a random password during the configuration
125 process, otherwise it will be left blank and you must manually supply
128 \item [Messages = \lt{}Messages-resource-name\gt{}]
129 \index[dir]{Messages}
130 \index[dir]{Directive!Messages}
131 The messages resource specifies where to deliver Director messages that are
132 not associated with a specific Job. Most messages are specific to a job and
133 will be directed to the Messages resource specified by the job. However,
134 there are a few messages that can occur when no job is running. This
135 directive is required.
137 \item [Working Directory = \lt{}Directory\gt{}]
138 \index[dir]{Working Directory}
139 \index[dir]{Directive!Working Directory}
140 This directive is mandatory and specifies a directory in which the Director
141 may put its status files. This directory should be used only by Bacula but
142 may be shared by other Bacula daemons. However, please note, if this
143 directory is shared with other Bacula daemons (the File daemon and Storage
144 daemon), you must ensure that the {\bf Name} given to each daemon is
145 unique so that the temporary filenames used do not collide. By default
146 the Bacula configure process creates unique daemon names by postfixing them
147 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
148 Directory} is done when the configuration file is read so that values such
149 as {\bf \$HOME} will be properly expanded. This directive is required.
150 The working directory specified must already exist and be
151 readable and writable by the Bacula daemon referencing it.
153 If you have specified a Director user and/or a Director group on your
154 ./configure line with {\bf {-}{-}with-dir-user} and/or
155 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
156 be set to those values.
158 \item [Pid Directory = \lt{}Directory\gt{}]
159 \index[dir]{Pid Directory}
160 \index[dir]{Directive!Pid Directory}
161 This directive is mandatory and specifies a directory in which the Director
162 may put its process Id file. The process Id file is used to shutdown
163 Bacula and to prevent multiple copies of Bacula from running simultaneously.
164 Standard shell expansion of the {\bf Directory} is done when the
165 configuration file is read so that values such as {\bf \$HOME} will be
168 The PID directory specified must already exist and be
169 readable and writable by the Bacula daemon referencing it
171 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
172 not installing Bacula in the system directories, you can use the {\bf Working
173 Directory} as defined above. This directive is required.
175 \item [Scripts Directory = \lt{}Directory\gt{}]
176 \index[dir]{Scripts Directory}
177 \index[dir]{Directive!Scripts Directory}
178 This directive is optional and, if defined, specifies a directory in
179 which the Director will look for the Python startup script {\bf
180 DirStartup.py}. This directory may be shared by other Bacula daemons.
181 Standard shell expansion of the directory is done when the configuration
182 file is read so that values such as {\bf \$HOME} will be properly
185 \item [QueryFile = \lt{}Path\gt{}]
186 \index[dir]{QueryFile}
187 \index[dir]{Directive!QueryFile}
188 This directive is mandatory and specifies a directory and file in which
189 the Director can find the canned SQL statements for the {\bf Query}
190 command of the Console. Standard shell expansion of the {\bf Path} is
191 done when the configuration file is read so that values such as {\bf
192 \$HOME} will be properly expanded. This directive is required.
194 \label{DirMaxConJobs}
195 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
196 \index[dir]{Maximum Concurrent Jobs}
197 \index[dir]{Directive!Maximum Concurrent Jobs}
198 \index[general]{Simultaneous Jobs}
199 \index[general]{Concurrent Jobs}
200 where \lt{}number\gt{} is the maximum number of total Director Jobs that
201 should run concurrently. The default is set to 1, but you may set it to a
204 Please note that the Volume format becomes much more complicated with
205 multiple simultaneous jobs, consequently, restores can take much longer if
206 Bacula must sort through interleaved volume blocks from multiple simultaneous
207 jobs. This can be avoided by having each simultaneously running job write to
208 a different volume or by using data spooling, which will first spool the data
209 to disk simultaneously, then write each spool file to the volume in
212 There may also still be some cases where directives such as {\bf Maximum
213 Volume Jobs} are not properly synchronized with multiple simultaneous jobs
214 (subtle timing issues can arise), so careful testing is recommended.
216 At the current time, there is no configuration parameter set to limit the
217 number of console connections. A maximum of five simultaneous console
218 connections are permitted.
220 \item [FD Connect Timeout = \lt{}time\gt{}]
221 \index[dir]{FD Connect Timeout}
222 \index[dir]{Directive!FD Connect Timeout}
223 where {\bf time} is the time that the Director should continue
224 attempting to contact the File daemon to start a job, and after which
225 the Director will cancel the job. The default is 30 minutes.
227 \item [SD Connect Timeout = \lt{}time\gt{}]
228 \index[dir]{SD Connect Timeout}
229 \index[dir]{Directive!SD Connect Timeout}
230 where {\bf time} is the time that the Director should continue
231 attempting to contact the Storage daemon to start a job, and after which
232 the Director will cancel the job. The default is 30 minutes.
234 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
235 \index[dir]{DirAddresses}
237 \index[general]{Address}
238 \index[dir]{Directive!DirAddresses}
239 Specify the ports and addresses on which the Director daemon will listen
240 for Bacula Console connections. Probably the simplest way to explain
241 this is to show an example:
246 ip = { addr = 1.2.3.4; port = 1205;}
248 addr = 1.2.3.4; port = http;}
257 ip = { addr = 1.2.3.4 }
258 ip = { addr = 201:220:222::2 }
260 addr = bluedot.thun.net
266 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
267 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
268 a symbolic name (only in the ip specification). Also, port can be specified
269 as a number or as the mnemonic value from the /etc/services file. If a port
270 is not specified, the default will be used. If an ip section is specified,
271 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
272 only IPv4 resolutions will be permitted, and likewise with ip6.
274 Please note that if you use the DirAddresses directive, you must
275 not use either a DirPort or a DirAddress directive in the same
278 \item [DirPort = \lt{}port-number\gt{}]
280 \index[dir]{Directive!DirPort}
281 Specify the port (a positive integer) on which the Director daemon will
282 listen for Bacula Console connections. This same port number must be
283 specified in the Director resource of the Console configuration file. The
284 default is 9101, so normally this directive need not be specified. This
285 directive should not be used if you specify DirAddresses (not plural)
288 \item [DirAddress = \lt{}IP-Address\gt{}]
289 \index[dir]{DirAddress}
290 \index[dir]{Directive!DirAddress}
291 This directive is optional, but if it is specified, it will cause the
292 Director server (for the Console program) to bind to the specified {\bf
293 IP-Address}, which is either a domain name or an IP address specified as a
294 dotted quadruple in string or quoted string format. If this directive is not
295 specified, the Director will bind to any available address (the default).
296 Note, unlike the DirAddresses specification noted above, this directive only
297 permits a single address to be specified. This directive should not be used if you
298 specify a DirAddresses (note plural) directive.
304 The following is an example of a valid Director resource definition:
310 WorkingDirectory = "$HOME/bacula/bin/working"
311 Password = UA_password
312 PidDirectory = "$HOME/bacula/bin/working"
313 QueryFile = "$HOME/bacula/bin/query.sql"
319 \section{The Job Resource}
321 \index[general]{Resource!Job}
322 \index[general]{Job Resource}
324 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
325 perform. Each Job resource definition contains the name of a Client and
326 a FileSet to backup, the Schedule for the Job, where the data
327 are to be stored, and what media Pool can be used. In effect, each Job
328 resource must specify What, Where, How, and When or FileSet, Storage,
329 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
330 be specified for a restore job for historical reasons, but it is no longer used.
332 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
333 job. If you want to backup multiple FileSets on the same Client or multiple
334 Clients, you must define a Job for each one.
336 Note, you define only a single Job to do the Full, Differential, and
337 Incremental backups since the different backup levels are tied together by
338 a unique Job name. Normally, you will have only one Job per Client, but
339 if a client has a really huge number of files (more than several million),
340 you might want to split it into to Jobs each with a different FileSet
341 covering only part of the total files.
348 \index[dir]{Directive!Job}
349 Start of the Job resource. At least one Job resource is required.
351 \item [Name = \lt{}name\gt{}]
353 \index[dir]{Directive!Name}
354 The Job name. This name can be specified on the {\bf Run} command in the
355 console program to start a job. If the name contains spaces, it must be
356 specified between quotes. It is generally a good idea to give your job the
357 same name as the Client that it will backup. This permits easy
358 identification of jobs.
360 When the job actually runs, the unique Job Name will consist of the name you
361 specify here followed by the date and time the job was scheduled for
362 execution. This directive is required.
364 \item [Enabled = \lt{}yes|no\gt{}]
366 \index[dir]{Directive!Enable}
367 This directive allows you to enable or disable automatic execution
368 via the scheduler of a Job.
370 \item [Type = \lt{}job-type\gt{}]
372 \index[dir]{Directive!Type}
373 The {\bf Type} directive specifies the Job type, which may be one of the
374 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
375 directive is required. Within a particular Job Type, there are also Levels
376 as discussed in the next item.
382 Run a backup Job. Normally you will have at least one Backup job for each
383 client you want to save. Normally, unless you turn off cataloging, most all
384 the important statistics and data concerning files backed up will be placed
389 Run a restore Job. Normally, you will specify only one Restore job
390 which acts as a sort of prototype that you will modify using the console
391 program in order to perform restores. Although certain basic
392 information from a Restore job is saved in the catalog, it is very
393 minimal compared to the information stored for a Backup job -- for
394 example, no File database entries are generated since no Files are
397 {\bf Restore} jobs cannot be
398 automatically started by the scheduler as is the case for Backup, Verify
399 and Admin jobs. To restore files, you must use the {\bf restore} command
405 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
406 contents of the catalog to the file system, or to what was backed up. In
407 addition, to verifying that a tape that was written can be read, you can
408 also use {\bf verify} as a sort of tripwire intrusion detection.
412 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
413 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
414 Although an Admin job is recorded in the catalog, very little data is saved.
419 \item [Level = \lt{}job-level\gt{}]
421 \index[dir]{Directive!Level}
422 The Level directive specifies the default Job level to be run. Each
423 different Job Type (Backup, Restore, ...) has a different set of Levels
424 that can be specified. The Level is normally overridden by a different
425 value that is specified in the {\bf Schedule} resource. This directive
426 is not required, but must be specified either by a {\bf Level} directive
427 or as an override specified in the {\bf Schedule} resource.
429 For a {\bf Backup} Job, the Level may be one of the following:
435 When the Level is set to Full all files in the FileSet whether or not
436 they have changed will be backed up.
439 \index[dir]{Incremental}
440 When the Level is set to Incremental all files specified in the FileSet
441 that have changed since the last successful backup of the the same Job
442 using the same FileSet and Client, will be backed up. If the Director
443 cannot find a previous valid Full backup then the job will be upgraded
444 into a Full backup. When the Director looks for a valid backup record
445 in the catalog database, it looks for a previous Job with:
448 \item The same Job name.
449 \item The same Client name.
450 \item The same FileSet (any change to the definition of the FileSet such as
451 adding or deleting a file in the Include or Exclude sections constitutes a
453 \item The Job was a Full, Differential, or Incremental backup.
454 \item The Job terminated normally (i.e. did not fail or was not canceled).
457 If all the above conditions do not hold, the Director will upgrade the
458 Incremental to a Full save. Otherwise, the Incremental backup will be
459 performed as requested.
461 The File daemon (Client) decides which files to backup for an
462 Incremental backup by comparing start time of the prior Job (Full,
463 Differential, or Incremental) against the time each file was last
464 "modified" (st\_mtime) and the time its attributes were last
465 "changed"(st\_ctime). If the file was modified or its attributes
466 changed on or after this start time, it will then be backed up.
468 Some virus scanning software may change st\_ctime while
469 doing the scan. For example, if the virus scanning program attempts to
470 reset the access time (st\_atime), which Bacula does not use, it will
471 cause st\_ctime to change and hence Bacula will backup the file during
472 an Incremental or Differential backup. In the case of Sophos virus
473 scanning, you can prevent it from resetting the access time (st\_atime)
474 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
475 option. For other software, please see their manual.
477 When Bacula does an Incremental backup, all modified files that are
478 still on the system are backed up. However, any file that has been
479 deleted since the last Full backup remains in the Bacula catalog, which
480 means that if between a Full save and the time you do a restore, some
481 files are deleted, those deleted files will also be restored. The
482 deleted files will no longer appear in the catalog after doing another
483 Full save. However, to remove deleted files from the catalog during an
484 Incremental backup is quite a time consuming process and not currently
485 implemented in Bacula.
487 In addition, if you move a directory rather than copy it, the files in
488 it do not have their modification time (st\_mtime) or their attribute
489 change time (st\_ctime) changed. As a consequence, those files will
490 probably not be backed up by an Incremental or Differential backup which
491 depend solely on these time stamps. If you move a directory, and wish
492 it to be properly backed up, it is generally preferable to copy it, then
496 \index[dir]{Differential}
497 When the Level is set to Differential
498 all files specified in the FileSet that have changed since the last
499 successful Full backup of the same Job will be backed up.
500 If the Director cannot find a
501 valid previous Full backup for the same Job, FileSet, and Client,
502 backup, then the Differential job will be upgraded into a Full backup.
503 When the Director looks for a valid Full backup record in the catalog
504 database, it looks for a previous Job with:
507 \item The same Job name.
508 \item The same Client name.
509 \item The same FileSet (any change to the definition of the FileSet such as
510 adding or deleting a file in the Include or Exclude sections constitutes a
512 \item The Job was a FULL backup.
513 \item The Job terminated normally (i.e. did not fail or was not canceled).
516 If all the above conditions do not hold, the Director will upgrade the
517 Differential to a Full save. Otherwise, the Differential backup will be
518 performed as requested.
520 The File daemon (Client) decides which files to backup for a
521 differential backup by comparing the start time of the prior Full backup
522 Job against the time each file was last "modified" (st\_mtime) and the
523 time its attributes were last "changed" (st\_ctime). If the file was
524 modified or its attributes were changed on or after this start time, it
525 will then be backed up. The start time used is displayed after the {\bf
526 Since} on the Job report. In rare cases, using the start time of the
527 prior backup may cause some files to be backed up twice, but it ensures
528 that no change is missed. As with the Incremental option, you should
529 ensure that the clocks on your server and client are synchronized or as
530 close as possible to avoid the possibility of a file being skipped.
531 Note, on versions 1.33 or greater Bacula automatically makes the
532 necessary adjustments to the time between the server and the client so
533 that the times Bacula uses are synchronized.
535 When Bacula does a Differential backup, all modified files that are
536 still on the system are backed up. However, any file that has been
537 deleted since the last Full backup remains in the Bacula catalog, which
538 means that if between a Full save and the time you do a restore, some
539 files are deleted, those deleted files will also be restored. The
540 deleted files will no longer appear in the catalog after doing another
541 Full save. However, to remove deleted files from the catalog during a
542 Differential backup is quite a time consuming process and not currently
543 implemented in Bacula. It is, however, a planned future feature.
545 As noted above, if you move a directory rather than copy it, the
546 files in it do not have their modification time (st\_mtime) or
547 their attribute change time (st\_ctime) changed. As a
548 consequence, those files will probably not be backed up by an
549 Incremental or Differential backup which depend solely on these
550 time stamps. If you move a directory, and wish it to be
551 properly backed up, it is generally preferable to copy it, then
552 delete the original. Alternatively, you can move the directory, then
553 use the {\bf touch} program to update the timestamps.
555 Every once and a while, someone asks why we need Differential
556 backups as long as Incremental backups pickup all changed files.
557 There are possibly many answers to this question, but the one
558 that is the most important for me is that a Differential backup
560 all the Incremental and Differential backups since the last Full backup
561 into a single Differential backup. This has two effects: 1. It gives
562 some redundancy since the old backups could be used if the merged backup
563 cannot be read. 2. More importantly, it reduces the number of Volumes
564 that are needed to do a restore effectively eliminating the need to read
565 all the volumes on which the preceding Incremental and Differential
566 backups since the last Full are done.
570 For a {\bf Restore} Job, no level needs to be specified.
572 For a {\bf Verify} Job, the Level may be one of the following:
577 \index[dir]{InitCatalog}
578 does a scan of the specified {\bf FileSet} and stores the file
579 attributes in the Catalog database. Since no file data is saved, you
580 might ask why you would want to do this. It turns out to be a very
581 simple and easy way to have a {\bf Tripwire} like feature using {\bf
582 Bacula}. In other words, it allows you to save the state of a set of
583 files defined by the {\bf FileSet} and later check to see if those files
584 have been modified or deleted and if any new files have been added.
585 This can be used to detect system intrusion. Typically you would
586 specify a {\bf FileSet} that contains the set of system files that
587 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
588 run the {\bf InitCatalog} level verify one time when your system is
589 first setup, and then once again after each modification (upgrade) to
590 your system. Thereafter, when your want to check the state of your
591 system files, you use a {\bf Verify} {\bf level = Catalog}. This
592 compares the results of your {\bf InitCatalog} with the current state of
597 Compares the current state of the files against the state previously
598 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
599 items reported are determined by the {\bf verify} options specified on
600 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
601 FileSet} resource below for more details). Typically this command will
602 be run once a day (or night) to check for any changes to your system
605 Please note! If you run two Verify Catalog jobs on the same client at
606 the same time, the results will certainly be incorrect. This is because
607 Verify Catalog modifies the Catalog database while running in order to
610 \item [VolumeToCatalog]
611 \index[dir]{VolumeToCatalog}
612 This level causes Bacula to read the file attribute data written to the
613 Volume from the last Job. The file attribute data are compared to the
614 values saved in the Catalog database and any differences are reported.
615 This is similar to the {\bf Catalog} level except that instead of
616 comparing the disk file attributes to the catalog database, the
617 attribute data written to the Volume is read and compared to the catalog
618 database. Although the attribute data including the signatures (MD5 or
619 SHA1) are compared, the actual file data is not compared (it is not in
622 Please note! If you run two Verify VolumeToCatalog jobs on the same
623 client at the same time, the results will certainly be incorrect. This
624 is because the Verify VolumeToCatalog modifies the Catalog database
627 \item [DiskToCatalog]
628 \index[dir]{DiskToCatalog}
629 This level causes Bacula to read the files as they currently are on
630 disk, and to compare the current file attributes with the attributes
631 saved in the catalog from the last backup for the job specified on the
632 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
633 level described above by the fact that it doesn't compare against a
634 previous Verify job but against a previous backup. When you run this
635 level, you must supply the verify options on your Include statements.
636 Those options determine what attribute fields are compared.
638 This command can be very useful if you have disk problems because it
639 will compare the current state of your disk against the last successful
640 backup, which may be several jobs.
642 Note, the current implementation (1.32c) does not identify files that
646 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
647 \index[dir]{Verify Job}
648 \index[dir]{Directive!Verify Job}
649 If you run a verify job without this directive, the last job run will be
650 compared with the catalog, which means that you must immediately follow
651 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
652 will find the last job with that name that ran. This permits you to run
653 all your backups, then run Verify jobs on those that you wish to be
654 verified (most often a {\bf VolumeToCatalog}) so that the tape just
657 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
659 \index[dir]{Directive!JobDefs}
660 If a JobDefs-Resource-Name is specified, all the values contained in the
661 named JobDefs resource will be used as the defaults for the current Job.
662 Any value that you explicitly define in the current Job resource, will
663 override any defaults specified in the JobDefs resource. The use of
664 this directive permits writing much more compact Job resources where the
665 bulk of the directives are defined in one or more JobDefs. This is
666 particularly useful if you have many similar Jobs but with minor
667 variations such as different Clients. A simple example of the use of
668 JobDefs is provided in the default bacula-dir.conf file.
670 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
671 \index[dir]{Bootstrap}
672 \index[dir]{Directive!Bootstrap}
673 The Bootstrap directive specifies a bootstrap file that, if provided,
674 will be used during {\bf Restore} Jobs and is ignored in other Job
675 types. The {\bf bootstrap} file contains the list of tapes to be used
676 in a restore Job as well as which files are to be restored.
677 Specification of this directive is optional, and if specified, it is
678 used only for a restore job. In addition, when running a Restore job
679 from the console, this value can be changed.
681 If you use the {\bf Restore} command in the Console program, to start a
682 restore job, the {\bf bootstrap} file will be created automatically from
683 the files you select to be restored.
685 For additional details of the {\bf bootstrap} file, please see
686 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
689 \label{writebootstrap}
690 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
691 \index[dir]{Write Bootstrap}
692 \index[dir]{Directive!Write Bootstrap}
693 The {\bf writebootstrap} directive specifies a file name where Bacula
694 will write a {\bf bootstrap} file for each Backup job run. This
695 directive applies only to Backup Jobs. If the Backup job is a Full
696 save, Bacula will erase any current contents of the specified file
697 before writing the bootstrap records. If the Job is an Incremental
699 save, Bacula will append the current bootstrap record to the end of the
702 Using this feature, permits you to constantly have a bootstrap file that
703 can recover the current state of your system. Normally, the file
704 specified should be a mounted drive on another machine, so that if your
705 hard disk is lost, you will immediately have a bootstrap record
706 available. Alternatively, you should copy the bootstrap file to another
707 machine after it is updated. Note, it is a good idea to write a separate
708 bootstrap file for each Job backed up including the job that backs up
709 your catalog database.
711 If the {\bf bootstrap-file-specification} begins with a vertical bar
712 (|), Bacula will use the specification as the name of a program to which
713 it will pipe the bootstrap record. It could for example be a shell
714 script that emails you the bootstrap record.
716 On versions 1.39.22 or greater, before opening the file or executing the
717 specified command, Bacula performs
718 \ilink{character substitution}{character substitution} like in RunScript
719 directive. To automatically manage your bootstrap files, you can use
720 this in your {\bf JobDefs} resources:
723 Write Bootstrap = "%c_%n.bsr"
728 For more details on using this file, please see the chapter entitled
729 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
731 \item [Client = \lt{}client-resource-name\gt{}]
733 \index[dir]{Directive!Client}
734 The Client directive specifies the Client (File daemon) that will be used in
735 the current Job. Only a single Client may be specified in any one Job. The
736 Client runs on the machine to be backed up, and sends the requested files to
737 the Storage daemon for backup, or receives them when restoring. For
738 additional details, see the
739 \ilink{Client Resource section}{ClientResource2} of this chapter.
740 This directive is required.
742 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
745 The FileSet directive specifies the FileSet that will be used in the
746 current Job. The FileSet specifies which directories (or files) are to
747 be backed up, and what options to use (e.g. compression, ...). Only a
748 single FileSet resource may be specified in any one Job. For additional
749 details, see the \ilink{FileSet Resource section}{FileSetResource} of
750 this chapter. This directive is required.
752 \item [Messages = \lt{}messages-resource-name\gt{}]
753 \index[dir]{Messages}
754 \index[dir]{Directive!Messages}
755 The Messages directive defines what Messages resource should be used for
756 this job, and thus how and where the various messages are to be
757 delivered. For example, you can direct some messages to a log file, and
758 others can be sent by email. For additional details, see the
759 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
760 directive is required.
762 \item [Pool = \lt{}pool-resource-name\gt{}]
764 \index[dir]{Directive!Pool}
765 The Pool directive defines the pool of Volumes where your data can be
766 backed up. Many Bacula installations will use only the {\bf Default}
767 pool. However, if you want to specify a different set of Volumes for
768 different Clients or different Jobs, you will probably want to use
769 Pools. For additional details, see the \ilink{Pool Resource
770 section}{PoolResource} of this chapter. This directive is required.
772 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
773 \index[dir]{Full Backup Pool}
774 \index[dir]{Directive!Full Backup Pool}
775 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
776 It will override any Pool specification during a Full backup. This
777 directive is optional.
779 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
780 \index[dir]{Differential Backup Pool}
781 \index[dir]{Directive!Differential Backup Pool}
782 The {\it Differential Backup Pool} specifies a Pool to be used for
783 Differential backups. It will override any Pool specification during a
784 Differential backup. This directive is optional.
786 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
787 \index[dir]{Incremental Backup Pool}
788 \index[dir]{Directive!Incremental Backup Pool}
789 The {\it Incremental Backup Pool} specifies a Pool to be used for
790 Incremental backups. It will override any Pool specification during an
791 Incremental backup. This directive is optional.
793 \item [Schedule = \lt{}schedule-name\gt{}]
794 \index[dir]{Schedule}
795 \index[dir]{Directive!Schedule}
796 The Schedule directive defines what schedule is to be used for the Job.
797 The schedule in turn determines when the Job will be automatically
798 started and what Job level (i.e. Full, Incremental, ...) is to be run.
799 This directive is optional, and if left out, the Job can only be started
800 manually using the Console program. Although you may specify only a
801 single Schedule resource for any one job, the Schedule resource may
802 contain multiple {\bf Run} directives, which allow you to run the Job at
803 many different times, and each {\bf run} directive permits overriding
804 the default Job Level Pool, Storage, and Messages resources. This gives
805 considerable flexibility in what can be done with a single Job. For
806 additional details, see the \ilink{Schedule Resource
807 Chapter}{ScheduleResource} of this manual.
810 \item [Storage = \lt{}storage-resource-name\gt{}]
812 \index[dir]{Directive!Storage}
813 The Storage directive defines the name of the storage services where you
814 want to backup the FileSet data. For additional details, see the
815 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
816 The Storage resource may also be specified in the Job's Pool resource,
817 in which case the value in the Pool resource overrides any value
818 in the Job. This Storage resource definition is not required by either
819 the Job resource or in the Pool, but it must be specified in
820 one or the other, if not an error will result.
822 \item [Max Start Delay = \lt{}time\gt{}]
823 \index[dir]{Max Start Delay}
824 \index[dir]{Directive!Max Start Delay}
825 The time specifies the maximum delay between the scheduled time and the
826 actual start time for the Job. For example, a job can be scheduled to
827 run at 1:00am, but because other jobs are running, it may wait to run.
828 If the delay is set to 3600 (one hour) and the job has not begun to run
829 by 2:00am, the job will be canceled. This can be useful, for example,
830 to prevent jobs from running during day time hours. The default is 0
831 which indicates no limit.
833 \item [Max Run Time = \lt{}time\gt{}]
834 \index[dir]{Max Run Time}
835 \index[dir]{Directive!Max Run Time}
836 The time specifies the maximum allowed time that a job may run, counted
837 from when the job starts, ({\bf not} necessarily the same as when the
838 job was scheduled). This directive is implemented in version 1.33 and
841 \item [Max Wait Time = \lt{}time\gt{}]
842 \index[dir]{Max Wait Time}
843 \index[dir]{Directive!Max Wait Time}
844 The time specifies the maximum allowed time that a job may block waiting
845 for a resource (such as waiting for a tape to be mounted, or waiting for
846 the storage or file daemons to perform their duties), counted from the
847 when the job starts, ({\bf not} necessarily the same as when the job was
848 scheduled). This directive is implemented only in version 1.33 and
851 \item [Incremental Max Wait Time = \lt{}time\gt{}]
852 \index[dir]{Incremental Max Wait Time}
853 \index[dir]{Directive!Incremental Max Wait Time}
854 The time specifies the maximum allowed time that an Incremental backup
855 job may block waiting for a resource (such as waiting for a tape to be
856 mounted, or waiting for the storage or file daemons to perform their
857 duties), counted from the when the job starts, ({\bf not} necessarily
858 the same as when the job was scheduled). Please note that if there is a
859 {\bf Max Wait Time} it may also be applied to the job.
861 \item [Differential Max Wait Time = \lt{}time\gt{}]
862 \index[dir]{Differential Max Wait Time}
863 \index[dir]{Directive!Differential Max Wait Time}
864 The time specifies the maximum allowed time that a Differential backup
865 job may block waiting for a resource (such as waiting for a tape to be
866 mounted, or waiting for the storage or file daemons to perform their
867 duties), counted from the when the job starts, ({\bf not} necessarily
868 the same as when the job was scheduled). Please note that if there is a
869 {\bf Max Wait Time} it may also be applied to the job.
871 \label{PreferMountedVolumes}
872 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
873 \index[dir]{Prefer Mounted Volumes}
874 \index[dir]{Directive!Prefer Mounted Volumes}
875 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
876 yes), the Storage daemon is requested to select either an Autochanger or
877 a drive with a valid Volume already mounted in preference to a drive
878 that is not ready. This means that all jobs will attempt to append
879 to the same Volume (providing the Volume is appropriate -- right Pool,
880 ... for that job). If no drive with a suitable Volume is available, it
881 will select the first available drive. Note, any Volume that has
882 been requested to be mounted, will be considered valid as a mounted
883 volume by another job. This if multiple jobs start at the same time
884 and they all prefer mounted volumes, the first job will request the
885 mount, and the other jobs will use the same volume.
887 If the directive is set to {\bf no}, the Storage daemon will prefer
888 finding an unused drive, otherwise, each job started will append to the
889 same Volume (assuming the Pool is the same for all jobs). Setting
890 Prefer Mounted Volumes to no can be useful for those sites
891 with multiple drive autochangers that prefer to maximize backup
892 throughput at the expense of using additional drives and Volumes.
893 This means that the job will prefer to use an unused drive rather
894 than use a drive that is already in use.
896 \item [Prune Jobs = \lt{}yes|no\gt{}]
897 \index[dir]{Prune Jobs}
898 \index[dir]{Directive!Prune Jobs}
899 Normally, pruning of Jobs from the Catalog is specified on a Client by
900 Client basis in the Client resource with the {\bf AutoPrune} directive.
901 If this directive is specified (not normally) and the value is {\bf
902 yes}, it will override the value specified in the Client resource. The
906 \item [Prune Files = \lt{}yes|no\gt{}]
907 \index[dir]{Prune Files}
908 \index[dir]{Directive!Prune Files}
909 Normally, pruning of Files from the Catalog is specified on a Client by
910 Client basis in the Client resource with the {\bf AutoPrune} directive.
911 If this directive is specified (not normally) and the value is {\bf
912 yes}, it will override the value specified in the Client resource. The
915 \item [Prune Volumes = \lt{}yes|no\gt{}]
916 \index[dir]{Prune Volumes}
917 \index[dir]{Directive!Prune Volumes}
918 Normally, pruning of Volumes from the Catalog is specified on a Client
919 by Client basis in the Client resource with the {\bf AutoPrune}
920 directive. If this directive is specified (not normally) and the value
921 is {\bf yes}, it will override the value specified in the Client
922 resource. The default is {\bf no}.
924 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
925 \index[dir]{RunScript}
926 \index[dir]{Directive!Run Script}
928 This directive is implemented in version 1.39.22 and later.
929 The RunScript directive behaves like a resource in that it
930 requires opening and closing braces around a number of directives
931 that make up the body of the runscript.
933 The specified {\bf Command} (see below for details) is run as an
934 external program prior or after the current Job. This is optional.
936 You can use following options may be specified in the body
939 \begin{tabular}{|c|c|c|l}
940 Options & Value & Default & Information \\
943 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
945 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
947 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
949 Runs When & Before|After|Always & {\it Never} & When run commands\\
951 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
952 something different from 0 \\
954 Command & & & Path to your script\\
959 Any output sent by the command to standard output will be included in the
960 Bacula job report. The command string must be a valid program name or name
963 In addition, the command string is parsed then fed to the OS,
964 which means that the path will be searched to execute your specified
965 command, but there is no shell interpretation, as a consequence, if you
966 invoke complicated commands or want any shell features such as redirection
967 or piping, you must call a shell script and do it inside that script.
969 Before submitting the specified command to the operating system, Bacula
970 performs character substitution of the following characters:
972 \label{character substitution}
984 %t = Job type (Backup, ...)
990 The Job Exit Status code \%e edits the following values:
992 \index[dir]{Exit Status}
999 \item Unknown term code
1002 Thus if you edit it on a command line, you will need to enclose
1003 it within some sort of quotes.
1006 You can use these following shortcuts:\\
1008 \begin{tabular}{|c|c|c|c|c|c}
1009 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1011 Run Before Job & & & Yes & No & Before \\
1013 Run After Job & Yes & No & & No & After \\
1015 Run After Failed Job & No & Yes & & No & After \\
1017 Client Run Before Job & & & Yes & Yes & Before \\
1019 Client Run After Job & Yes & No & & Yes & After \\
1027 Command = "/etc/init.d/apache stop"
1033 Command = "/etc/init.d/apache start"
1037 {\bf Special Windows Considerations}
1039 In addition, for a Windows client on version 1.33 and above, please take
1040 note that you must ensure a correct path to your script. The script or
1041 program can be a .com, .exe or a .bat file. If you just put the program
1042 name in then Bacula will search using the same rules that cmd.exe uses
1043 (current directory, Bacula bin directory, and PATH). It will even try the
1044 different extensions in the same order as cmd.exe.
1045 The command can be anything that cmd.exe or command.com will recognize
1046 as an executable file.
1048 However, if you have slashes in the program name then Bacula figures you
1049 are fully specifying the name, so you must also explicitly add the three
1050 character extension.
1052 The command is run in a Win32 environment, so Unix like commands will not
1053 work unless you have installed and properly configured Cygwin in addition
1054 to and separately from Bacula.
1056 The System \%Path\% will be searched for the command. (under the
1057 environment variable dialog you have have both System Environment and
1058 User Environment, we believe that only the System environment will be
1059 available to bacula-fd, if it is running as a service.)
1061 System environment variables can be referenced with \%var\% and
1062 used as either part of the command name or arguments.
1064 So if you have a script in the Bacula\\bin directory then the following lines
1069 Client Run Before Job = systemstate
1071 Client Run Before Job = systemstate.bat
1073 Client Run Before Job = "systemstate"
1075 Client Run Before Job = "systemstate.bat"
1077 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1081 The outer set of quotes is removed when the configuration file is parsed.
1082 You need to escape the inner quotes so that they are there when the code
1083 that parses the command line for execution runs so it can tell what the
1089 ClientRunBeforeJob = "\"C:/Program Files/Software
1090 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1094 The special characters
1098 will need to be quoted,
1099 if they are part of a filename or argument.
1101 If someone is logged in, a blank "command" window running the commands
1102 will be present during the execution of the command.
1104 Some Suggestions from Phil Stracchino for running on Win32 machines with
1105 the native Win32 File daemon:
1108 \item You might want the ClientRunBeforeJob directive to specify a .bat
1109 file which runs the actual client-side commands, rather than trying
1110 to run (for example) regedit /e directly.
1111 \item The batch file should explicitly 'exit 0' on successful completion.
1112 \item The path to the batch file should be specified in Unix form:
1114 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1116 rather than DOS/Windows form:
1118 ClientRunBeforeJob =
1120 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1124 For Win32, please note that there are certain limitations:
1126 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1128 Lines like the above do not work because there are limitations of
1129 cmd.exe that is used to execute the command.
1130 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1131 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1132 cmd prompt and see what happens. Once the command is correct insert a
1133 backslash (\textbackslash{}) before each double quote ("), and
1134 then put quotes around the whole thing when putting it in
1135 the director's .conf file. You either need to have only one set of quotes
1136 or else use the short name and don't put quotes around the command path.
1138 Below is the output from cmd's help as it relates to the command line
1139 passed to the /c option.
1142 If /C or /K is specified, then the remainder of the command line after
1143 the switch is processed as a command line, where the following logic is
1144 used to process quote (") characters:
1148 If all of the following conditions are met, then quote characters
1149 on the command line are preserved:
1152 \item exactly two quote characters.
1153 \item no special characters between the two quote characters,
1154 where special is one of:
1158 \item there are one or more whitespace characters between the
1159 the two quote characters.
1160 \item the string between the two quote characters is the name
1161 of an executable file.
1164 \item Otherwise, old behavior is to see if the first character is
1165 a quote character and if so, strip the leading character and
1166 remove the last quote character on the command line, preserving
1167 any text after the last quote character.
1172 The following example of the use of the Client Run Before Job directive was
1173 submitted by a user:\\
1174 You could write a shell script to back up a DB2 database to a FIFO. The shell
1184 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1189 The following line in the Job resource in the bacula-dir.conf file:
1192 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1197 When the job is run, you will get messages from the output of the script
1198 stating that the backup has started. Even though the command being run is
1199 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1200 command, thus the backup stalls.
1202 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1207 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1212 It is important to redirect the input and outputs of a backgrounded command to
1213 /dev/null to prevent the script from blocking.
1215 \item [Run Before Job = \lt{}command\gt{}]
1216 \index[dir]{Run Before Job}
1217 \index[dir]{Directive!Run Before Job}
1218 \index[dir]{Directive!Run Before Job}
1219 The specified {\bf command} is run as an external program prior to running the
1220 current Job. This directive is not required, but if it is defined, and if the
1221 exit code of the program run is non-zero, the current Bacula job will be
1225 Run Before Job = "echo test"
1227 it's equivalent to :
1230 Command = "echo test"
1236 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1237 simple way to modify your schedules during a holiday. For example, suppose
1238 that you normally do Full backups on Fridays, but Thursday and Friday are
1239 holidays. To avoid having to change tapes between Thursday and Friday when
1240 no one is in the office, you can create a RunBeforeJob that returns a
1241 non-zero status on Thursday and zero on all other days. That way, the
1242 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1243 before leaving will be used.
1245 \item [Run After Job = \lt{}command\gt{}]
1246 \index[dir]{Run After Job}
1247 \index[dir]{Directive!Run After Job}
1248 The specified {\bf command} is run as an external program if the current
1249 job terminates normally (without error or without being canceled). This
1250 directive is not required. If the exit code of the program run is
1251 non-zero, Bacula will print a warning message. Before submitting the
1252 specified command to the operating system, Bacula performs character
1253 substitution as described above for the {\bf RunScript} directive.
1255 An example of the use of this directive is given in the
1256 \ilink{Tips Chapter}{JobNotification} of this manual.
1258 See the {\bf Run After Failed Job} if you
1259 want to run a script after the job has terminated with any
1262 \item [Run After Failed Job = \lt{}command\gt{}]
1263 \index[dir]{Run After Job}
1264 \index[dir]{Directive!Run After Job}
1265 The specified {\bf command} is run as an external program after the current
1266 job terminates with any error status. This directive is not required. The
1267 command string must be a valid program name or name of a shell script. If
1268 the exit code of the program run is non-zero, Bacula will print a
1269 warning message. Before submitting the specified command to the
1270 operating system, Bacula performs character substitution as described above
1271 for the {\bf RunScript} directive. Note, if you wish that your script
1272 will run regardless of the exit status of the Job, you can use this :
1275 Command = "echo test"
1279 RunsOnSuccess = yes # default, you can drop this line
1283 An example of the use of this directive is given in the
1284 \ilink{Tips Chapter}{JobNotification} of this manual.
1287 \item [Client Run Before Job = \lt{}command\gt{}]
1288 \index[dir]{Client Run Before Job}
1289 \index[dir]{Directive!Client Run Before Job}
1290 This directive is the same as {\bf Run Before Job} except that the
1291 program is run on the client machine. The same restrictions apply to
1292 Unix systems as noted above for the {\bf RunScript}.
1294 \item [Client Run After Job = \lt{}command\gt{}]
1295 \index[dir]{Client Run After Job}
1296 \index[dir]{Directive!Client Run After Job}
1297 The specified {\bf command} is run on the client machine as soon
1298 as data spooling is complete in order to allow restarting applications
1299 on the client as soon as possible. .
1301 Note, please see the notes above in {\bf RunScript}
1302 concerning Windows clients.
1304 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
1305 \index[dir]{Rerun Failed Levels}
1306 \index[dir]{Directive!Rerun Failed Levels}
1307 If this directive is set to {\bf yes} (default no), and Bacula detects that
1308 a previous job at a higher level (i.e. Full or Differential) has failed,
1309 the current job level will be upgraded to the higher level. This is
1310 particularly useful for Laptops where they may often be unreachable, and if
1311 a prior Full save has failed, you wish the very next backup to be a Full
1312 save rather than whatever level it is started as.
1314 There are several points that must be taken into account when using this
1315 directive: first, a failed job is defined as one that has not terminated
1316 normally, which includes any running job of the same name (you need to
1317 ensure that two jobs of the same name do not run simultaneously);
1318 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1319 when checing for failed levels, which means that any FileSet change will
1322 \item [Spool Data = \lt{}yes|no\gt{}]
1323 \index[dir]{Spool Data}
1324 \index[dir]{Directive!Spool Data}
1326 If this directive is set to {\bf yes} (default no), the Storage daemon will
1327 be requested to spool the data for this Job to disk rather than write it
1328 directly to tape. Once all the data arrives or the spool files' maximum sizes
1329 are reached, the data will be despooled and written to tape. Spooling data
1330 prevents tape shoe-shine (start and stop) during
1331 Incremental saves. If you are writing to a disk file using this option
1332 will probably just slow down the backup jobs.
1334 NOTE: When this directive is set to yes, Spool Attributes is also
1335 automatically set to yes.
1337 \item [Spool Attributes = \lt{}yes|no\gt{}]
1338 \index[dir]{Spool Attributes}
1339 \index[dir]{Directive!Spool Attributes}
1341 \index[general]{slow}
1342 \index[dir]{Backups!slow}
1343 \index[general]{Backups!slow}
1344 The default is set to {\bf no}, which means that the File attributes are
1345 sent by the Storage daemon to the Director as they are stored on tape.
1346 However, if you want to avoid the possibility that database updates will
1347 slow down writing to the tape, you may want to set the value to {\bf
1348 yes}, in which case the Storage daemon will buffer the File attributes
1349 and Storage coordinates to a temporary file in the Working Directory,
1350 then when writing the Job data to the tape is completed, the attributes
1351 and storage coordinates will be sent to the Director.
1353 NOTE: When Spool Data is set to yes, Spool Attributes is also
1354 automatically set to yes.
1356 \item [Where = \lt{}directory\gt{}]
1358 \index[dir]{Directive!Where}
1359 This directive applies only to a Restore job and specifies a prefix to
1360 the directory name of all files being restored. This permits files to
1361 be restored in a different location from which they were saved. If {\bf
1362 Where} is not specified or is set to backslash ({\bf /}), the files will
1363 be restored to their original location. By default, we have set {\bf
1364 Where} in the example configuration files to be {\bf
1365 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1368 \item [Add Prefix = \lt{}directory\gt{}]
1369 \label{confaddprefix}
1370 \index[dir]{AddPrefix}
1371 \index[dir]{Directive!AddPrefix}
1372 This directive applies only to a Restore job and specifies a prefix to the
1373 directory name of all files being restored. This will use \ilink{File
1374 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1376 \item [Add Suffix = \lt{}extention\gt{}]
1377 \index[dir]{AddSuffix}
1378 \index[dir]{Directive!AddSuffix}
1379 This directive applies only to a Restore job and specifies a suffix to all
1380 files being restored. This will use \ilink{File Relocation}{filerelocation}
1381 feature implemented in Bacula 2.1.8 or later.
1383 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1384 \texttt{/etc/passwsd.old}
1386 \item [Strip Prefix = \lt{}directory\gt{}]
1387 \index[dir]{StripPrefix}
1388 \index[dir]{Directive!StripPrefix}
1389 This directive applies only to a Restore job and specifies a prefix to remove
1390 from directory name of all files being restored. This will use \ilink{File
1391 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1393 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1396 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1404 \item [RegexWhere = \lt{}expressions\gt{}]
1405 \index[dir]{RegexWhere}
1406 \index[dir]{Directive!RegexWhere}
1407 This directive applies only to a Restore job and specifies a regex filename
1408 manipulation of all files being restored. This will use \ilink{File
1409 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1411 For more informations about how use this option, see
1412 \ilink{this}{useregexwhere}.
1414 \item [Replace = \lt{}replace-option\gt{}]
1415 \index[dir]{Replace}
1416 \index[dir]{Directive!Replace}
1417 This directive applies only to a Restore job and specifies what happens
1418 when Bacula wants to restore a file or directory that already exists.
1419 You have the following options for {\bf replace-option}:
1425 when the file to be restored already exists, it is deleted and then
1426 replaced by the copy that was backed up.
1429 \index[dir]{ifnewer}
1430 if the backed up file (on tape) is newer than the existing file, the
1431 existing file is deleted and replaced by the back up.
1434 \index[dir]{ifolder}
1435 if the backed up file (on tape) is older than the existing file, the
1436 existing file is deleted and replaced by the back up.
1440 if the backed up file already exists, Bacula skips restoring this file.
1443 \item [Prefix Links=\lt{}yes|no\gt{}]
1444 \index[dir]{Prefix Links}
1445 \index[dir]{Directive!Prefix Links}
1446 If a {\bf Where} path prefix is specified for a recovery job, apply it
1447 to absolute links as well. The default is {\bf No}. When set to {\bf
1448 Yes} then while restoring files to an alternate directory, any absolute
1449 soft links will also be modified to point to the new alternate
1450 directory. Normally this is what is desired -- i.e. everything is self
1451 consistent. However, if you wish to later move the files to their
1452 original locations, all files linked with absolute names will be broken.
1454 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1455 \index[dir]{Maximum Concurrent Jobs}
1456 \index[dir]{Directive!Maximum Concurrent Jobs}
1457 where \lt{}number\gt{} is the maximum number of Jobs from the current
1458 Job resource that can run concurrently. Note, this directive limits
1459 only Jobs with the same name as the resource in which it appears. Any
1460 other restrictions on the maximum concurrent jobs such as in the
1461 Director, Client, or Storage resources will also apply in addition to
1462 the limit specified here. The default is set to 1, but you may set it
1463 to a larger number. We strongly recommend that you read the WARNING
1464 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1465 Director's resource.
1467 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1468 \index[dir]{Reschedule On Error}
1469 \index[dir]{Directive!Reschedule On Error}
1470 If this directive is enabled, and the job terminates in error, the job
1471 will be rescheduled as determined by the {\bf Reschedule Interval} and
1472 {\bf Reschedule Times} directives. If you cancel the job, it will not
1473 be rescheduled. The default is {\bf no} (i.e. the job will not be
1476 This specification can be useful for portables, laptops, or other
1477 machines that are not always connected to the network or switched on.
1479 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1480 \index[dir]{Reschedule Interval}
1481 \index[dir]{Directive!Reschedule Interval}
1482 If you have specified {\bf Reschedule On Error = yes} and the job
1483 terminates in error, it will be rescheduled after the interval of time
1484 specified by {\bf time-specification}. See \ilink{the time
1485 specification formats}{Time} in the Configure chapter for details of
1486 time specifications. If no interval is specified, the job will not be
1487 rescheduled on error.
1489 \item [Reschedule Times = \lt{}count\gt{}]
1490 \index[dir]{Reschedule Times}
1491 \index[dir]{Directive!Reschedule Times}
1492 This directive specifies the maximum number of times to reschedule the
1493 job. If it is set to zero (the default) the job will be rescheduled an
1494 indefinite number of times.
1496 \item [Run = \lt{}job-name\gt{}]
1498 \index[dir]{Directive!Run}
1499 \index[dir]{Clone a Job}
1500 The Run directive (not to be confused with the Run option in a
1501 Schedule) allows you to start other jobs or to clone jobs. By using the
1502 cloning keywords (see below), you can backup
1503 the same data (or almost the same data) to two or more drives
1504 at the same time. The {\bf job-name} is normally the same name
1505 as the current Job resource (thus creating a clone). However, it
1506 may be any Job name, so one job may start other related jobs.
1508 The part after the equal sign must be enclosed in double quotes,
1509 and can contain any string or set of options (overrides) that you
1510 can specify when entering the Run command from the console. For
1511 example {\bf storage=DDS-4 ...}. In addition, there are two special
1512 keywords that permit you to clone the current job. They are {\bf level=\%l}
1513 and {\bf since=\%s}. The \%l in the level keyword permits
1514 entering the actual level of the current job and the \%s in the since
1515 keyword permits putting the same time for comparison as used on the
1516 current job. Note, in the case of the since keyword, the \%s must be
1517 enclosed in double quotes, and thus they must be preceded by a backslash
1518 since they are already inside quotes. For example:
1521 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1524 A cloned job will not start additional clones, so it is not
1525 possible to recurse.
1528 \item [Priority = \lt{}number\gt{}]
1529 \index[dir]{Priority}
1530 \index[dir]{Directive!Priority}
1531 This directive permits you to control the order in which your jobs will
1532 be run by specifying a positive non-zero number. The higher the number,
1533 the lower the job priority. Assuming you are not running concurrent jobs,
1534 all queued jobs of priority 1 will run before queued jobs of priority 2
1535 and so on, regardless of the original scheduling order.
1537 The priority only affects waiting jobs that are queued to run, not jobs
1538 that are already running. If one or more jobs of priority 2 are already
1539 running, and a new job is scheduled with priority 1, the currently
1540 running priority 2 jobs must complete before the priority 1 job is run.
1542 The default priority is 10.
1544 If you want to run concurrent jobs you should
1545 keep these points in mind:
1548 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1551 \item Bacula concurrently runs jobs of only one priority at a time. It
1552 will not simultaneously run a priority 1 and a priority 2 job.
1554 \item If Bacula is running a priority 2 job and a new priority 1 job is
1555 scheduled, it will wait until the running priority 2 job terminates even
1556 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1557 to run simultaneously.
1559 \item Suppose that bacula is running a priority 2 job and a new priority 1
1560 job is scheduled and queued waiting for the running priority 2 job to
1561 terminate. If you then start a second priority 2 job, the waiting
1562 priority 1 job will prevent the new priority 2 job from running
1563 concurrently with the running priority 2 job. That is: as long as there
1564 is a higher priority job waiting to run, no new lower priority jobs will
1565 start even if the Maximum Concurrent Jobs settings would normally allow
1566 them to run. This ensures that higher priority jobs will be run as soon
1570 If you have several jobs of different priority, it may not best to start
1571 them at exactly the same time, because Bacula must examine them one at a
1572 time. If by Bacula starts a lower priority job first, then it will run
1573 before your high priority jobs. If you experience this problem, you may
1574 avoid it by starting any higher priority jobs a few seconds before lower
1575 priority ones. This insures that Bacula will examine the jobs in the
1576 correct order, and that your priority scheme will be respected.
1578 \label{WritePartAfterJob}
1579 \item [Write Part After Job = \lt{}yes|no\gt{}]
1580 \index[dir]{Write Part After Job}
1581 \index[dir]{Directive!Write Part After Job}
1582 This directive is only implemented in version 1.37 and later.
1583 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1584 will be created after the job is finished.
1586 It should be set to {\bf yes} when writing to devices that require mount
1587 (for example DVD), so you are sure that the current part, containing
1588 this job's data, is written to the device, and that no data is left in
1589 the temporary file on the hard disk. However, on some media, like DVD+R
1590 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1591 written. So, if you run several jobs each after another, you could set
1592 this directive to {\bf no} for all jobs, except the last one, to avoid
1593 wasting too much space, but to ensure that the data is written to the
1594 medium when all jobs are finished.
1596 This directive is ignored with tape and FIFO devices.
1598 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
1599 \index[dir]{Heartbeat Interval}
1600 \index[dir]{Directive!Heartbeat}
1601 This directive is optional and if specified will cause the Director to
1602 set a keepalive interval (heartbeat) in seconds on each of the sockets
1603 it opens for the Client resource. This value will override any
1604 specified at the Director level. It is implemented only on systems
1605 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
1606 The default value is zero, which means no change is made to the socket.
1610 The following is an example of a valid Job resource definition:
1617 Level = Incremental # default
1619 FileSet="Minou Full Set"
1622 Schedule = "MinouWeeklyCycle"
1628 \section{The JobDefs Resource}
1629 \label{JobDefsResource}
1630 \index[general]{JobDefs Resource}
1631 \index[general]{Resource!JobDefs}
1633 The JobDefs resource permits all the same directives that can appear in a Job
1634 resource. However, a JobDefs resource does not create a Job, rather it can be
1635 referenced within a Job to provide defaults for that Job. This permits you to
1636 concisely define several nearly identical Jobs, each one referencing a JobDefs
1637 resource which contains the defaults. Only the changes from the defaults need to
1638 be mentioned in each Job.
1640 \section{The Schedule Resource}
1641 \label{ScheduleResource}
1642 \index[general]{Resource!Schedule}
1643 \index[general]{Schedule Resource}
1645 The Schedule resource provides a means of automatically scheduling a Job as
1646 well as the ability to override the default Level, Pool, Storage and Messages
1647 resources. If a Schedule resource is not referenced in a Job, the Job can only
1648 be run manually. In general, you specify an action to be taken and when.
1653 \index[dir]{Schedule}
1654 \index[dir]{Directive!Schedule}
1655 Start of the Schedule directives. No {\bf Schedule} resource is
1656 required, but you will need at least one if you want Jobs to be
1657 automatically started.
1659 \item [Name = \lt{}name\gt{}]
1661 \index[dir]{Directive!Name}
1662 The name of the schedule being defined. The Name directive is required.
1664 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1666 \index[dir]{Directive!Run}
1667 The Run directive defines when a Job is to be run, and what overrides if
1668 any to apply. You may specify multiple {\bf run} directives within a
1669 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1670 multiple schedules). If you have two {\bf Run} directives that start at
1671 the same time, two Jobs will start at the same time (well, within one
1672 second of each other).
1674 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1675 Messages, and the Pool specifications provided in the Job resource. In
1676 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1677 specifications permit overriding the Pool specification according to
1678 what backup Job Level is in effect.
1680 By the use of overrides, you may customize a particular Job. For
1681 example, you may specify a Messages override for your Incremental
1682 backups that outputs messages to a log file, but for your weekly or
1683 monthly Full backups, you may send the output by email by using a
1684 different Messages override.
1686 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1687 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1688 or IncrementalPool, and the {\bf value} is as defined on the respective
1689 directive formats for the Job resource. You may specify multiple {\bf
1690 Job-overrides} on one {\bf Run} directive by separating them with one or
1691 more spaces or by separating them with a trailing comma. For example:
1697 \index[dir]{Directive!Level}
1698 is all files in the FileSet whether or not they have changed.
1700 \item [Level=Incremental]
1702 \index[dir]{Directive!Level}
1703 is all files that have changed since the last backup.
1707 \index[dir]{Directive!Pool}
1708 specifies to use the Pool named {\bf Weekly}.
1710 \item [Storage=DLT\_Drive]
1711 \index[dir]{Storage}
1712 \index[dir]{Directive!Storage}
1713 specifies to use {\bf DLT\_Drive} for the storage device.
1715 \item [Messages=Verbose]
1716 \index[dir]{Messages}
1717 \index[dir]{Directive!Messages}
1718 specifies to use the {\bf Verbose} message resource for the Job.
1720 \item [FullPool=Full]
1721 \index[dir]{FullPool}
1722 \index[dir]{Directive!FullPool}
1723 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1725 upgraded from another type to a full backup.
1727 \item [DifferentialPool=Differential]
1728 \index[dir]{DifferentialPool}
1729 \index[dir]{Directive!DifferentialPool}
1730 specifies to use the Pool named {\bf Differential} if the job is a
1731 differential backup.
1733 \item [IncrementalPool=Incremental]
1734 \index[dir]{IncrementalPool}
1735 \index[dir]{Directive!IncrementalPool}
1736 specifies to use the Pool named {\bf Incremental} if the job is an
1739 \item [SpoolData=yes|no]
1740 \index[dir]{SpoolData}
1741 \index[dir]{Directive!SpoolData}
1742 tells Bacula to request the Storage daemon to spool data to a disk file
1743 before putting it on tape.
1745 \item [WritePartAfterJob=yes|no]
1746 \index[dir]{WritePartAfterJob}
1747 \index[dir]{Directive!WritePartAfterJob}
1748 tells Bacula to request the Storage daemon to write the current part
1749 file to the device when the job is finished (see \ilink{Write Part After
1750 Job directive in the Job resource}{WritePartAfterJob}). Please note,
1751 this directive is implemented only in version 1.37 and later. The
1752 default is yes. We strongly recommend that you keep this set to yes
1753 otherwise, when the last job has finished one part will remain in the
1754 spool file and restore may or may not work.
1758 {\bf Date-time-specification} determines when the Job is to be run. The
1759 specification is a repetition, and as a default Bacula is set to run a job at
1760 the beginning of the hour of every hour of every day of every week of every
1761 month of every year. This is not normally what you want, so you must specify
1762 or limit when you want the job to run. Any specification given is assumed to
1763 be repetitive in nature and will serve to override or limit the default
1764 repetition. This is done by specifying masks or times for the hour, day of the
1765 month, day of the week, week of the month, week of the year, and month when
1766 you want the job to run. By specifying one or more of the above, you can
1767 define a schedule to repeat at almost any frequency you want.
1769 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1770 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1771 is special in that you may either specify a day of the month such as 1, 2,
1772 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1773 Sunday. Finally, you may also specify a week qualifier to restrict the
1774 schedule to the first, second, third, fourth, or fifth week of the month.
1776 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1777 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1778 month} and {\bf hour} remain set to the defaults of every month and all
1781 Note, by default with no other specification, your job will run at the
1782 beginning of every hour. If you wish your job to run more than once in any
1783 given hour, you will need to specify multiple {\bf run} specifications each
1784 with a different minute.
1786 The date/time to run the Job can be specified in the following way in
1793 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1794 second | third | fourth | fifth
1795 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1796 sunday | monday | tuesday | wednesday |
1797 thursday | friday | saturday
1798 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1799 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1800 aug | sep | oct | nov | dec | january |
1801 february | ... | december
1802 <daily-keyword> = daily
1803 <weekly-keyword> = weekly
1804 <monthly-keyword> = monthly
1805 <hourly-keyword> = hourly
1806 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1807 <number> = <digit> | <digit><number>
1808 <12hour> = 0 | 1 | 2 | ... 12
1809 <hour> = 0 | 1 | 2 | ... 23
1810 <minute> = 0 | 1 | 2 | ... 59
1811 <day> = 1 | 2 | ... 31
1812 <time> = <hour>:<minute> |
1813 <12hour>:<minute>am |
1815 <time-spec> = <at-keyword> <time> |
1817 <date-keyword> = <void-keyword> <weekly-keyword>
1818 <day-range> = <day>-<day>
1819 <month-range> = <month-keyword>-<month-keyword>
1820 <wday-range> = <wday-keyword>-<wday-keyword>
1821 <range> = <day-range> | <month-range> |
1823 <date> = <date-keyword> | <day> | <range>
1824 <date-spec> = <date> | <date-spec>
1825 <day-spec> = <day> | <wday-keyword> |
1826 <day-range> | <wday-range> |
1828 <day-spec> = <day> | <wday-keyword> |
1829 <day> | <wday-range> |
1830 <week-keyword> <wday-keyword> |
1831 <week-keyword> <wday-range>
1832 <month-spec> = <month-keyword> | <month-range> |
1834 <date-time-spec> = <month-spec> <day-spec> <time-spec>
1840 Note, the Week of Year specification wnn follows the ISO standard definition
1841 of the week of the year, where Week 1 is the week in which the first Thursday
1842 of the year occurs, or alternatively, the week which contains the 4th of
1843 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
1844 precedes the first ISO week (i.e. has the first few days of the year if any
1845 occur before Thursday). w00 is not defined by the ISO specification. A week
1846 starts with Monday and ends with Sunday.
1848 According to the NIST (US National Institute of Standards and Technology),
1849 12am and 12pm are ambiguous and can be defined to anything. However,
1850 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
1851 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
1852 this abiguity (confusion) by using 24 hour time specifications (i.e. no
1853 am/pm). This is the definition in Bacula version 2.0.3 and later.
1855 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
1856 with level full each Sunday at 2:05am and an incremental job Monday through
1857 Saturday at 2:05am is:
1862 Name = "WeeklyCycle"
1863 Run = Level=Full sun at 2:05
1864 Run = Level=Incremental mon-sat at 2:05
1869 An example of a possible monthly cycle is as follows:
1874 Name = "MonthlyCycle"
1875 Run = Level=Full Pool=Monthly 1st sun at 2:05
1876 Run = Level=Differential 2nd-5th sun at 2:05
1877 Run = Level=Incremental Pool=Daily mon-sat at 2:05
1882 The first of every month:
1888 Run = Level=Full on 1 at 2:05
1889 Run = Level=Incremental on 2-31 at 2:05
1900 Run = Level=Full hourly at 0:05
1901 Run = Level=Full hourly at 0:15
1902 Run = Level=Full hourly at 0:25
1903 Run = Level=Full hourly at 0:35
1904 Run = Level=Full hourly at 0:45
1905 Run = Level=Full hourly at 0:55
1910 \section{Technical Notes on Schedules}
1911 \index[general]{Schedules!Technical Notes on}
1912 \index[general]{Technical Notes on Schedules}
1914 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
1915 minute field to each schedule. The masks are hour, day of the month (mday),
1916 month, day of the week (wday), week of the month (wom), and week of the year
1917 (woy). The schedule is initialized to have the bits of each of these masks
1918 set, which means that at the beginning of every hour, the job will run. When
1919 you specify a month for the first time, the mask will be cleared and the bit
1920 corresponding to your selected month will be selected. If you specify a second
1921 month, the bit corresponding to it will also be added to the mask. Thus when
1922 Bacula checks the masks to see if the bits are set corresponding to the
1923 current time, your job will run only in the two months you have set. Likewise,
1924 if you set a time (hour), the hour mask will be cleared, and the hour you
1925 specify will be set in the bit mask and the minutes will be stored in the
1928 For any schedule you have defined, you can see how these bits are set by doing
1929 a {\bf show schedules} command in the Console program. Please note that the
1930 bit mask is zero based, and Sunday is the first day of the week (bit zero).
1934 \section{The Client Resource}
1935 \label{ClientResource2}
1936 \index[general]{Resource!Client}
1937 \index[general]{Client Resource}
1939 The Client resource defines the attributes of the Clients that are served by
1940 this Director; that is the machines that are to be backed up. You will need
1941 one Client resource definition for each machine to be backed up.
1945 \item [Client (or FileDaemon)]
1946 \index[dir]{Client (or FileDaemon)}
1947 \index[dir]{Directive!Client (or FileDaemon)}
1948 Start of the Client directives.
1950 \item [Name = \lt{}name\gt{}]
1952 \index[dir]{Directive!Name}
1953 The client name which will be used in the Job resource directive or in the
1954 console run command. This directive is required.
1956 \item [Address = \lt{}address\gt{}]
1957 \index[dir]{Address}
1958 \index[dir]{Directive!FD Address}
1959 \index[dir]{File Daemon Address}
1960 \index[dir]{Client Address}
1961 Where the address is a host name, a fully qualified domain name, or a
1962 network address in dotted quad notation for a Bacula File server daemon.
1963 This directive is required.
1965 \item [FD Port = \lt{}port-number\gt{}]
1966 \index[dir]{FD Port}
1967 \index[dir]{Directive!FD Port}
1968 Where the port is a port number at which the Bacula File server daemon can
1969 be contacted. The default is 9102.
1971 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
1972 \index[dir]{Catalog}
1973 \index[dir]{Directive!Catalog}
1974 This specifies the name of the catalog resource to be used for this Client.
1975 This directive is required.
1977 \item [Password = \lt{}password\gt{}]
1978 \index[dir]{Password}
1979 \index[dir]{Directive!Password}
1980 This is the password to be used when establishing a connection with the File
1981 services, so the Client configuration file on the machine to be backed up
1982 must have the same password defined for this Director. This directive is
1983 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1984 Bacula will generate a random password during the configuration process,
1985 otherwise it will be left blank.
1987 \label{FileRetention}
1988 \item [File Retention = \lt{}time-period-specification\gt{}]
1989 \index[dir]{File Retention}
1990 \index[dir]{Directive!File Retention}
1991 The File Retention directive defines the length of time that Bacula will
1992 keep File records in the Catalog database after the End time of the
1993 Job corresponding to the File records.
1994 When this time period expires, and if
1995 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
1996 that are older than the specified File Retention period. Note, this affects
1997 only records in the catalog database. It does not affect your archive
2000 File records may actually be retained for a shorter period than you specify
2001 on this directive if you specify either a shorter {\bf Job Retention} or a
2002 shorter {\bf Volume Retention} period. The shortest retention period of the
2003 three takes precedence. The time may be expressed in seconds, minutes,
2004 hours, days, weeks, months, quarters, or years. See the
2005 \ilink{ Configuration chapter}{Time} of this manual for
2006 additional details of time specification.
2008 The default is 60 days.
2010 \label{JobRetention}
2011 \item [Job Retention = \lt{}time-period-specification\gt{}]
2012 \index[dir]{Job Retention}
2013 \index[dir]{Directive!Job Retention}
2014 The Job Retention directive defines the length of time that Bacula will keep
2015 Job records in the Catalog database after the Job End time. When
2016 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2017 Bacula will prune (remove) Job records that are older than the specified
2018 File Retention period. As with the other retention periods, this
2019 affects only records in the catalog and not data in your archive backup.
2021 If a Job record is selected for pruning, all associated File and JobMedia
2022 records will also be pruned regardless of the File Retention period set.
2023 As a consequence, you normally will set the File retention period to be
2024 less than the Job retention period. The Job retention period can actually
2025 be less than the value you specify here if you set the {\bf Volume
2026 Retention} directive in the Pool resource to a smaller duration. This is
2027 because the Job retention period and the Volume retention period are
2028 independently applied, so the smaller of the two takes precedence.
2030 The Job retention period is specified as seconds, minutes, hours, days,
2031 weeks, months, quarters, or years. See the
2032 \ilink{ Configuration chapter}{Time} of this manual for
2033 additional details of time specification.
2035 The default is 180 days.
2038 \item [AutoPrune = \lt{}yes|no\gt{}]
2039 \index[dir]{AutoPrune}
2040 \index[dir]{Directive!AutoPrune}
2041 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2042 will automatically apply the File retention period and the Job retention
2043 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2044 pruning will not be done, and your Catalog will grow in size each time you
2045 run a Job. Pruning affects only information in the catalog and not data
2046 stored in the backup archives (on Volumes).
2048 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2049 \index[dir]{Maximum Concurrent Jobs}
2050 \index[dir]{Directive!Maximum Concurrent Jobs}
2051 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2052 that can run concurrently. Note, this directive limits only Jobs for Clients
2053 with the same name as the resource in which it appears. Any other
2054 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2055 Storage resources will also apply in addition to any limit specified here.
2056 The default is set to 1, but you may set it to a larger number. We strongly
2057 recommend that you read the WARNING documented under
2058 \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
2061 \item [Priority = \lt{}number\gt{}]
2062 \index[dir]{Priority}
2063 \index[dir]{Directive!Priority}
2064 The number specifies the priority of this client relative to other clients
2065 that the Director is processing simultaneously. The priority can range from
2066 1 to 1000. The clients are ordered such that the smaller number priorities
2067 are performed first (not currently implemented).
2070 The following is an example of a valid Client resource definition:
2076 FDAddress = minimatou
2078 Password = very_good
2083 \section{The Storage Resource}
2084 \label{StorageResource2}
2085 \index[general]{Resource!Storage}
2086 \index[general]{Storage Resource}
2088 The Storage resource defines which Storage daemons are available for use by
2094 \index[dir]{Storage}
2095 \index[dir]{Directive!Storage}
2096 Start of the Storage resources. At least one storage resource must be
2099 \item [Name = \lt{}name\gt{}]
2101 \index[dir]{Directive!Name}
2102 The name of the storage resource. This name appears on the Storage directive
2103 specified in the Job resource and is required.
2105 \item [Address = \lt{}address\gt{}]
2106 \index[dir]{Address}
2107 \index[dir]{Directive!SD Address}
2108 \index[dir]{Storage daemon Address}
2109 Where the address is a host name, a {\bf fully qualified domain name}, or an
2110 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2111 will be transmitted to the File daemon who will then use it to contact the
2112 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2113 the name but rather a fully qualified machine name or an IP address. This
2114 directive is required.
2116 \item [SD Port = \lt{}port\gt{}]
2117 \index[dir]{SD Port}
2118 \index[dir]{Directive!SD Port}
2119 Where port is the port to use to contact the storage daemon for information
2120 and to start jobs. This same port number must appear in the Storage resource
2121 of the Storage daemon's configuration file. The default is 9103.
2123 \item [Password = \lt{}password\gt{}]
2124 \index[dir]{Password}
2125 \index[dir]{Directive!Password}
2126 This is the password to be used when establishing a connection with the
2127 Storage services. This same password also must appear in the Director
2128 resource of the Storage daemon's configuration file. This directive is
2129 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2130 Bacula will generate a random password during the configuration process,
2131 otherwise it will be left blank.
2133 \item [Device = \lt{}device-name\gt{}]
2135 \index[dir]{Directive!Device}
2136 This directive specifies the Storage daemon's name of the device
2137 resource to be used for the storage. If you are using an Autochanger,
2138 the name specified here should be the name of the Storage daemon's
2139 Autochanger resource rather than the name of an individual device. This
2140 name is not the physical device name, but the logical device name as
2141 defined on the {\bf Name} directive contained in the {\bf Device} or the
2142 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2143 configuration file. You can specify any name you would like (even the
2144 device name if you prefer) up to a maximum of 127 characters in length.
2145 The physical device name associated with this device is specified in the
2146 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2147 Please take care not to define two different Storage resource directives
2148 in the Director that point to the same Device in the Storage daemon.
2149 Doing so may cause the Storage daemon to block (or hang) attempting to
2150 open the same device that is already open. This directive is required.
2153 \item [Media Type = \lt{}MediaType\gt{}]
2154 \index[dir]{Media Type}
2155 \index[dir]{Directive!Media Type}
2156 This directive specifies the Media Type to be used to store the data.
2157 This is an arbitrary string of characters up to 127 maximum that you
2158 define. It can be anything you want. However, it is best to make it
2159 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2160 ...). In addition, it is essential that you make the {\bf Media Type}
2161 specification unique for each storage media type. If you have two DDS-4
2162 drives that have incompatible formats, or if you have a DDS-4 drive and
2163 a DDS-4 autochanger, you almost certainly should specify different {\bf
2164 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2165 associated with the Job, Bacula can decide to use any Storage daemon
2166 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2168 If you are writing to disk Volumes, you must make doubly sure that each
2169 Device resource defined in the Storage daemon (and hence in the
2170 Director's conf file) has a unique media type. Otherwise for Bacula
2171 versions 1.38 and older, your restores may not work because Bacula
2172 will assume that you can mount any Media Type with the same name on
2173 any Device associated with that Media Type. This is possible with
2174 tape drives, but with disk drives, unless you are very clever you
2175 cannot mount a Volume in any directory -- this can be done by creating
2176 an appropriate soft link.
2178 Currently Bacula permits only a single Media Type per Storage
2179 and Device definition. Consequently, if
2180 you have a drive that supports more than one Media Type, you can
2181 give a unique string to Volumes with different intrinsic Media
2182 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2183 those volumes will only be mounted on drives indicated with the
2184 dual type (DDS-3-4).
2186 If you want to tie Bacula to using a single Storage daemon or drive, you
2187 must specify a unique Media Type for that drive. This is an important
2188 point that should be carefully understood. Note, this applies equally
2189 to Disk Volumes. If you define more than one disk Device resource in
2190 your Storage daemon's conf file, the Volumes on those two devices are in
2191 fact incompatible because one can not be mounted on the other device
2192 since they are found in different directories. For this reason, you
2193 probably should use two different Media Types for your two disk Devices
2194 (even though you might think of them as both being File types). You can
2195 find more on this subject in the \ilink{Basic Volume
2196 Management}{DiskChapter} chapter of this manual.
2198 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2199 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2200 resource of the {\bf Storage daemon} configuration file. This directive
2201 is required, and it is used by the Director and the Storage daemon to
2202 ensure that a Volume automatically selected from the Pool corresponds to
2203 the physical device. If a Storage daemon handles multiple devices (e.g.
2204 will write to various file Volumes on different partitions), this
2205 directive allows you to specify exactly which device.
2207 As mentioned above, the value specified in the Director's Storage
2208 resource must agree with the value specified in the Device resource in
2209 the {\bf Storage daemon's} configuration file. It is also an additional
2210 check so that you don't try to write data for a DLT onto an 8mm device.
2212 \label{Autochanger1}
2213 \item [Autochanger = \lt{}yes|no\gt{}]
2214 \index[dir]{Autochanger}
2215 \index[dir]{Directive!Autochanger}
2216 If you specify {\bf yes} for this command (the default is {\bf no}),
2217 when you use the {\bf label} command or the {\bf add} command to create
2218 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2219 number. This simplifies creating database entries for Volumes in an
2220 autochanger. If you forget to specify the Slot, the autochanger will
2221 not be used. However, you may modify the Slot associated with a Volume
2222 at any time by using the {\bf update volume} or {\bf update slots}
2223 command in the console program. When {\bf autochanger} is enabled, the
2224 algorithm used by Bacula to search for available volumes will be
2225 modified to consider only Volumes that are known to be in the
2226 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2227 will attempt recycling, pruning, ..., and if still no volume is found,
2228 Bacula will search for any volume whether or not in the magazine. By
2229 privileging in changer volumes, this procedure minimizes operator
2230 intervention. The default is {\bf no}.
2232 For the autochanger to be used, you must also specify {\bf Autochanger =
2233 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2234 configuration file as well as other important Storage daemon
2235 configuration information. Please consult the \ilink{Using
2236 Autochangers}{AutochangersChapter} manual of this chapter for the
2237 details of using autochangers.
2239 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2240 \index[dir]{Maximum Concurrent Jobs}
2241 \index[dir]{Directive!Maximum Concurrent Jobs}
2242 where \lt{}number\gt{} is the maximum number of Jobs with the current
2243 Storage resource that can run concurrently. Note, this directive limits
2244 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2245 the maximum concurrent jobs such as in the Director, Job, or Client
2246 resources will also apply in addition to any limit specified here. The
2247 default is set to 1, but you may set it to a larger number. However, if
2248 you set the Storage daemon's number of concurrent jobs greater than one,
2249 we recommend that you read the waring documented under \ilink{Maximum
2250 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2251 turn data spooling on as documented in the \ilink{Data
2252 Spooling}{SpoolingChapter} chapter of this manual.
2254 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2255 \index[dir]{Heartbeat Interval}
2256 \index[dir]{Directive!Heartbeat}
2257 This directive is optional and if specified will cause the Director to
2258 set a keepalive interval (heartbeat) in seconds on each of the sockets
2259 it opens for the Storage resource. This value will override any
2260 specified at the Director level. It is implemented only on systems
2261 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2262 The default value is zero, which means no change is made to the socket.
2266 The following is an example of a valid Storage resource definition:
2270 # Definition of tape storage device
2274 Password = storage_password # password for Storage daemon
2275 Device = "HP DLT 80" # same as Device in Storage daemon
2276 Media Type = DLT8000 # same as MediaType in Storage daemon
2281 \section{The Pool Resource}
2282 \label{PoolResource}
2283 \index[general]{Resource!Pool}
2284 \index[general]{Pool Resource}
2286 The Pool resource defines the set of storage Volumes (tapes or files) to be
2287 used by Bacula to write the data. By configuring different Pools, you can
2288 determine which set of Volumes (media) receives the backup data. This permits,
2289 for example, to store all full backup data on one set of Volumes and all
2290 incremental backups on another set of Volumes. Alternatively, you could assign
2291 a different set of Volumes to each machine that you backup. This is most
2292 easily done by defining multiple Pools.
2294 Another important aspect of a Pool is that it contains the default attributes
2295 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2296 Volume when it is created. This avoids the need for you to answer a large
2297 number of questions when labeling a new Volume. Each of these attributes can
2298 later be changed on a Volume by Volume basis using the {\bf update} command in
2299 the console program. Note that you must explicitly specify which Pool Bacula
2300 is to use with each Job. Bacula will not automatically search for the correct
2303 Most often in Bacula installations all backups for all machines (Clients) go
2304 to a single set of Volumes. In this case, you will probably only use the {\bf
2305 Default} Pool. If your backup strategy calls for you to mount a different tape
2306 each day, you will probably want to define a separate Pool for each day. For
2307 more information on this subject, please see the
2308 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2312 To use a Pool, there are three distinct steps. First the Pool must be defined
2313 in the Director's configuration file. Then the Pool must be written to the
2314 Catalog database. This is done automatically by the Director each time that it
2315 starts, or alternatively can be done using the {\bf create} command in the
2316 console program. Finally, if you change the Pool definition in the Director's
2317 configuration file and restart Bacula, the pool will be updated alternatively
2318 you can use the {\bf update pool} console command to refresh the database
2319 image. It is this database image rather than the Director's resource image
2320 that is used for the default Volume attributes. Note, for the pool to be
2321 automatically created or updated, it must be explicitly referenced by a Job
2324 Next the physical media must be labeled. The labeling can either be done with
2325 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2326 program. The preferred method is to use the {\bf label} command in the {\bf
2329 Finally, you must add Volume names (and their attributes) to the Pool. For
2330 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2331 archive device specified for the job (i.e. if you are going to back up to a
2332 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2333 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2334 are backing up to files. When running a Job, you must explicitly specify which
2335 Pool to use. Bacula will then automatically select the next Volume to use from
2336 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2337 from the Pool is identical to that required by the Storage resource you have
2338 specified for the Job.
2340 If you use the {\bf label} command in the console program to label the
2341 Volumes, they will automatically be added to the Pool, so this last step is
2342 not normally required.
2344 It is also possible to add Volumes to the database without explicitly labeling
2345 the physical volume. This is done with the {\bf add} console command.
2347 As previously mentioned, each time Bacula starts, it scans all the Pools
2348 associated with each Catalog, and if the database record does not already
2349 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2350 probably should do an {\bf update pool} if you change the Pool definition, but
2351 currently, you must do this manually using the {\bf update pool} command in
2352 the Console program.
2354 The Pool Resource defined in the Director's configuration file
2355 (bacula-dir.conf) may contain the following directives:
2361 \index[dir]{Directive!Pool}
2362 Start of the Pool resource. There must be at least one Pool resource
2366 \item [Name = \lt{}name\gt{}]
2368 \index[dir]{Directive!Name}
2369 The name of the pool. For most applications, you will use the default
2370 pool name {\bf Default}. This directive is required.
2373 \item [Maximum Volumes = \lt{}number\gt{}]
2374 \index[dir]{Maximum Volumes}
2375 \index[dir]{Directive!Maximum Volumes}
2376 This directive specifies the maximum number of volumes (tapes or files)
2377 contained in the pool. This directive is optional, if omitted or set to
2378 zero, any number of volumes will be permitted. In general, this
2379 directive is useful for Autochangers where there is a fixed number of
2380 Volumes, or for File storage where you wish to ensure that the backups
2381 made to disk files do not become too numerous or consume too much space.
2383 \item [Pool Type = \lt{}type\gt{}]
2384 \index[dir]{Pool Type}
2385 \index[dir]{Directive!Pool Type}
2386 This directive defines the pool type, which corresponds to the type of
2387 Job being run. It is required and may be one of the following:
2397 Note, only Backup is current implemented.
2399 \item [Storage = \lt{}storage-resource-name\gt{}]
2400 \index[dir]{Storage}
2401 \index[dir]{Directive!Storage}
2402 The Storage directive defines the name of the storage services where you
2403 want to backup the FileSet data. For additional details, see the
2404 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2405 The Storage resource may also be specified in the Job resource,
2406 but the value, if any, in the Pool resource overrides any value
2407 in the Job. This Storage resource definition is not required by either
2408 the Job resource or in the Pool, but it must be specified in
2409 one or the other. If not configuration error will result.
2411 \item [Use Volume Once = \lt{}yes|no\gt{}]
2412 \index[dir]{Use Volume Once}
2413 \index[dir]{Directive!Use Volume Once}
2414 This directive if set to {\bf yes} specifies that each volume is to be
2415 used only once. This is most useful when the Media is a file and you
2416 want a new file for each backup that is done. The default is {\bf no}
2417 (i.e. use volume any number of times). This directive will most likely
2418 be phased out (deprecated), so you are recommended to use {\bf Maximum
2419 Volume Jobs = 1} instead.
2421 The value defined by this directive in the bacula-dir.conf file is the
2422 default value used when a Volume is created. Once the volume is
2423 created, changing the value in the bacula-dir.conf file will not change
2424 what is stored for the Volume. To change the value for an existing
2425 Volume you must use the {\bf update} command in the Console.
2427 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2428 \index[dir]{Maximum Volume Jobs}
2429 \index[dir]{Directive!Maximum Volume Jobs}
2430 This directive specifies the maximum number of Jobs that can be written
2431 to the Volume. If you specify zero (the default), there is no limit.
2432 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2433 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2434 is marked {\bf Used} it can no longer be used for appending Jobs, much
2435 like the {\bf Full} status but it can be recycled if recycling is
2436 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2437 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2439 The value defined by this directive in the bacula-dir.conf
2440 file is the default value used when a Volume is created. Once the volume is
2441 created, changing the value in the bacula-dir.conf file will not change what
2442 is stored for the Volume. To change the value for an existing Volume you
2443 must use the {\bf update} command in the Console.
2445 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2446 \index[dir]{Maximum Volume Files}
2447 \index[dir]{Directive!Maximum Volume Files}
2448 This directive specifies the maximum number of files that can be written
2449 to the Volume. If you specify zero (the default), there is no limit.
2450 Otherwise, when the number of files written to the Volume equals {\bf
2451 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2452 is marked {\bf Used} it can no longer be used for appending Jobs, much
2453 like the {\bf Full} status but it can be recycled if recycling is
2454 enabled and thus used again. This value is checked and the {\bf Used}
2455 status is set only at the end of a job that writes to the particular
2458 The value defined by this directive in the bacula-dir.conf file is the
2459 default value used when a Volume is created. Once the volume is
2460 created, changing the value in the bacula-dir.conf file will not change
2461 what is stored for the Volume. To change the value for an existing
2462 Volume you must use the {\bf update} command in the Console.
2464 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2465 \index[dir]{Maximum Volume Bytes}
2466 \index[dir]{Directive!Maximum Volume Bytes}
2467 This directive specifies the maximum number of bytes that can be written
2468 to the Volume. If you specify zero (the default), there is no limit
2469 except the physical size of the Volume. Otherwise, when the number of
2470 bytes written to the Volume equals {\bf size} the Volume will be marked
2471 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2472 used for appending Jobs, much like the {\bf Full} status but it can be
2473 recycled if recycling is enabled, and thus the Volume can be re-used
2474 after recycling. This value is checked and the {\bf Used} status set
2475 while the job is writing to the particular volume.
2477 This directive is particularly useful for restricting the size
2478 of disk volumes, and will work correctly even in the case of
2479 multiple simultaneous jobs writing to the volume.
2481 The value defined by this directive in the bacula-dir.conf file is the
2482 default value used when a Volume is created. Once the volume is
2483 created, changing the value in the bacula-dir.conf file will not change
2484 what is stored for the Volume. To change the value for an existing
2485 Volume you must use the {\bf update} command in the Console.
2487 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2488 \index[dir]{Volume Use Duration}
2489 \index[dir]{Directive!Volume Use Duration}
2490 The Volume Use Duration directive defines the time period that the
2491 Volume can be written beginning from the time of first data write to the
2492 Volume. If the time-period specified is zero (the default), the Volume
2493 can be written indefinitely. Otherwise, the next time a job
2494 runs that wants to access this Volume, and the time period from the
2495 first write to the volume (the first Job written) exceeds the
2496 time-period-specification, the Volume will be marked {\bf Used}, which
2497 means that no more Jobs can be appended to the Volume, but it may be
2498 recycled if recycling is enabled. Using the command {\bf
2499 status dir} applies algorithms similar to running jobs, so
2500 during such a command, the Volume status may also be changed.
2502 recycled, it will be available for use again.
2504 You might use this directive, for example, if you have a Volume used for
2505 Incremental backups, and Volumes used for Weekly Full backups. Once the
2506 Full backup is done, you will want to use a different Incremental
2507 Volume. This can be accomplished by setting the Volume Use Duration for
2508 the Incremental Volume to six days. I.e. it will be used for the 6
2509 days following a Full save, then a different Incremental volume will be
2510 used. Be careful about setting the duration to short periods such as 23
2511 hours, or you might experience problems of Bacula waiting for a tape
2512 over the weekend only to complete the backups Monday morning when an
2513 operator mounts a new tape.
2515 The use duration is checked and the {\bf Used} status is set only at the
2516 end of a job that writes to the particular volume, which means that even
2517 though the use duration may have expired, the catalog entry will not be
2518 updated until the next job that uses this volume is run. This
2519 directive is not intended to be used to limit volume sizes
2520 and will not work correctly (i.e. will fail jobs) if the use
2521 duration expires while multiple simultaneous jobs are writing
2524 Please note that the value defined by this directive in the bacula-dir.conf
2525 file is the default value used when a Volume is created. Once the volume is
2526 created, changing the value in the bacula-dir.conf file will not change what
2527 is stored for the Volume. To change the value for an existing Volume you
2529 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2531 \item [Catalog Files = \lt{}yes|no\gt{}]
2532 \index[dir]{Catalog Files}
2533 \index[dir]{Directive!Catalog Files}
2534 This directive defines whether or not you want the names of the files
2535 that were saved to be put into the catalog. The default is {\bf yes}.
2536 The advantage of specifying {\bf Catalog Files = No} is that you will
2537 have a significantly smaller Catalog database. The disadvantage is that
2538 you will not be able to produce a Catalog listing of the files backed up
2539 for each Job (this is often called Browsing). Also, without the File
2540 entries in the catalog, you will not be able to use the Console {\bf
2541 restore} command nor any other command that references File entries.
2543 \label{PoolAutoPrune}
2544 \item [AutoPrune = \lt{}yes|no\gt{}]
2545 \index[dir]{AutoPrune}
2546 \index[dir]{Directive!AutoPrune}
2547 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2548 greater) will automatically apply the Volume Retention period when new
2549 Volume is needed and no appendable Volumes exist in the Pool. Volume
2550 pruning causes expired Jobs (older than the {\bf Volume Retention}
2551 period) to be deleted from the Catalog and permits possible recycling of
2554 \label{VolRetention}
2555 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2556 \index[dir]{Volume Retention}
2557 \index[dir]{Directive!Volume Retention}
2558 The Volume Retention directive defines the length of time that {\bf
2559 Bacula} will keep records associated with the Volume in
2560 the Catalog database after the End time of each Job written to the
2561 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2562 {\bf yes} Bacula may prune (remove) Job records that are older than the
2563 specified Volume Retention period if it is necessary to free up a
2564 Volume. Recycling will not occur until it is absolutely necessary to
2565 free up a volume (i.e. no other writable volume exists).
2566 All File records associated with pruned Jobs are also
2567 pruned. The time may be specified as seconds, minutes, hours, days,
2568 weeks, months, quarters, or years. The {\bf Volume Retention} is
2569 applied independently of the {\bf Job Retention} and the {\bf File
2570 Retention} periods defined in the Client resource. This means that all
2571 the retentions periods are applied in turn and that the shorter period
2572 is the one that effectively takes precedence. Note, that when the {\bf
2573 Volume Retention} period has been reached, and it is necessary to obtain
2574 a new volume, Bacula will prune both the Job and the File records. This
2575 pruning could also occur during a {\bf status dir} command because it
2576 uses similar algorithms for finding the next available Volume.
2578 It is important to know that when the Volume Retention period expires,
2579 Bacula does not automatically recycle a Volume. It attempts to keep the
2580 Volume data intact as long as possible before over writing the Volume.
2583 By defining multiple Pools with different Volume Retention periods, you
2584 may effectively have a set of tapes that is recycled weekly, another
2585 Pool of tapes that is recycled monthly and so on. However, one must
2586 keep in mind that if your {\bf Volume Retention} period is too short, it
2587 may prune the last valid Full backup, and hence until the next Full
2588 backup is done, you will not have a complete backup of your system, and
2589 in addition, the next Incremental or Differential backup will be
2590 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2591 Retention} period should be at twice the interval of your Full backups.
2592 This means that if you do a Full backup once a month, the minimum Volume
2593 retention period should be two months.
2595 The default Volume retention period is 365 days, and either the default
2596 or the value defined by this directive in the bacula-dir.conf file is
2597 the default value used when a Volume is created. Once the volume is
2598 created, changing the value in the bacula-dir.conf file will not change
2599 what is stored for the Volume. To change the value for an existing
2600 Volume you must use the {\bf update} command in the Console.
2602 \label{PoolRecyclePool}
2603 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2604 \index[dir]{RecyclePool}
2605 \index[dir]{Directive!RecyclePool}
2606 On versions 2.1.4 or greater, this directive defines to which pool
2607 the Volume will be placed (moved) when it is recycled. Without
2608 this directive, a Volume will remain in the same pool when it is
2609 recycled. With this directive, it can be moved automatically to any
2610 existing pool during a recycle. This directive is probably most
2611 useful when defined in the Scratch pool, so that volumes will
2612 be recycled back into the Scratch pool. For more on the see the
2613 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2615 Although this directive is called RecyclePool, the Volume in
2616 question is actually moved from its current pool to the one
2617 you specify on this directive when Bacula prunes the Volume and
2618 discovers that there are no records left in the catalog and hence
2619 marks it as {\bf Purged}.
2623 \item [Recycle = \lt{}yes|no\gt{}]
2624 \index[dir]{Recycle}
2625 \index[dir]{Directive!Recycle}
2626 This directive specifies whether or not Purged Volumes may be recycled.
2627 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2628 none that are appendable, it will search for and recycle (reuse) Purged
2629 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2630 deleted from the Catalog). If the Volume is recycled, all previous data
2631 written to that Volume will be overwritten. If Recycle is set to {\bf
2632 no}, the Volume will not be recycled, and hence, the data will remain
2633 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2634 is no (0 in the catalog), you may manually set the recycle flag (update
2635 command) for a Volume to be reused.
2637 Please note that the value defined by this directive in the
2638 bacula-dir.conf file is the default value used when a Volume is created.
2639 Once the volume is created, changing the value in the bacula-dir.conf
2640 file will not change what is stored for the Volume. To change the value
2641 for an existing Volume you must use the {\bf update} command in the
2644 When all Job and File records have been pruned or purged from the
2645 catalog for a particular Volume, if that Volume is marked as
2646 Append, Full, Used, or Error, it will then be marked as Purged. Only
2647 Volumes marked as Purged will be considered to be converted to the
2648 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
2651 \label{RecycleOldest}
2652 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2653 \index[dir]{Recycle Oldest Volume}
2654 \index[dir]{Directive!Recycle Oldest Volume}
2655 This directive instructs the Director to search for the oldest used
2656 Volume in the Pool when another Volume is requested by the Storage
2657 daemon and none are available. The catalog is then {\bf pruned}
2658 respecting the retention periods of all Files and Jobs written to this
2659 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2660 Volume is recycled and will be used as the next Volume to be written.
2661 This directive respects any Job, File, or Volume retention periods that
2662 you may have specified, and as such it is {\bf much} better to use this
2663 directive than the Purge Oldest Volume.
2665 This directive can be useful if you have a fixed number of Volumes in the
2666 Pool and you want to cycle through them and you have specified the correct
2669 However, if you use this directive and have only one
2670 Volume in the Pool, you will immediately recycle your Volume if you fill
2671 it and Bacula needs another one. Thus your backup will be totally invalid.
2672 Please use this directive with care. The default is {\bf no}.
2674 \label{RecycleCurrent}
2676 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2677 \index[dir]{Recycle Current Volume}
2678 \index[dir]{Directive!Recycle Current Volume}
2679 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2680 the volume respecting the Job and File retention periods. If all Jobs
2681 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2682 will be used as the next Volume to be written. This directive respects
2683 any Job, File, or Volume retention periods that you may have specified,
2684 and thus it is {\bf much} better to use it rather than the Purge Oldest
2687 This directive can be useful if you have: a fixed number of Volumes in
2688 the Pool, you want to cycle through them, and you have specified
2689 retention periods that prune Volumes before you have cycled through the
2692 However, if you use this directive and have only one Volume in the Pool,
2693 you will immediately recycle your Volume if you fill it and Bacula needs
2694 another one. Thus your backup will be totally invalid. Please use this
2695 directive with care. The default is {\bf no}.
2699 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2700 \index[dir]{Purge Oldest Volume}
2701 \index[dir]{Directive!Purge Oldest Volume}
2702 This directive instructs the Director to search for the oldest used
2703 Volume in the Pool when another Volume is requested by the Storage
2704 daemon and none are available. The catalog is then {\bf purged}
2705 irrespective of retention periods of all Files and Jobs written to this
2706 Volume. The Volume is then recycled and will be used as the next Volume
2707 to be written. This directive overrides any Job, File, or Volume
2708 retention periods that you may have specified.
2710 This directive can be useful if you have a fixed number of Volumes in
2711 the Pool and you want to cycle through them and reusing the oldest one
2712 when all Volumes are full, but you don't want to worry about setting
2713 proper retention periods. However, by using this option you risk losing
2716 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2717 periods. If you have only a single Volume defined and you turn this
2718 variable on, that Volume will always be immediately overwritten when it
2719 fills! So at a minimum, ensure that you have a decent number of Volumes
2720 in your Pool before running any jobs. If you want retention periods to
2721 apply do not use this directive. To specify a retention period, use the
2722 {\bf Volume Retention} directive (see above).
2724 We {\bf highly} recommend against using this directive, because it is
2725 sure that some day, Bacula will recycle a Volume that contains current
2726 data. The default is {\bf no}.
2728 \item [Cleaning Prefix = \lt{}string\gt{}]
2729 \index[dir]{Cleaning Prefix}
2730 \index[dir]{Directive!Cleaning Prefix}
2731 This directive defines a prefix string, which if it matches the
2732 beginning of a Volume name during labeling of a Volume, the Volume will
2733 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2734 never attempt to use this tape. This is primarily for use with
2735 autochangers that accept barcodes where the convention is that barcodes
2736 beginning with {\bf CLN} are treated as cleaning tapes.
2739 \item [Label Format = \lt{}format\gt{}]
2740 \index[dir]{Label Format}
2741 \index[dir]{Directive!Label Format}
2742 This directive specifies the format of the labels contained in this
2743 pool. The format directive is used as a sort of template to create new
2744 Volume names during automatic Volume labeling.
2746 The {\bf format} should be specified in double quotes, and consists of
2747 letters, numbers and the special characters hyphen ({\bf -}), underscore
2748 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2749 characters for a Volume name. The {\bf format} should be enclosed in
2752 In addition, the format may contain a number of variable expansion
2753 characters which will be expanded by a complex algorithm allowing you to
2754 create Volume names of many different formats. In all cases, the
2755 expansion process must resolve to the set of characters noted above that
2756 are legal Volume names. Generally, these variable expansion characters
2757 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2758 specify variable expansion characters, you should always enclose the
2759 format with double quote characters ({\bf "}). For more details on
2760 variable expansion, please see the \ilink{Variable
2761 Expansion}{VarsChapter} Chapter of this manual.
2763 If no variable expansion characters are found in the string, the Volume
2764 name will be formed from the {\bf format} string appended with the
2765 number of volumes in the pool plus one, which will be edited as four
2766 digits with leading zeros. For example, with a {\bf Label Format =
2767 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2770 With the exception of Job specific variables, you can test your {\bf
2771 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2774 In almost all cases, you should enclose the format specification (part
2775 after the equal sign) in double quotes. Please note that this directive
2776 is deprecated and is replaced in version 1.37 and greater with a Python
2777 script for creating volume names.
2781 In order for a Pool to be used during a Backup Job, the Pool must have at
2782 least one Volume associated with it. Volumes are created for a Pool using
2783 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2784 program. In addition to adding Volumes to the Pool (i.e. putting the
2785 Volume names in the Catalog database), the physical Volume must be labeled
2786 with a valid Bacula software volume label before {\bf Bacula} will accept
2787 the Volume. This will be automatically done if you use the {\bf label}
2788 command. Bacula can automatically label Volumes if instructed to do so,
2789 but this feature is not yet fully implemented.
2791 The following is an example of a valid Pool resource definition:
2803 \subsection{The Scratch Pool}
2804 \label{TheScratchPool}
2805 \index[general]{Scratch Pool}
2806 In general, you can give your Pools any name you wish, but there is one
2807 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2808 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2809 writing and it cannot find one, it will look in the Scratch pool, and if
2810 it finds an available Volume, it will move it out of the Scratch pool into
2811 the Pool currently being used by the job.
2814 \section{The Catalog Resource}
2815 \label{CatalogResource}
2816 \index[general]{Resource!Catalog}
2817 \index[general]{Catalog Resource}
2819 The Catalog Resource defines what catalog to use for the current job.
2820 Currently, Bacula can only handle a single database server (SQLite, MySQL,
2821 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
2822 may be as many Catalogs (databases) defined as you wish. For example, you
2823 may want each Client to have its own Catalog database, or you may want
2824 backup jobs to use one database and verify or restore jobs to use another
2827 Since SQLite is compiled in, it always runs on the same machine
2828 as the Director and the database must be directly accessible (mounted) from
2829 the Director. However, since both MySQL and PostgreSQL are networked
2830 databases, they may reside either on the same machine as the Director
2831 or on a different machine on the network. See below for more details.
2836 \index[dir]{Catalog}
2837 \index[dir]{Directive!Catalog}
2838 Start of the Catalog resource. At least one Catalog resource must be
2842 \item [Name = \lt{}name\gt{}]
2844 \index[dir]{Directive!Name}
2845 The name of the Catalog. No necessary relation to the database server
2846 name. This name will be specified in the Client resource directive
2847 indicating that all catalog data for that Client is maintained in this
2848 Catalog. This directive is required.
2850 \item [password = \lt{}password\gt{}]
2851 \index[dir]{password}
2852 \index[dir]{Directive!password}
2853 This specifies the password to use when logging into the database. This
2854 directive is required.
2856 \item [DB Name = \lt{}name\gt{}]
2857 \index[dir]{DB Name}
2858 \index[dir]{Directive!DB Name}
2859 This specifies the name of the database. If you use multiple catalogs
2860 (databases), you specify which one here. If you are using an external
2861 database server rather than the internal one, you must specify a name
2862 that is known to the server (i.e. you explicitly created the Bacula
2863 tables using this name. This directive is required.
2865 \item [user = \lt{}user\gt{}]
2867 \index[dir]{Directive!user}
2868 This specifies what user name to use to log into the database. This
2869 directive is required.
2871 \item [DB Socket = \lt{}socket-name\gt{}]
2872 \index[dir]{DB Socket}
2873 \index[dir]{Directive!DB Socket}
2874 This is the name of a socket to use on the local host to connect to the
2875 database. This directive is used only by MySQL and is ignored by SQLite.
2876 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
2877 will use the default socket. If the DB Socket is specified, the
2878 MySQL server must reside on the same machine as the Director.
2880 \item [DB Address = \lt{}address\gt{}]
2881 \index[dir]{DB Address}
2882 \index[dir]{Directive!DB Address}
2883 This is the host address of the database server. Normally, you would specify
2884 this instead of {\bf DB Socket} if the database server is on another machine.
2885 In that case, you will also specify {\bf DB Port}. This directive is used
2886 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
2887 This directive is optional.
2889 \item [DB Port = \lt{}port\gt{}]
2890 \index[dir]{DB Port}
2891 \index[dir]{Directive!DB Port}
2892 This defines the port to be used in conjunction with {\bf DB Address} to
2893 access the database if it is on another machine. This directive is used only
2894 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
2895 directive is optional.
2897 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
2898 %% \index[dir]{Multiple Connections}
2899 %% \index[dir]{Directive!Multiple Connections}
2900 %% By default, this directive is set to no. In that case, each job that uses
2902 %% same Catalog will use a single connection to the catalog. It will be shared,
2903 %% and Bacula will allow only one Job at a time to communicate. If you set this
2904 %% directive to yes, Bacula will permit multiple connections to the database,
2905 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
2906 %% this is no problem. For MySQL, you must be *very* careful to have the
2907 %% multi-thread version of the client library loaded on your system. When this
2908 %% directive is set yes, each Job will have a separate connection to the
2909 %% database, and the database will control the interaction between the
2911 %% Jobs. This can significantly speed up the database operations if you are
2912 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
2913 %% Bacula will automatically enable transactions. This can significantly speed
2914 %% up insertion of attributes in the database either for a single Job or
2915 %% multiple simultaneous Jobs.
2917 %% This directive has not been tested. Please test carefully before running it
2918 %% in production and report back your results.
2922 The following is an example of a valid Catalog resource definition:
2931 password = "" # no password = no security
2936 or for a Catalog on another machine:
2946 DB Address = remote.acme.com
2952 \section{The Messages Resource}
2953 \label{MessagesResource2}
2954 \index[general]{Resource!Messages}
2955 \index[general]{Messages Resource}
2957 For the details of the Messages Resource, please see the
2958 \ilink{Messages Resource Chapter}{MessagesChapter} of this
2961 \section{The Console Resource}
2962 \label{ConsoleResource1}
2963 \index[general]{Console Resource}
2964 \index[general]{Resource!Console}
2966 As of Bacula version 1.33 and higher, there are three different kinds of
2967 consoles, which the administrator or user can use to interact with the
2968 Director. These three kinds of consoles comprise three different security
2972 \item The first console type is an {\bf anonymous} or {\bf default} console,
2973 which has full privileges. There is no console resource necessary for
2974 this type since the password is specified in the Director's resource and
2975 consequently such consoles do not have a name as defined on a {\bf Name
2976 =} directive. This is the kind of console that was initially
2977 implemented in versions prior to 1.33 and remains valid. Typically you
2978 would use it only for administrators.
2980 \item The second type of console, and new to version 1.33 and higher is a
2981 "named" console defined within a Console resource in both the Director's
2982 configuration file and in the Console's configuration file. Both the
2983 names and the passwords in these two entries must match much as is the
2984 case for Client programs.
2986 This second type of console begins with absolutely no privileges except
2987 those explicitly specified in the Director's Console resource. Thus you
2988 can have multiple Consoles with different names and passwords, sort of
2989 like multiple users, each with different privileges. As a default,
2990 these consoles can do absolutely nothing -- no commands whatsoever. You
2991 give them privileges or rather access to commands and resources by
2992 specifying access control lists in the Director's Console resource. The
2993 ACLs are specified by a directive followed by a list of access names.
2994 Examples of this are shown below.
2996 \item The third type of console is similar to the above mentioned one in that
2997 it requires a Console resource definition in both the Director and the
2998 Console. In addition, if the console name, provided on the {\bf Name =}
2999 directive, is the same as a Client name, that console is permitted to
3000 use the {\bf SetIP} command to change the Address directive in the
3001 Director's client resource to the IP address of the Console. This
3002 permits portables or other machines using DHCP (non-fixed IP addresses)
3003 to "notify" the Director of their current IP address.
3006 The Console resource is optional and need not be specified. The following
3007 directives are permitted within the Director's configuration resource:
3011 \item [Name = \lt{}name\gt{}]
3013 \index[dir]{Directive!Name}
3014 The name of the console. This name must match the name specified in the
3015 Console's configuration resource (much as is the case with Client
3018 \item [Password = \lt{}password\gt{}]
3019 \index[dir]{Password}
3020 \index[dir]{Directive!Password}
3021 Specifies the password that must be supplied for a named Bacula Console
3022 to be authorized. The same password must appear in the {\bf Console}
3023 resource of the Console configuration file. For added security, the
3024 password is never actually passed across the network but rather a
3025 challenge response hash code created with the password. This directive
3026 is required. If you have either {\bf /dev/random} {\bf bc} on your
3027 machine, Bacula will generate a random password during the configuration
3028 process, otherwise it will be left blank.
3030 \item [JobACL = \lt{}name-list\gt{}]
3032 \index[dir]{Directive!JobACL}
3033 This directive is used to specify a list of Job resource names that can
3034 be accessed by the console. Without this directive, the console cannot
3035 access any of the Director's Job resources. Multiple Job resource names
3036 may be specified by separating them with commas, and/or by specifying
3037 multiple JobACL directives. For example, the directive may be specified
3042 JobACL = kernsave, "Backup client 1", "Backup client 2"
3043 JobACL = "RestoreFiles"
3048 With the above specification, the console can access the Director's resources
3049 for the four jobs named on the JobACL directives, but for no others.
3051 \item [ClientACL = \lt{}name-list\gt{}]
3052 \index[dir]{ClientACL}
3053 \index[dir]{Directive!ClientACL}
3054 This directive is used to specify a list of Client resource names that can
3056 accessed by the console.
3058 \item [StorageACL = \lt{}name-list\gt{}]
3059 \index[dir]{StorageACL}
3060 \index[dir]{Directive!StorageACL}
3061 This directive is used to specify a list of Storage resource names that can
3062 be accessed by the console.
3064 \item [ScheduleACL = \lt{}name-list\gt{}]
3065 \index[dir]{ScheduleACL}
3066 \index[dir]{Directive!ScheduleACL}
3067 This directive is used to specify a list of Schedule resource names that can
3068 be accessed by the console.
3070 \item [PoolACL = \lt{}name-list\gt{}]
3071 \index[dir]{PoolACL}
3072 \index[dir]{Directive!PoolACL}
3073 This directive is used to specify a list of Pool resource names that can be
3074 accessed by the console.
3076 \item [FileSetACL = \lt{}name-list\gt{}]
3077 \index[dir]{FileSetACL}
3078 \index[dir]{Directive!FileSetACL}
3079 This directive is used to specify a list of FileSet resource names that
3080 can be accessed by the console.
3082 \item [CatalogACL = \lt{}name-list\gt{}]
3083 \index[dir]{CatalogACL}
3084 \index[dir]{Directive!CatalogACL}
3085 This directive is used to specify a list of Catalog resource names that
3086 can be accessed by the console.
3088 \item [CommandACL = \lt{}name-list\gt{}]
3089 \index[dir]{CommandACL}
3090 \index[dir]{Directive!CommandACL}
3091 This directive is used to specify a list of of console commands that can
3092 be executed by the console.
3094 \item [WhereACL = \lt{}string\gt{}]
3095 \index[dir]{WhereACL}
3096 \index[dir]{Directive!WhereACL}
3097 This directive permits you to specify where a restricted console
3098 can restore files. If this directive is not specified, only the
3099 default restore location is permitted (normally {\bf
3100 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3101 user enters will be accepted (not very secure), any other
3102 value specified (there may be multiple WhereACL directives) will
3103 restrict the user to use that path. For example, on a Unix system,
3104 if you specify "/", the file will be restored to the original
3105 location. This directive is untested.
3109 Aside from Director resource names and console command names, the special
3110 keyword {\bf *all*} can be specified in any of the above access control lists.
3111 When this keyword is present, any resource or command name (which ever is
3112 appropriate) will be accepted. For an example configuration file, please see
3114 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3117 \section{The Counter Resource}
3118 \label{CounterResource}
3119 \index[general]{Resource!Counter}
3120 \index[general]{Counter Resource}
3122 The Counter Resource defines a counter variable that can be accessed by
3123 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3125 \ilink{LabelFormat}{Label} directive in this chapter for more
3131 \index[dir]{Counter}
3132 \index[dir]{Directive!Counter}
3133 Start of the Counter resource. Counter directives are optional.
3135 \item [Name = \lt{}name\gt{}]
3137 \index[dir]{Directive!Name}
3138 The name of the Counter. This is the name you will use in the variable
3139 expansion to reference the counter value.
3141 \item [Minimum = \lt{}integer\gt{}]
3142 \index[dir]{Minimum}
3143 \index[dir]{Directive!Minimum}
3144 This specifies the minimum value that the counter can have. It also becomes
3145 the default. If not supplied, zero is assumed.
3147 \item [Maximum = \lt{}integer\gt{}]
3148 \index[dir]{Maximum}
3149 \index[dir]{Directive!Maximum}
3150 \index[dir]{Directive!Maximum}
3151 This is the maximum value value that the counter can have. If not specified
3152 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3153 the 31 power). When the counter is incremented past this value, it is reset
3156 \item [*WrapCounter = \lt{}counter-name\gt{}]
3157 \index[dir]{*WrapCounter}
3158 \index[dir]{Directive!*WrapCounter}
3159 If this value is specified, when the counter is incremented past the
3161 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3162 is incremented. (This is not currently implemented).
3164 \item [Catalog = \lt{}catalog-name\gt{}]
3165 \index[dir]{Catalog}
3166 \index[dir]{Directive!Catalog}
3167 If this directive is specified, the counter and its values will be saved in
3168 the specified catalog. If this directive is not present, the counter will be
3169 redefined each time that Bacula is started.
3172 \section{Example Director Configuration File}
3173 \label{SampleDirectorConfiguration}
3174 \index[general]{File!Example Director Configuration}
3175 \index[general]{Example Director Configuration File}
3177 An example Director configuration file might be the following:
3182 # Default Bacula Director Configuration file
3184 # The only thing that MUST be changed is to add one or more
3185 # file or directory names in the Include directive of the
3188 # For Bacula release 1.15 (5 March 2002) -- redhat
3190 # You might also want to change the default email address
3191 # from root to your address. See the "mail" and "operator"
3192 # directives in the Messages resource.
3194 Director { # define myself
3196 QueryFile = "/home/kern/bacula/bin/query.sql"
3197 WorkingDirectory = "/home/kern/bacula/bin/working"
3198 PidDirectory = "/home/kern/bacula/bin/working"
3199 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3201 # Define the backup Job
3203 Name = "NightlySave"
3205 Level = Incremental # default
3208 Schedule = "WeeklyCycle"
3218 Where = /tmp/bacula-restores
3224 # List of files to be backed up
3228 Options { signature=SHA1}
3230 # Put your list of files here, one per line or include an
3231 # external list with:
3235 # Note: / backs up everything
3240 # When to do the backups
3242 Name = "WeeklyCycle"
3243 Run = level=Full sun at 2:05
3244 Run = level=Incremental mon-sat at 2:05
3246 # Client (File Services) to backup
3251 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3252 File Retention = 60d # sixty day file retention
3253 Job Retention = 1y # 1 year Job retention
3254 AutoPrune = yes # Auto apply retention periods
3256 # Definition of DLT tape storage device
3260 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3261 Device = "HP DLT 80" # same as Device in Storage daemon
3262 Media Type = DLT8000 # same as MediaType in Storage daemon
3264 # Definition for a DLT autochanger device
3268 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3269 Device = "Autochanger" # same as Device in Storage daemon
3270 Media Type = DLT-8000 # Different from DLTDrive
3273 # Definition of DDS tape storage device
3277 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3278 Device = SDT-10000 # same as Device in Storage daemon
3279 Media Type = DDS-4 # same as MediaType in Storage daemon
3281 # Definition of 8mm tape storage device
3285 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3286 Device = "Exabyte 8mm"
3289 # Definition of file storage device
3293 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3294 Device = FileStorage
3297 # Generic catalog service
3300 dbname = bacula; user = bacula; password = ""
3302 # Reasonable message delivery -- send most everything to
3303 # the email address and to the console
3306 mail = root@localhost = all, !skipped, !terminate
3307 operator = root@localhost = mount
3308 console = all, !skipped, !saved
3311 # Default pool definition
3319 # Restricted console used by tray-monitor to get the status of the director
3323 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3324 CommandACL = status, .status