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 The password is plain text. It is not generated through any special
129 process but as noted above, it is better to use random text for
132 \item [Messages = \lt{}Messages-resource-name\gt{}]
133 \index[dir]{Messages}
134 \index[dir]{Directive!Messages}
135 The messages resource specifies where to deliver Director messages that are
136 not associated with a specific Job. Most messages are specific to a job and
137 will be directed to the Messages resource specified by the job. However,
138 there are a few messages that can occur when no job is running. This
139 directive is required.
141 \item [Working Directory = \lt{}Directory\gt{}]
142 \index[dir]{Working Directory}
143 \index[dir]{Directive!Working Directory}
144 This directive is mandatory and specifies a directory in which the Director
145 may put its status files. This directory should be used only by Bacula but
146 may be shared by other Bacula daemons. However, please note, if this
147 directory is shared with other Bacula daemons (the File daemon and Storage
148 daemon), you must ensure that the {\bf Name} given to each daemon is
149 unique so that the temporary filenames used do not collide. By default
150 the Bacula configure process creates unique daemon names by postfixing them
151 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
152 Directory} is done when the configuration file is read so that values such
153 as {\bf \$HOME} will be properly expanded. This directive is required.
154 The working directory specified must already exist and be
155 readable and writable by the Bacula daemon referencing it.
157 If you have specified a Director user and/or a Director group on your
158 ./configure line with {\bf {-}{-}with-dir-user} and/or
159 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
160 be set to those values.
162 \item [Pid Directory = \lt{}Directory\gt{}]
163 \index[dir]{Pid Directory}
164 \index[dir]{Directive!Pid Directory}
165 This directive is mandatory and specifies a directory in which the Director
166 may put its process Id file. The process Id file is used to shutdown
167 Bacula and to prevent multiple copies of Bacula from running simultaneously.
168 Standard shell expansion of the {\bf Directory} is done when the
169 configuration file is read so that values such as {\bf \$HOME} will be
172 The PID directory specified must already exist and be
173 readable and writable by the Bacula daemon referencing it
175 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
176 not installing Bacula in the system directories, you can use the {\bf Working
177 Directory} as defined above. This directive is required.
179 \item [Scripts Directory = \lt{}Directory\gt{}]
180 \index[dir]{Scripts Directory}
181 \index[dir]{Directive!Scripts Directory}
182 This directive is optional and, if defined, specifies a directory in
183 which the Director will look for the Python startup script {\bf
184 DirStartup.py}. This directory may be shared by other Bacula daemons.
185 Standard shell expansion of the directory is done when the configuration
186 file is read so that values such as {\bf \$HOME} will be properly
189 \item [QueryFile = \lt{}Path\gt{}]
190 \index[dir]{QueryFile}
191 \index[dir]{Directive!QueryFile}
192 This directive is mandatory and specifies a directory and file in which
193 the Director can find the canned SQL statements for the {\bf Query}
194 command of the Console. Standard shell expansion of the {\bf Path} is
195 done when the configuration file is read so that values such as {\bf
196 \$HOME} will be properly expanded. This directive is required.
198 \label{DirMaxConJobs}
199 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
200 \index[dir]{Maximum Concurrent Jobs}
201 \index[dir]{Directive!Maximum Concurrent Jobs}
202 \index[general]{Simultaneous Jobs}
203 \index[general]{Concurrent Jobs}
204 where \lt{}number\gt{} is the maximum number of total Director Jobs that
205 should run concurrently. The default is set to 1, but you may set it to a
208 Please note that the Volume format becomes much more complicated with
209 multiple simultaneous jobs, consequently, restores can take much longer if
210 Bacula must sort through interleaved volume blocks from multiple simultaneous
211 jobs. This can be avoided by having each simultaneously running job write to
212 a different volume or by using data spooling, which will first spool the data
213 to disk simultaneously, then write each spool file to the volume in
216 There may also still be some cases where directives such as {\bf Maximum
217 Volume Jobs} are not properly synchronized with multiple simultaneous jobs
218 (subtle timing issues can arise), so careful testing is recommended.
220 At the current time, there is no configuration parameter set to limit the
221 number of console connections. A maximum of five simultaneous console
222 connections are permitted.
224 \item [FD Connect Timeout = \lt{}time\gt{}]
225 \index[dir]{FD Connect Timeout}
226 \index[dir]{Directive!FD Connect Timeout}
227 where {\bf time} is the time that the Director should continue
228 attempting to contact the File daemon to start a job, and after which
229 the Director will cancel the job. The default is 30 minutes.
231 \item [SD Connect Timeout = \lt{}time\gt{}]
232 \index[dir]{SD Connect Timeout}
233 \index[dir]{Directive!SD Connect Timeout}
234 where {\bf time} is the time that the Director should continue
235 attempting to contact the Storage daemon to start a job, and after which
236 the Director will cancel the job. The default is 30 minutes.
238 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
239 \index[dir]{DirAddresses}
241 \index[general]{Address}
242 \index[dir]{Directive!DirAddresses}
243 Specify the ports and addresses on which the Director daemon will listen
244 for Bacula Console connections. Probably the simplest way to explain
245 this is to show an example:
250 ip = { addr = 1.2.3.4; port = 1205;}
252 addr = 1.2.3.4; port = http;}
261 ip = { addr = 1.2.3.4 }
262 ip = { addr = 201:220:222::2 }
264 addr = bluedot.thun.net
270 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
271 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
272 a symbolic name (only in the ip specification). Also, port can be specified
273 as a number or as the mnemonic value from the /etc/services file. If a port
274 is not specified, the default will be used. If an ip section is specified,
275 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
276 only IPv4 resolutions will be permitted, and likewise with ip6.
278 Please note that if you use the DirAddresses directive, you must
279 not use either a DirPort or a DirAddress directive in the same
282 \item [DirPort = \lt{}port-number\gt{}]
284 \index[dir]{Directive!DirPort}
285 Specify the port (a positive integer) on which the Director daemon will
286 listen for Bacula Console connections. This same port number must be
287 specified in the Director resource of the Console configuration file. The
288 default is 9101, so normally this directive need not be specified. This
289 directive should not be used if you specify DirAddresses (not plural)
292 \item [DirAddress = \lt{}IP-Address\gt{}]
293 \index[dir]{DirAddress}
294 \index[dir]{Directive!DirAddress}
295 This directive is optional, but if it is specified, it will cause the
296 Director server (for the Console program) to bind to the specified {\bf
297 IP-Address}, which is either a domain name or an IP address specified as a
298 dotted quadruple in string or quoted string format. If this directive is not
299 specified, the Director will bind to any available address (the default).
300 Note, unlike the DirAddresses specification noted above, this directive only
301 permits a single address to be specified. This directive should not be used if you
302 specify a DirAddresses (note plural) directive.
308 The following is an example of a valid Director resource definition:
314 WorkingDirectory = "$HOME/bacula/bin/working"
315 Password = UA_password
316 PidDirectory = "$HOME/bacula/bin/working"
317 QueryFile = "$HOME/bacula/bin/query.sql"
323 \section{The Job Resource}
325 \index[general]{Resource!Job}
326 \index[general]{Job Resource}
328 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
329 perform. Each Job resource definition contains the name of a Client and
330 a FileSet to backup, the Schedule for the Job, where the data
331 are to be stored, and what media Pool can be used. In effect, each Job
332 resource must specify What, Where, How, and When or FileSet, Storage,
333 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
334 be specified for a restore job for historical reasons, but it is no longer used.
336 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
337 job. If you want to backup multiple FileSets on the same Client or multiple
338 Clients, you must define a Job for each one.
340 Note, you define only a single Job to do the Full, Differential, and
341 Incremental backups since the different backup levels are tied together by
342 a unique Job name. Normally, you will have only one Job per Client, but
343 if a client has a really huge number of files (more than several million),
344 you might want to split it into to Jobs each with a different FileSet
345 covering only part of the total files.
352 \index[dir]{Directive!Job}
353 Start of the Job resource. At least one Job resource is required.
355 \item [Name = \lt{}name\gt{}]
357 \index[dir]{Directive!Name}
358 The Job name. This name can be specified on the {\bf Run} command in the
359 console program to start a job. If the name contains spaces, it must be
360 specified between quotes. It is generally a good idea to give your job the
361 same name as the Client that it will backup. This permits easy
362 identification of jobs.
364 When the job actually runs, the unique Job Name will consist of the name you
365 specify here followed by the date and time the job was scheduled for
366 execution. This directive is required.
368 \item [Enabled = \lt{}yes|no\gt{}]
370 \index[dir]{Directive!Enable}
371 This directive allows you to enable or disable automatic execution
372 via the scheduler of a Job.
374 \item [Type = \lt{}job-type\gt{}]
376 \index[dir]{Directive!Type}
377 The {\bf Type} directive specifies the Job type, which may be one of the
378 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
379 directive is required. Within a particular Job Type, there are also Levels
380 as discussed in the next item.
386 Run a backup Job. Normally you will have at least one Backup job for each
387 client you want to save. Normally, unless you turn off cataloging, most all
388 the important statistics and data concerning files backed up will be placed
393 Run a restore Job. Normally, you will specify only one Restore job
394 which acts as a sort of prototype that you will modify using the console
395 program in order to perform restores. Although certain basic
396 information from a Restore job is saved in the catalog, it is very
397 minimal compared to the information stored for a Backup job -- for
398 example, no File database entries are generated since no Files are
401 {\bf Restore} jobs cannot be
402 automatically started by the scheduler as is the case for Backup, Verify
403 and Admin jobs. To restore files, you must use the {\bf restore} command
409 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
410 contents of the catalog to the file system, or to what was backed up. In
411 addition, to verifying that a tape that was written can be read, you can
412 also use {\bf verify} as a sort of tripwire intrusion detection.
416 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
417 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
418 Although an Admin job is recorded in the catalog, very little data is saved.
423 \item [Level = \lt{}job-level\gt{}]
425 \index[dir]{Directive!Level}
426 The Level directive specifies the default Job level to be run. Each
427 different Job Type (Backup, Restore, ...) has a different set of Levels
428 that can be specified. The Level is normally overridden by a different
429 value that is specified in the {\bf Schedule} resource. This directive
430 is not required, but must be specified either by a {\bf Level} directive
431 or as an override specified in the {\bf Schedule} resource.
433 For a {\bf Backup} Job, the Level may be one of the following:
439 When the Level is set to Full all files in the FileSet whether or not
440 they have changed will be backed up.
443 \index[dir]{Incremental}
444 When the Level is set to Incremental all files specified in the FileSet
445 that have changed since the last successful backup of the the same Job
446 using the same FileSet and Client, will be backed up. If the Director
447 cannot find a previous valid Full backup then the job will be upgraded
448 into a Full backup. When the Director looks for a valid backup record
449 in the catalog database, it looks for a previous Job with:
452 \item The same Job name.
453 \item The same Client name.
454 \item The same FileSet (any change to the definition of the FileSet such as
455 adding or deleting a file in the Include or Exclude sections constitutes a
457 \item The Job was a Full, Differential, or Incremental backup.
458 \item The Job terminated normally (i.e. did not fail or was not canceled).
461 If all the above conditions do not hold, the Director will upgrade the
462 Incremental to a Full save. Otherwise, the Incremental backup will be
463 performed as requested.
465 The File daemon (Client) decides which files to backup for an
466 Incremental backup by comparing start time of the prior Job (Full,
467 Differential, or Incremental) against the time each file was last
468 "modified" (st\_mtime) and the time its attributes were last
469 "changed"(st\_ctime). If the file was modified or its attributes
470 changed on or after this start time, it will then be backed up.
472 Some virus scanning software may change st\_ctime while
473 doing the scan. For example, if the virus scanning program attempts to
474 reset the access time (st\_atime), which Bacula does not use, it will
475 cause st\_ctime to change and hence Bacula will backup the file during
476 an Incremental or Differential backup. In the case of Sophos virus
477 scanning, you can prevent it from resetting the access time (st\_atime)
478 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
479 option. For other software, please see their manual.
481 When Bacula does an Incremental backup, all modified files that are
482 still on the system are backed up. However, any file that has been
483 deleted since the last Full backup remains in the Bacula catalog, which
484 means that if between a Full save and the time you do a restore, some
485 files are deleted, those deleted files will also be restored. The
486 deleted files will no longer appear in the catalog after doing another
487 Full save. However, to remove deleted files from the catalog during an
488 Incremental backup is quite a time consuming process and not currently
489 implemented in Bacula.
491 In addition, if you move a directory rather than copy it, the files in
492 it do not have their modification time (st\_mtime) or their attribute
493 change time (st\_ctime) changed. As a consequence, those files will
494 probably not be backed up by an Incremental or Differential backup which
495 depend solely on these time stamps. If you move a directory, and wish
496 it to be properly backed up, it is generally preferable to copy it, then
500 \index[dir]{Differential}
501 When the Level is set to Differential
502 all files specified in the FileSet that have changed since the last
503 successful Full backup of the same Job will be backed up.
504 If the Director cannot find a
505 valid previous Full backup for the same Job, FileSet, and Client,
506 backup, then the Differential job will be upgraded into a Full backup.
507 When the Director looks for a valid Full backup record in the catalog
508 database, it looks for a previous Job with:
511 \item The same Job name.
512 \item The same Client name.
513 \item The same FileSet (any change to the definition of the FileSet such as
514 adding or deleting a file in the Include or Exclude sections constitutes a
516 \item The Job was a FULL backup.
517 \item The Job terminated normally (i.e. did not fail or was not canceled).
520 If all the above conditions do not hold, the Director will upgrade the
521 Differential to a Full save. Otherwise, the Differential backup will be
522 performed as requested.
524 The File daemon (Client) decides which files to backup for a
525 differential backup by comparing the start time of the prior Full backup
526 Job against the time each file was last "modified" (st\_mtime) and the
527 time its attributes were last "changed" (st\_ctime). If the file was
528 modified or its attributes were changed on or after this start time, it
529 will then be backed up. The start time used is displayed after the {\bf
530 Since} on the Job report. In rare cases, using the start time of the
531 prior backup may cause some files to be backed up twice, but it ensures
532 that no change is missed. As with the Incremental option, you should
533 ensure that the clocks on your server and client are synchronized or as
534 close as possible to avoid the possibility of a file being skipped.
535 Note, on versions 1.33 or greater Bacula automatically makes the
536 necessary adjustments to the time between the server and the client so
537 that the times Bacula uses are synchronized.
539 When Bacula does a Differential backup, all modified files that are
540 still on the system are backed up. However, any file that has been
541 deleted since the last Full backup remains in the Bacula catalog, which
542 means that if between a Full save and the time you do a restore, some
543 files are deleted, those deleted files will also be restored. The
544 deleted files will no longer appear in the catalog after doing another
545 Full save. However, to remove deleted files from the catalog during a
546 Differential backup is quite a time consuming process and not currently
547 implemented in Bacula. It is, however, a planned future feature.
549 As noted above, if you move a directory rather than copy it, the
550 files in it do not have their modification time (st\_mtime) or
551 their attribute change time (st\_ctime) changed. As a
552 consequence, those files will probably not be backed up by an
553 Incremental or Differential backup which depend solely on these
554 time stamps. If you move a directory, and wish it to be
555 properly backed up, it is generally preferable to copy it, then
556 delete the original. Alternatively, you can move the directory, then
557 use the {\bf touch} program to update the timestamps.
559 Every once and a while, someone asks why we need Differential
560 backups as long as Incremental backups pickup all changed files.
561 There are possibly many answers to this question, but the one
562 that is the most important for me is that a Differential backup
564 all the Incremental and Differential backups since the last Full backup
565 into a single Differential backup. This has two effects: 1. It gives
566 some redundancy since the old backups could be used if the merged backup
567 cannot be read. 2. More importantly, it reduces the number of Volumes
568 that are needed to do a restore effectively eliminating the need to read
569 all the volumes on which the preceding Incremental and Differential
570 backups since the last Full are done.
574 For a {\bf Restore} Job, no level needs to be specified.
576 For a {\bf Verify} Job, the Level may be one of the following:
581 \index[dir]{InitCatalog}
582 does a scan of the specified {\bf FileSet} and stores the file
583 attributes in the Catalog database. Since no file data is saved, you
584 might ask why you would want to do this. It turns out to be a very
585 simple and easy way to have a {\bf Tripwire} like feature using {\bf
586 Bacula}. In other words, it allows you to save the state of a set of
587 files defined by the {\bf FileSet} and later check to see if those files
588 have been modified or deleted and if any new files have been added.
589 This can be used to detect system intrusion. Typically you would
590 specify a {\bf FileSet} that contains the set of system files that
591 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
592 run the {\bf InitCatalog} level verify one time when your system is
593 first setup, and then once again after each modification (upgrade) to
594 your system. Thereafter, when your want to check the state of your
595 system files, you use a {\bf Verify} {\bf level = Catalog}. This
596 compares the results of your {\bf InitCatalog} with the current state of
601 Compares the current state of the files against the state previously
602 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
603 items reported are determined by the {\bf verify} options specified on
604 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
605 FileSet} resource below for more details). Typically this command will
606 be run once a day (or night) to check for any changes to your system
609 Please note! If you run two Verify Catalog jobs on the same client at
610 the same time, the results will certainly be incorrect. This is because
611 Verify Catalog modifies the Catalog database while running in order to
614 \item [VolumeToCatalog]
615 \index[dir]{VolumeToCatalog}
616 This level causes Bacula to read the file attribute data written to the
617 Volume from the last Job. The file attribute data are compared to the
618 values saved in the Catalog database and any differences are reported.
619 This is similar to the {\bf Catalog} level except that instead of
620 comparing the disk file attributes to the catalog database, the
621 attribute data written to the Volume is read and compared to the catalog
622 database. Although the attribute data including the signatures (MD5 or
623 SHA1) are compared, the actual file data is not compared (it is not in
626 Please note! If you run two Verify VolumeToCatalog jobs on the same
627 client at the same time, the results will certainly be incorrect. This
628 is because the Verify VolumeToCatalog modifies the Catalog database
631 \item [DiskToCatalog]
632 \index[dir]{DiskToCatalog}
633 This level causes Bacula to read the files as they currently are on
634 disk, and to compare the current file attributes with the attributes
635 saved in the catalog from the last backup for the job specified on the
636 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
637 level described above by the fact that it doesn't compare against a
638 previous Verify job but against a previous backup. When you run this
639 level, you must supply the verify options on your Include statements.
640 Those options determine what attribute fields are compared.
642 This command can be very useful if you have disk problems because it
643 will compare the current state of your disk against the last successful
644 backup, which may be several jobs.
646 Note, the current implementation (1.32c) does not identify files that
650 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
651 \index[dir]{Verify Job}
652 \index[dir]{Directive!Verify Job}
653 If you run a verify job without this directive, the last job run will be
654 compared with the catalog, which means that you must immediately follow
655 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
656 will find the last job with that name that ran. This permits you to run
657 all your backups, then run Verify jobs on those that you wish to be
658 verified (most often a {\bf VolumeToCatalog}) so that the tape just
661 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
663 \index[dir]{Directive!JobDefs}
664 If a JobDefs-Resource-Name is specified, all the values contained in the
665 named JobDefs resource will be used as the defaults for the current Job.
666 Any value that you explicitly define in the current Job resource, will
667 override any defaults specified in the JobDefs resource. The use of
668 this directive permits writing much more compact Job resources where the
669 bulk of the directives are defined in one or more JobDefs. This is
670 particularly useful if you have many similar Jobs but with minor
671 variations such as different Clients. A simple example of the use of
672 JobDefs is provided in the default bacula-dir.conf file.
674 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
675 \index[dir]{Bootstrap}
676 \index[dir]{Directive!Bootstrap}
677 The Bootstrap directive specifies a bootstrap file that, if provided,
678 will be used during {\bf Restore} Jobs and is ignored in other Job
679 types. The {\bf bootstrap} file contains the list of tapes to be used
680 in a restore Job as well as which files are to be restored.
681 Specification of this directive is optional, and if specified, it is
682 used only for a restore job. In addition, when running a Restore job
683 from the console, this value can be changed.
685 If you use the {\bf Restore} command in the Console program, to start a
686 restore job, the {\bf bootstrap} file will be created automatically from
687 the files you select to be restored.
689 For additional details of the {\bf bootstrap} file, please see
690 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
693 \label{writebootstrap}
694 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
695 \index[dir]{Write Bootstrap}
696 \index[dir]{Directive!Write Bootstrap}
697 The {\bf writebootstrap} directive specifies a file name where Bacula
698 will write a {\bf bootstrap} file for each Backup job run. This
699 directive applies only to Backup Jobs. If the Backup job is a Full
700 save, Bacula will erase any current contents of the specified file
701 before writing the bootstrap records. If the Job is an Incremental
703 save, Bacula will append the current bootstrap record to the end of the
706 Using this feature, permits you to constantly have a bootstrap file that
707 can recover the current state of your system. Normally, the file
708 specified should be a mounted drive on another machine, so that if your
709 hard disk is lost, you will immediately have a bootstrap record
710 available. Alternatively, you should copy the bootstrap file to another
711 machine after it is updated. Note, it is a good idea to write a separate
712 bootstrap file for each Job backed up including the job that backs up
713 your catalog database.
715 If the {\bf bootstrap-file-specification} begins with a vertical bar
716 (|), Bacula will use the specification as the name of a program to which
717 it will pipe the bootstrap record. It could for example be a shell
718 script that emails you the bootstrap record.
720 On versions 1.39.22 or greater, before opening the file or executing the
721 specified command, Bacula performs
722 \ilink{character substitution}{character substitution} like in RunScript
723 directive. To automatically manage your bootstrap files, you can use
724 this in your {\bf JobDefs} resources:
727 Write Bootstrap = "%c_%n.bsr"
732 For more details on using this file, please see the chapter entitled
733 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
735 \item [Client = \lt{}client-resource-name\gt{}]
737 \index[dir]{Directive!Client}
738 The Client directive specifies the Client (File daemon) that will be used in
739 the current Job. Only a single Client may be specified in any one Job. The
740 Client runs on the machine to be backed up, and sends the requested files to
741 the Storage daemon for backup, or receives them when restoring. For
742 additional details, see the
743 \ilink{Client Resource section}{ClientResource2} of this chapter.
744 This directive is required.
746 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
749 The FileSet directive specifies the FileSet that will be used in the
750 current Job. The FileSet specifies which directories (or files) are to
751 be backed up, and what options to use (e.g. compression, ...). Only a
752 single FileSet resource may be specified in any one Job. For additional
753 details, see the \ilink{FileSet Resource section}{FileSetResource} of
754 this chapter. This directive is required.
756 \item [Messages = \lt{}messages-resource-name\gt{}]
757 \index[dir]{Messages}
758 \index[dir]{Directive!Messages}
759 The Messages directive defines what Messages resource should be used for
760 this job, and thus how and where the various messages are to be
761 delivered. For example, you can direct some messages to a log file, and
762 others can be sent by email. For additional details, see the
763 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
764 directive is required.
766 \item [Pool = \lt{}pool-resource-name\gt{}]
768 \index[dir]{Directive!Pool}
769 The Pool directive defines the pool of Volumes where your data can be
770 backed up. Many Bacula installations will use only the {\bf Default}
771 pool. However, if you want to specify a different set of Volumes for
772 different Clients or different Jobs, you will probably want to use
773 Pools. For additional details, see the \ilink{Pool Resource
774 section}{PoolResource} of this chapter. This directive is required.
776 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
777 \index[dir]{Full Backup Pool}
778 \index[dir]{Directive!Full Backup Pool}
779 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
780 It will override any Pool specification during a Full backup. This
781 directive is optional.
783 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
784 \index[dir]{Differential Backup Pool}
785 \index[dir]{Directive!Differential Backup Pool}
786 The {\it Differential Backup Pool} specifies a Pool to be used for
787 Differential backups. It will override any Pool specification during a
788 Differential backup. This directive is optional.
790 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
791 \index[dir]{Incremental Backup Pool}
792 \index[dir]{Directive!Incremental Backup Pool}
793 The {\it Incremental Backup Pool} specifies a Pool to be used for
794 Incremental backups. It will override any Pool specification during an
795 Incremental backup. This directive is optional.
797 \item [Schedule = \lt{}schedule-name\gt{}]
798 \index[dir]{Schedule}
799 \index[dir]{Directive!Schedule}
800 The Schedule directive defines what schedule is to be used for the Job.
801 The schedule in turn determines when the Job will be automatically
802 started and what Job level (i.e. Full, Incremental, ...) is to be run.
803 This directive is optional, and if left out, the Job can only be started
804 manually using the Console program. Although you may specify only a
805 single Schedule resource for any one job, the Schedule resource may
806 contain multiple {\bf Run} directives, which allow you to run the Job at
807 many different times, and each {\bf run} directive permits overriding
808 the default Job Level Pool, Storage, and Messages resources. This gives
809 considerable flexibility in what can be done with a single Job. For
810 additional details, see the \ilink{Schedule Resource
811 Chapter}{ScheduleResource} of this manual.
814 \item [Storage = \lt{}storage-resource-name\gt{}]
816 \index[dir]{Directive!Storage}
817 The Storage directive defines the name of the storage services where you
818 want to backup the FileSet data. For additional details, see the
819 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
820 The Storage resource may also be specified in the Job's Pool resource,
821 in which case the value in the Pool resource overrides any value
822 in the Job. This Storage resource definition is not required by either
823 the Job resource or in the Pool, but it must be specified in
824 one or the other, if not an error will result.
826 \item [Max Start Delay = \lt{}time\gt{}]
827 \index[dir]{Max Start Delay}
828 \index[dir]{Directive!Max Start Delay}
829 The time specifies the maximum delay between the scheduled time and the
830 actual start time for the Job. For example, a job can be scheduled to
831 run at 1:00am, but because other jobs are running, it may wait to run.
832 If the delay is set to 3600 (one hour) and the job has not begun to run
833 by 2:00am, the job will be canceled. This can be useful, for example,
834 to prevent jobs from running during day time hours. The default is 0
835 which indicates no limit.
837 \item [Max Run Time = \lt{}time\gt{}]
838 \index[dir]{Max Run Time}
839 \index[dir]{Directive!Max Run Time}
840 The time specifies the maximum allowed time that a job may run, counted
841 from when the job starts, ({\bf not} necessarily the same as when the
842 job was scheduled). This directive is implemented in version 1.33 and
845 \item [Max Wait Time = \lt{}time\gt{}]
846 \index[dir]{Max Wait Time}
847 \index[dir]{Directive!Max Wait Time}
848 The time specifies the maximum allowed time that a job may block waiting
849 for a resource (such as waiting for a tape to be mounted, or waiting for
850 the storage or file daemons to perform their duties), counted from the
851 when the job starts, ({\bf not} necessarily the same as when the job was
852 scheduled). This directive is implemented only in version 1.33 and
855 \item [Incremental Max Wait Time = \lt{}time\gt{}]
856 \index[dir]{Incremental Max Wait Time}
857 \index[dir]{Directive!Incremental Max Wait Time}
858 The time specifies the maximum allowed time that an Incremental backup
859 job may block waiting for a resource (such as waiting for a tape to be
860 mounted, or waiting for the storage or file daemons to perform their
861 duties), counted from the when the job starts, ({\bf not} necessarily
862 the same as when the job was scheduled). Please note that if there is a
863 {\bf Max Wait Time} it may also be applied to the job.
865 \item [Differential Max Wait Time = \lt{}time\gt{}]
866 \index[dir]{Differential Max Wait Time}
867 \index[dir]{Directive!Differential Max Wait Time}
868 The time specifies the maximum allowed time that a Differential backup
869 job may block waiting for a resource (such as waiting for a tape to be
870 mounted, or waiting for the storage or file daemons to perform their
871 duties), counted from the when the job starts, ({\bf not} necessarily
872 the same as when the job was scheduled). Please note that if there is a
873 {\bf Max Wait Time} it may also be applied to the job.
875 \label{PreferMountedVolumes}
876 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
877 \index[dir]{Prefer Mounted Volumes}
878 \index[dir]{Directive!Prefer Mounted Volumes}
879 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
880 yes), the Storage daemon is requested to select either an Autochanger or
881 a drive with a valid Volume already mounted in preference to a drive
882 that is not ready. This means that all jobs will attempt to append
883 to the same Volume (providing the Volume is appropriate -- right Pool,
884 ... for that job). If no drive with a suitable Volume is available, it
885 will select the first available drive. Note, any Volume that has
886 been requested to be mounted, will be considered valid as a mounted
887 volume by another job. This if multiple jobs start at the same time
888 and they all prefer mounted volumes, the first job will request the
889 mount, and the other jobs will use the same volume.
891 If the directive is set to {\bf no}, the Storage daemon will prefer
892 finding an unused drive, otherwise, each job started will append to the
893 same Volume (assuming the Pool is the same for all jobs). Setting
894 Prefer Mounted Volumes to no can be useful for those sites
895 with multiple drive autochangers that prefer to maximize backup
896 throughput at the expense of using additional drives and Volumes.
897 This means that the job will prefer to use an unused drive rather
898 than use a drive that is already in use.
900 \item [Prune Jobs = \lt{}yes|no\gt{}]
901 \index[dir]{Prune Jobs}
902 \index[dir]{Directive!Prune Jobs}
903 Normally, pruning of Jobs from the Catalog is specified on a Client by
904 Client basis in the Client resource with the {\bf AutoPrune} directive.
905 If this directive is specified (not normally) and the value is {\bf
906 yes}, it will override the value specified in the Client resource. The
910 \item [Prune Files = \lt{}yes|no\gt{}]
911 \index[dir]{Prune Files}
912 \index[dir]{Directive!Prune Files}
913 Normally, pruning of Files from the Catalog is specified on a Client by
914 Client basis in the Client resource with the {\bf AutoPrune} directive.
915 If this directive is specified (not normally) and the value is {\bf
916 yes}, it will override the value specified in the Client resource. The
919 \item [Prune Volumes = \lt{}yes|no\gt{}]
920 \index[dir]{Prune Volumes}
921 \index[dir]{Directive!Prune Volumes}
922 Normally, pruning of Volumes from the Catalog is specified on a Client
923 by Client basis in the Client resource with the {\bf AutoPrune}
924 directive. If this directive is specified (not normally) and the value
925 is {\bf yes}, it will override the value specified in the Client
926 resource. The default is {\bf no}.
928 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
929 \index[dir]{RunScript}
930 \index[dir]{Directive!Run Script}
932 This directive is implemented in version 1.39.22 and later.
933 The RunScript directive behaves like a resource in that it
934 requires opening and closing braces around a number of directives
935 that make up the body of the runscript.
937 The specified {\bf Command} (see below for details) is run as an
938 external program prior or after the current Job. This is optional.
940 You can use following options may be specified in the body
943 \begin{tabular}{|c|c|c|l}
944 Options & Value & Default & Information \\
947 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
949 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
951 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
953 Runs When & Before|After|Always & {\it Never} & When run commands\\
955 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
956 something different from 0 \\
958 Command & & & Path to your script\\
963 Any output sent by the command to standard output will be included in the
964 Bacula job report. The command string must be a valid program name or name
967 In addition, the command string is parsed then fed to the OS,
968 which means that the path will be searched to execute your specified
969 command, but there is no shell interpretation, as a consequence, if you
970 invoke complicated commands or want any shell features such as redirection
971 or piping, you must call a shell script and do it inside that script.
973 Before submitting the specified command to the operating system, Bacula
974 performs character substitution of the following characters:
976 \label{character substitution}
988 %t = Job type (Backup, ...)
994 The Job Exit Status code \%e edits the following values:
996 \index[dir]{Exit Status}
1003 \item Unknown term code
1006 Thus if you edit it on a command line, you will need to enclose
1007 it within some sort of quotes.
1010 You can use these following shortcuts:\\
1012 \begin{tabular}{|c|c|c|c|c|c}
1013 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1015 Run Before Job & & & Yes & No & Before \\
1017 Run After Job & Yes & No & & No & After \\
1019 Run After Failed Job & No & Yes & & No & After \\
1021 Client Run Before Job & & & Yes & Yes & Before \\
1023 Client Run After Job & Yes & No & & Yes & After \\
1031 Command = "/etc/init.d/apache stop"
1037 Command = "/etc/init.d/apache start"
1041 {\bf Notes about ClientRunBeforeJob}
1043 For compatibility reasons, with this shortcut, the command is executed
1044 directly when the client recieve it. And if the command is in error, other
1045 remote runscripts will be discarded. To be sure that all commands will be
1046 sent and executed, you have to use RunScript syntax.
1048 {\bf Special Windows Considerations}
1050 In addition, for a Windows client on version 1.33 and above, please take
1051 note that you must ensure a correct path to your script. The script or
1052 program can be a .com, .exe or a .bat file. If you just put the program
1053 name in then Bacula will search using the same rules that cmd.exe uses
1054 (current directory, Bacula bin directory, and PATH). It will even try the
1055 different extensions in the same order as cmd.exe.
1056 The command can be anything that cmd.exe or command.com will recognize
1057 as an executable file.
1059 However, if you have slashes in the program name then Bacula figures you
1060 are fully specifying the name, so you must also explicitly add the three
1061 character extension.
1063 The command is run in a Win32 environment, so Unix like commands will not
1064 work unless you have installed and properly configured Cygwin in addition
1065 to and separately from Bacula.
1067 The System \%Path\% will be searched for the command. (under the
1068 environment variable dialog you have have both System Environment and
1069 User Environment, we believe that only the System environment will be
1070 available to bacula-fd, if it is running as a service.)
1072 System environment variables can be referenced with \%var\% and
1073 used as either part of the command name or arguments.
1075 So if you have a script in the Bacula\\bin directory then the following lines
1080 Client Run Before Job = systemstate
1082 Client Run Before Job = systemstate.bat
1084 Client Run Before Job = "systemstate"
1086 Client Run Before Job = "systemstate.bat"
1088 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1092 The outer set of quotes is removed when the configuration file is parsed.
1093 You need to escape the inner quotes so that they are there when the code
1094 that parses the command line for execution runs so it can tell what the
1100 ClientRunBeforeJob = "\"C:/Program Files/Software
1101 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1105 The special characters
1109 will need to be quoted,
1110 if they are part of a filename or argument.
1112 If someone is logged in, a blank "command" window running the commands
1113 will be present during the execution of the command.
1115 Some Suggestions from Phil Stracchino for running on Win32 machines with
1116 the native Win32 File daemon:
1119 \item You might want the ClientRunBeforeJob directive to specify a .bat
1120 file which runs the actual client-side commands, rather than trying
1121 to run (for example) regedit /e directly.
1122 \item The batch file should explicitly 'exit 0' on successful completion.
1123 \item The path to the batch file should be specified in Unix form:
1125 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1127 rather than DOS/Windows form:
1129 ClientRunBeforeJob =
1131 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1135 For Win32, please note that there are certain limitations:
1137 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1139 Lines like the above do not work because there are limitations of
1140 cmd.exe that is used to execute the command.
1141 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1142 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1143 cmd prompt and see what happens. Once the command is correct insert a
1144 backslash (\textbackslash{}) before each double quote ("), and
1145 then put quotes around the whole thing when putting it in
1146 the director's .conf file. You either need to have only one set of quotes
1147 or else use the short name and don't put quotes around the command path.
1149 Below is the output from cmd's help as it relates to the command line
1150 passed to the /c option.
1153 If /C or /K is specified, then the remainder of the command line after
1154 the switch is processed as a command line, where the following logic is
1155 used to process quote (") characters:
1159 If all of the following conditions are met, then quote characters
1160 on the command line are preserved:
1163 \item exactly two quote characters.
1164 \item no special characters between the two quote characters,
1165 where special is one of:
1169 \item there are one or more whitespace characters between the
1170 the two quote characters.
1171 \item the string between the two quote characters is the name
1172 of an executable file.
1175 \item Otherwise, old behavior is to see if the first character is
1176 a quote character and if so, strip the leading character and
1177 remove the last quote character on the command line, preserving
1178 any text after the last quote character.
1183 The following example of the use of the Client Run Before Job directive was
1184 submitted by a user:\\
1185 You could write a shell script to back up a DB2 database to a FIFO. The shell
1195 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1200 The following line in the Job resource in the bacula-dir.conf file:
1203 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1208 When the job is run, you will get messages from the output of the script
1209 stating that the backup has started. Even though the command being run is
1210 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1211 command, thus the backup stalls.
1213 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1218 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1223 It is important to redirect the input and outputs of a backgrounded command to
1224 /dev/null to prevent the script from blocking.
1226 \item [Run Before Job = \lt{}command\gt{}]
1227 \index[dir]{Run Before Job}
1228 \index[dir]{Directive!Run Before Job}
1229 \index[dir]{Directive!Run Before Job}
1230 The specified {\bf command} is run as an external program prior to running the
1231 current Job. This directive is not required, but if it is defined, and if the
1232 exit code of the program run is non-zero, the current Bacula job will be
1236 Run Before Job = "echo test"
1238 it's equivalent to :
1241 Command = "echo test"
1247 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1248 simple way to modify your schedules during a holiday. For example, suppose
1249 that you normally do Full backups on Fridays, but Thursday and Friday are
1250 holidays. To avoid having to change tapes between Thursday and Friday when
1251 no one is in the office, you can create a RunBeforeJob that returns a
1252 non-zero status on Thursday and zero on all other days. That way, the
1253 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1254 before leaving will be used.
1256 \item [Run After Job = \lt{}command\gt{}]
1257 \index[dir]{Run After Job}
1258 \index[dir]{Directive!Run After Job}
1259 The specified {\bf command} is run as an external program if the current
1260 job terminates normally (without error or without being canceled). This
1261 directive is not required. If the exit code of the program run is
1262 non-zero, Bacula will print a warning message. Before submitting the
1263 specified command to the operating system, Bacula performs character
1264 substitution as described above for the {\bf RunScript} directive.
1266 An example of the use of this directive is given in the
1267 \ilink{Tips Chapter}{JobNotification} of this manual.
1269 See the {\bf Run After Failed Job} if you
1270 want to run a script after the job has terminated with any
1273 \item [Run After Failed Job = \lt{}command\gt{}]
1274 \index[dir]{Run After Job}
1275 \index[dir]{Directive!Run After Job}
1276 The specified {\bf command} is run as an external program after the current
1277 job terminates with any error status. This directive is not required. The
1278 command string must be a valid program name or name of a shell script. If
1279 the exit code of the program run is non-zero, Bacula will print a
1280 warning message. Before submitting the specified command to the
1281 operating system, Bacula performs character substitution as described above
1282 for the {\bf RunScript} directive. Note, if you wish that your script
1283 will run regardless of the exit status of the Job, you can use this :
1286 Command = "echo test"
1290 RunsOnSuccess = yes # default, you can drop this line
1294 An example of the use of this directive is given in the
1295 \ilink{Tips Chapter}{JobNotification} of this manual.
1298 \item [Client Run Before Job = \lt{}command\gt{}]
1299 \index[dir]{Client Run Before Job}
1300 \index[dir]{Directive!Client Run Before Job}
1301 This directive is the same as {\bf Run Before Job} except that the
1302 program is run on the client machine. The same restrictions apply to
1303 Unix systems as noted above for the {\bf RunScript}.
1305 \item [Client Run After Job = \lt{}command\gt{}]
1306 \index[dir]{Client Run After Job}
1307 \index[dir]{Directive!Client Run After Job}
1308 The specified {\bf command} is run on the client machine as soon
1309 as data spooling is complete in order to allow restarting applications
1310 on the client as soon as possible. .
1312 Note, please see the notes above in {\bf RunScript}
1313 concerning Windows clients.
1315 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
1316 \index[dir]{Rerun Failed Levels}
1317 \index[dir]{Directive!Rerun Failed Levels}
1318 If this directive is set to {\bf yes} (default no), and Bacula detects that
1319 a previous job at a higher level (i.e. Full or Differential) has failed,
1320 the current job level will be upgraded to the higher level. This is
1321 particularly useful for Laptops where they may often be unreachable, and if
1322 a prior Full save has failed, you wish the very next backup to be a Full
1323 save rather than whatever level it is started as.
1325 There are several points that must be taken into account when using this
1326 directive: first, a failed job is defined as one that has not terminated
1327 normally, which includes any running job of the same name (you need to
1328 ensure that two jobs of the same name do not run simultaneously);
1329 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1330 when checking for failed levels, which means that any FileSet change will
1333 \item [Spool Data = \lt{}yes|no\gt{}]
1334 \index[dir]{Spool Data}
1335 \index[dir]{Directive!Spool Data}
1337 If this directive is set to {\bf yes} (default no), the Storage daemon will
1338 be requested to spool the data for this Job to disk rather than write it
1339 directly to tape. Once all the data arrives or the spool files' maximum sizes
1340 are reached, the data will be despooled and written to tape. Spooling data
1341 prevents tape shoe-shine (start and stop) during
1342 Incremental saves. If you are writing to a disk file using this option
1343 will probably just slow down the backup jobs.
1345 NOTE: When this directive is set to yes, Spool Attributes is also
1346 automatically set to yes.
1348 \item [Spool Attributes = \lt{}yes|no\gt{}]
1349 \index[dir]{Spool Attributes}
1350 \index[dir]{Directive!Spool Attributes}
1352 \index[general]{slow}
1353 \index[dir]{Backups!slow}
1354 \index[general]{Backups!slow}
1355 The default is set to {\bf no}, which means that the File attributes are
1356 sent by the Storage daemon to the Director as they are stored on tape.
1357 However, if you want to avoid the possibility that database updates will
1358 slow down writing to the tape, you may want to set the value to {\bf
1359 yes}, in which case the Storage daemon will buffer the File attributes
1360 and Storage coordinates to a temporary file in the Working Directory,
1361 then when writing the Job data to the tape is completed, the attributes
1362 and storage coordinates will be sent to the Director.
1364 NOTE: When Spool Data is set to yes, Spool Attributes is also
1365 automatically set to yes.
1367 \item [Where = \lt{}directory\gt{}]
1369 \index[dir]{Directive!Where}
1370 This directive applies only to a Restore job and specifies a prefix to
1371 the directory name of all files being restored. This permits files to
1372 be restored in a different location from which they were saved. If {\bf
1373 Where} is not specified or is set to backslash ({\bf /}), the files will
1374 be restored to their original location. By default, we have set {\bf
1375 Where} in the example configuration files to be {\bf
1376 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1379 \item [Add Prefix = \lt{}directory\gt{}]
1380 \label{confaddprefix}
1381 \index[dir]{AddPrefix}
1382 \index[dir]{Directive!AddPrefix}
1383 This directive applies only to a Restore job and specifies a prefix to the
1384 directory name of all files being restored. This will use \ilink{File
1385 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1387 \item [Add Suffix = \lt{}extention\gt{}]
1388 \index[dir]{AddSuffix}
1389 \index[dir]{Directive!AddSuffix}
1390 This directive applies only to a Restore job and specifies a suffix to all
1391 files being restored. This will use \ilink{File Relocation}{filerelocation}
1392 feature implemented in Bacula 2.1.8 or later.
1394 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1395 \texttt{/etc/passwsd.old}
1397 \item [Strip Prefix = \lt{}directory\gt{}]
1398 \index[dir]{StripPrefix}
1399 \index[dir]{Directive!StripPrefix}
1400 This directive applies only to a Restore job and specifies a prefix to remove
1401 from the directory name of all files being restored. This will use the
1402 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1405 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1408 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1416 \item [RegexWhere = \lt{}expressions\gt{}]
1417 \index[dir]{RegexWhere}
1418 \index[dir]{Directive!RegexWhere}
1419 This directive applies only to a Restore job and specifies a regex filename
1420 manipulation of all files being restored. This will use \ilink{File
1421 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1423 For more informations about how use this option, see
1424 \ilink{this}{useregexwhere}.
1426 \item [Replace = \lt{}replace-option\gt{}]
1427 \index[dir]{Replace}
1428 \index[dir]{Directive!Replace}
1429 This directive applies only to a Restore job and specifies what happens
1430 when Bacula wants to restore a file or directory that already exists.
1431 You have the following options for {\bf replace-option}:
1437 when the file to be restored already exists, it is deleted and then
1438 replaced by the copy that was backed up.
1441 \index[dir]{ifnewer}
1442 if the backed up file (on tape) is newer than the existing file, the
1443 existing file is deleted and replaced by the back up.
1446 \index[dir]{ifolder}
1447 if the backed up file (on tape) is older than the existing file, the
1448 existing file is deleted and replaced by the back up.
1452 if the backed up file already exists, Bacula skips restoring this file.
1455 \item [Prefix Links=\lt{}yes|no\gt{}]
1456 \index[dir]{Prefix Links}
1457 \index[dir]{Directive!Prefix Links}
1458 If a {\bf Where} path prefix is specified for a recovery job, apply it
1459 to absolute links as well. The default is {\bf No}. When set to {\bf
1460 Yes} then while restoring files to an alternate directory, any absolute
1461 soft links will also be modified to point to the new alternate
1462 directory. Normally this is what is desired -- i.e. everything is self
1463 consistent. However, if you wish to later move the files to their
1464 original locations, all files linked with absolute names will be broken.
1466 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1467 \index[dir]{Maximum Concurrent Jobs}
1468 \index[dir]{Directive!Maximum Concurrent Jobs}
1469 where \lt{}number\gt{} is the maximum number of Jobs from the current
1470 Job resource that can run concurrently. Note, this directive limits
1471 only Jobs with the same name as the resource in which it appears. Any
1472 other restrictions on the maximum concurrent jobs such as in the
1473 Director, Client, or Storage resources will also apply in addition to
1474 the limit specified here. The default is set to 1, but you may set it
1475 to a larger number. We strongly recommend that you read the WARNING
1476 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1477 Director's resource.
1479 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1480 \index[dir]{Reschedule On Error}
1481 \index[dir]{Directive!Reschedule On Error}
1482 If this directive is enabled, and the job terminates in error, the job
1483 will be rescheduled as determined by the {\bf Reschedule Interval} and
1484 {\bf Reschedule Times} directives. If you cancel the job, it will not
1485 be rescheduled. The default is {\bf no} (i.e. the job will not be
1488 This specification can be useful for portables, laptops, or other
1489 machines that are not always connected to the network or switched on.
1491 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1492 \index[dir]{Reschedule Interval}
1493 \index[dir]{Directive!Reschedule Interval}
1494 If you have specified {\bf Reschedule On Error = yes} and the job
1495 terminates in error, it will be rescheduled after the interval of time
1496 specified by {\bf time-specification}. See \ilink{the time
1497 specification formats}{Time} in the Configure chapter for details of
1498 time specifications. If no interval is specified, the job will not be
1499 rescheduled on error.
1501 \item [Reschedule Times = \lt{}count\gt{}]
1502 \index[dir]{Reschedule Times}
1503 \index[dir]{Directive!Reschedule Times}
1504 This directive specifies the maximum number of times to reschedule the
1505 job. If it is set to zero (the default) the job will be rescheduled an
1506 indefinite number of times.
1508 \item [Run = \lt{}job-name\gt{}]
1510 \index[dir]{Directive!Run}
1511 \index[dir]{Clone a Job}
1512 The Run directive (not to be confused with the Run option in a
1513 Schedule) allows you to start other jobs or to clone jobs. By using the
1514 cloning keywords (see below), you can backup
1515 the same data (or almost the same data) to two or more drives
1516 at the same time. The {\bf job-name} is normally the same name
1517 as the current Job resource (thus creating a clone). However, it
1518 may be any Job name, so one job may start other related jobs.
1520 The part after the equal sign must be enclosed in double quotes,
1521 and can contain any string or set of options (overrides) that you
1522 can specify when entering the Run command from the console. For
1523 example {\bf storage=DDS-4 ...}. In addition, there are two special
1524 keywords that permit you to clone the current job. They are {\bf level=\%l}
1525 and {\bf since=\%s}. The \%l in the level keyword permits
1526 entering the actual level of the current job and the \%s in the since
1527 keyword permits putting the same time for comparison as used on the
1528 current job. Note, in the case of the since keyword, the \%s must be
1529 enclosed in double quotes, and thus they must be preceded by a backslash
1530 since they are already inside quotes. For example:
1533 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1536 A cloned job will not start additional clones, so it is not
1537 possible to recurse.
1539 Please note that all cloned jobs, as specified in the Run directives are
1540 submitted for running before the original job is run (while it is being
1541 initialized). This means that any clone job will actually start before
1542 the original job, and may even block the original job from starting
1543 until the original job finishes unless you allow multiple simultaneous
1544 jobs. Even if you set a lower priority on the clone job, if no other
1545 jobs are running, it will start before the original job.
1547 If you are trying to prioritize jobs by using the clone feature (Run
1548 directive), you will find it much easier to do using a RunScript
1549 resource, or a RunBeforeJob directive.
1552 \item [Priority = \lt{}number\gt{}]
1553 \index[dir]{Priority}
1554 \index[dir]{Directive!Priority}
1555 This directive permits you to control the order in which your jobs will
1556 be run by specifying a positive non-zero number. The higher the number,
1557 the lower the job priority. Assuming you are not running concurrent jobs,
1558 all queued jobs of priority 1 will run before queued jobs of priority 2
1559 and so on, regardless of the original scheduling order.
1561 The priority only affects waiting jobs that are queued to run, not jobs
1562 that are already running. If one or more jobs of priority 2 are already
1563 running, and a new job is scheduled with priority 1, the currently
1564 running priority 2 jobs must complete before the priority 1 job is run.
1566 The default priority is 10.
1568 If you want to run concurrent jobs you should
1569 keep these points in mind:
1572 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1575 \item Bacula concurrently runs jobs of only one priority at a time. It
1576 will not simultaneously run a priority 1 and a priority 2 job.
1578 \item If Bacula is running a priority 2 job and a new priority 1 job is
1579 scheduled, it will wait until the running priority 2 job terminates even
1580 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1581 to run simultaneously.
1583 \item Suppose that bacula is running a priority 2 job and a new priority 1
1584 job is scheduled and queued waiting for the running priority 2 job to
1585 terminate. If you then start a second priority 2 job, the waiting
1586 priority 1 job will prevent the new priority 2 job from running
1587 concurrently with the running priority 2 job. That is: as long as there
1588 is a higher priority job waiting to run, no new lower priority jobs will
1589 start even if the Maximum Concurrent Jobs settings would normally allow
1590 them to run. This ensures that higher priority jobs will be run as soon
1594 If you have several jobs of different priority, it may not best to start
1595 them at exactly the same time, because Bacula must examine them one at a
1596 time. If by Bacula starts a lower priority job first, then it will run
1597 before your high priority jobs. If you experience this problem, you may
1598 avoid it by starting any higher priority jobs a few seconds before lower
1599 priority ones. This insures that Bacula will examine the jobs in the
1600 correct order, and that your priority scheme will be respected.
1602 \label{WritePartAfterJob}
1603 \item [Write Part After Job = \lt{}yes|no\gt{}]
1604 \index[dir]{Write Part After Job}
1605 \index[dir]{Directive!Write Part After Job}
1606 This directive is only implemented in version 1.37 and later.
1607 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1608 will be created after the job is finished.
1610 It should be set to {\bf yes} when writing to devices that require mount
1611 (for example DVD), so you are sure that the current part, containing
1612 this job's data, is written to the device, and that no data is left in
1613 the temporary file on the hard disk. However, on some media, like DVD+R
1614 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1615 written. So, if you run several jobs each after another, you could set
1616 this directive to {\bf no} for all jobs, except the last one, to avoid
1617 wasting too much space, but to ensure that the data is written to the
1618 medium when all jobs are finished.
1620 This directive is ignored with tape and FIFO devices.
1622 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
1623 \index[dir]{Heartbeat Interval}
1624 \index[dir]{Directive!Heartbeat}
1625 This directive is optional and if specified will cause the Director to
1626 set a keepalive interval (heartbeat) in seconds on each of the sockets
1627 it opens for the Client resource. This value will override any
1628 specified at the Director level. It is implemented only on systems
1629 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
1630 The default value is zero, which means no change is made to the socket.
1634 The following is an example of a valid Job resource definition:
1641 Level = Incremental # default
1643 FileSet="Minou Full Set"
1646 Schedule = "MinouWeeklyCycle"
1652 \section{The JobDefs Resource}
1653 \label{JobDefsResource}
1654 \index[general]{JobDefs Resource}
1655 \index[general]{Resource!JobDefs}
1657 The JobDefs resource permits all the same directives that can appear in a Job
1658 resource. However, a JobDefs resource does not create a Job, rather it can be
1659 referenced within a Job to provide defaults for that Job. This permits you to
1660 concisely define several nearly identical Jobs, each one referencing a JobDefs
1661 resource which contains the defaults. Only the changes from the defaults need to
1662 be mentioned in each Job.
1664 \section{The Schedule Resource}
1665 \label{ScheduleResource}
1666 \index[general]{Resource!Schedule}
1667 \index[general]{Schedule Resource}
1669 The Schedule resource provides a means of automatically scheduling a Job as
1670 well as the ability to override the default Level, Pool, Storage and Messages
1671 resources. If a Schedule resource is not referenced in a Job, the Job can only
1672 be run manually. In general, you specify an action to be taken and when.
1677 \index[dir]{Schedule}
1678 \index[dir]{Directive!Schedule}
1679 Start of the Schedule directives. No {\bf Schedule} resource is
1680 required, but you will need at least one if you want Jobs to be
1681 automatically started.
1683 \item [Name = \lt{}name\gt{}]
1685 \index[dir]{Directive!Name}
1686 The name of the schedule being defined. The Name directive is required.
1688 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1690 \index[dir]{Directive!Run}
1691 The Run directive defines when a Job is to be run, and what overrides if
1692 any to apply. You may specify multiple {\bf run} directives within a
1693 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1694 multiple schedules). If you have two {\bf Run} directives that start at
1695 the same time, two Jobs will start at the same time (well, within one
1696 second of each other).
1698 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1699 Messages, and the Pool specifications provided in the Job resource. In
1700 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1701 specifications permit overriding the Pool specification according to
1702 what backup Job Level is in effect.
1704 By the use of overrides, you may customize a particular Job. For
1705 example, you may specify a Messages override for your Incremental
1706 backups that outputs messages to a log file, but for your weekly or
1707 monthly Full backups, you may send the output by email by using a
1708 different Messages override.
1710 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1711 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1712 or IncrementalPool, and the {\bf value} is as defined on the respective
1713 directive formats for the Job resource. You may specify multiple {\bf
1714 Job-overrides} on one {\bf Run} directive by separating them with one or
1715 more spaces or by separating them with a trailing comma. For example:
1721 \index[dir]{Directive!Level}
1722 is all files in the FileSet whether or not they have changed.
1724 \item [Level=Incremental]
1726 \index[dir]{Directive!Level}
1727 is all files that have changed since the last backup.
1731 \index[dir]{Directive!Pool}
1732 specifies to use the Pool named {\bf Weekly}.
1734 \item [Storage=DLT\_Drive]
1735 \index[dir]{Storage}
1736 \index[dir]{Directive!Storage}
1737 specifies to use {\bf DLT\_Drive} for the storage device.
1739 \item [Messages=Verbose]
1740 \index[dir]{Messages}
1741 \index[dir]{Directive!Messages}
1742 specifies to use the {\bf Verbose} message resource for the Job.
1744 \item [FullPool=Full]
1745 \index[dir]{FullPool}
1746 \index[dir]{Directive!FullPool}
1747 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1749 upgraded from another type to a full backup.
1751 \item [DifferentialPool=Differential]
1752 \index[dir]{DifferentialPool}
1753 \index[dir]{Directive!DifferentialPool}
1754 specifies to use the Pool named {\bf Differential} if the job is a
1755 differential backup.
1757 \item [IncrementalPool=Incremental]
1758 \index[dir]{IncrementalPool}
1759 \index[dir]{Directive!IncrementalPool}
1760 specifies to use the Pool named {\bf Incremental} if the job is an
1763 \item [SpoolData=yes|no]
1764 \index[dir]{SpoolData}
1765 \index[dir]{Directive!SpoolData}
1766 tells Bacula to request the Storage daemon to spool data to a disk file
1767 before writing it to the Volume (normally a tape). Thus the data is
1768 written in large blocks to the Volume rather than small blocks. This
1769 directive is particularly useful when running multiple simultaneous
1770 backups to tape. It prevents interleaving of the job data and reduces
1771 or eliminates tape drive stop and start commonly known as "shoe-shine".
1773 \item [SpoolSize={\it bytes}]
1774 \index[dir]{SpoolSize}
1775 \index[dir]{Directive!SpoolSize}
1776 where the bytes specify the maximum spool size for this job.
1777 The default is take from Device Maximum Spool Size limit.
1778 This directive is available only in Bacula version 2.3.5 or
1781 \item [WritePartAfterJob=yes|no]
1782 \index[dir]{WritePartAfterJob}
1783 \index[dir]{Directive!WritePartAfterJob}
1784 tells Bacula to request the Storage daemon to write the current part
1785 file to the device when the job is finished (see \ilink{Write Part After
1786 Job directive in the Job resource}{WritePartAfterJob}). Please note,
1787 this directive is implemented only in version 1.37 and later. The
1788 default is yes. We strongly recommend that you keep this set to yes
1789 otherwise, when the last job has finished one part will remain in the
1790 spool file and restore may or may not work.
1794 {\bf Date-time-specification} determines when the Job is to be run. The
1795 specification is a repetition, and as a default Bacula is set to run a job at
1796 the beginning of the hour of every hour of every day of every week of every
1797 month of every year. This is not normally what you want, so you must specify
1798 or limit when you want the job to run. Any specification given is assumed to
1799 be repetitive in nature and will serve to override or limit the default
1800 repetition. This is done by specifying masks or times for the hour, day of the
1801 month, day of the week, week of the month, week of the year, and month when
1802 you want the job to run. By specifying one or more of the above, you can
1803 define a schedule to repeat at almost any frequency you want.
1805 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1806 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1807 is special in that you may either specify a day of the month such as 1, 2,
1808 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1809 Sunday. Finally, you may also specify a week qualifier to restrict the
1810 schedule to the first, second, third, fourth, or fifth week of the month.
1812 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1813 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1814 month} and {\bf hour} remain set to the defaults of every month and all
1817 Note, by default with no other specification, your job will run at the
1818 beginning of every hour. If you wish your job to run more than once in any
1819 given hour, you will need to specify multiple {\bf run} specifications each
1820 with a different minute.
1822 The date/time to run the Job can be specified in the following way in
1829 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1830 second | third | fourth | fifth
1831 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1832 sunday | monday | tuesday | wednesday |
1833 thursday | friday | saturday
1834 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1835 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1836 aug | sep | oct | nov | dec | january |
1837 february | ... | december
1838 <daily-keyword> = daily
1839 <weekly-keyword> = weekly
1840 <monthly-keyword> = monthly
1841 <hourly-keyword> = hourly
1842 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1843 <number> = <digit> | <digit><number>
1844 <12hour> = 0 | 1 | 2 | ... 12
1845 <hour> = 0 | 1 | 2 | ... 23
1846 <minute> = 0 | 1 | 2 | ... 59
1847 <day> = 1 | 2 | ... 31
1848 <time> = <hour>:<minute> |
1849 <12hour>:<minute>am |
1851 <time-spec> = <at-keyword> <time> |
1853 <date-keyword> = <void-keyword> <weekly-keyword>
1854 <day-range> = <day>-<day>
1855 <month-range> = <month-keyword>-<month-keyword>
1856 <wday-range> = <wday-keyword>-<wday-keyword>
1857 <range> = <day-range> | <month-range> |
1859 <date> = <date-keyword> | <day> | <range>
1860 <date-spec> = <date> | <date-spec>
1861 <day-spec> = <day> | <wday-keyword> |
1862 <day-range> | <wday-range> |
1864 <day-spec> = <day> | <wday-keyword> |
1865 <day> | <wday-range> |
1866 <week-keyword> <wday-keyword> |
1867 <week-keyword> <wday-range>
1868 <month-spec> = <month-keyword> | <month-range> |
1870 <date-time-spec> = <month-spec> <day-spec> <time-spec>
1876 Note, the Week of Year specification wnn follows the ISO standard definition
1877 of the week of the year, where Week 1 is the week in which the first Thursday
1878 of the year occurs, or alternatively, the week which contains the 4th of
1879 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
1880 precedes the first ISO week (i.e. has the first few days of the year if any
1881 occur before Thursday). w00 is not defined by the ISO specification. A week
1882 starts with Monday and ends with Sunday.
1884 According to the NIST (US National Institute of Standards and Technology),
1885 12am and 12pm are ambiguous and can be defined to anything. However,
1886 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
1887 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
1888 this abiguity (confusion) by using 24 hour time specifications (i.e. no
1889 am/pm). This is the definition in Bacula version 2.0.3 and later.
1891 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
1892 with level full each Sunday at 2:05am and an incremental job Monday through
1893 Saturday at 2:05am is:
1898 Name = "WeeklyCycle"
1899 Run = Level=Full sun at 2:05
1900 Run = Level=Incremental mon-sat at 2:05
1905 An example of a possible monthly cycle is as follows:
1910 Name = "MonthlyCycle"
1911 Run = Level=Full Pool=Monthly 1st sun at 2:05
1912 Run = Level=Differential 2nd-5th sun at 2:05
1913 Run = Level=Incremental Pool=Daily mon-sat at 2:05
1918 The first of every month:
1924 Run = Level=Full on 1 at 2:05
1925 Run = Level=Incremental on 2-31 at 2:05
1936 Run = Level=Full hourly at 0:05
1937 Run = Level=Full hourly at 0:15
1938 Run = Level=Full hourly at 0:25
1939 Run = Level=Full hourly at 0:35
1940 Run = Level=Full hourly at 0:45
1941 Run = Level=Full hourly at 0:55
1946 \section{Technical Notes on Schedules}
1947 \index[general]{Schedules!Technical Notes on}
1948 \index[general]{Technical Notes on Schedules}
1950 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
1951 minute field to each schedule. The masks are hour, day of the month (mday),
1952 month, day of the week (wday), week of the month (wom), and week of the year
1953 (woy). The schedule is initialized to have the bits of each of these masks
1954 set, which means that at the beginning of every hour, the job will run. When
1955 you specify a month for the first time, the mask will be cleared and the bit
1956 corresponding to your selected month will be selected. If you specify a second
1957 month, the bit corresponding to it will also be added to the mask. Thus when
1958 Bacula checks the masks to see if the bits are set corresponding to the
1959 current time, your job will run only in the two months you have set. Likewise,
1960 if you set a time (hour), the hour mask will be cleared, and the hour you
1961 specify will be set in the bit mask and the minutes will be stored in the
1964 For any schedule you have defined, you can see how these bits are set by doing
1965 a {\bf show schedules} command in the Console program. Please note that the
1966 bit mask is zero based, and Sunday is the first day of the week (bit zero).
1970 \section{The Client Resource}
1971 \label{ClientResource2}
1972 \index[general]{Resource!Client}
1973 \index[general]{Client Resource}
1975 The Client resource defines the attributes of the Clients that are served by
1976 this Director; that is the machines that are to be backed up. You will need
1977 one Client resource definition for each machine to be backed up.
1981 \item [Client (or FileDaemon)]
1982 \index[dir]{Client (or FileDaemon)}
1983 \index[dir]{Directive!Client (or FileDaemon)}
1984 Start of the Client directives.
1986 \item [Name = \lt{}name\gt{}]
1988 \index[dir]{Directive!Name}
1989 The client name which will be used in the Job resource directive or in the
1990 console run command. This directive is required.
1992 \item [Address = \lt{}address\gt{}]
1993 \index[dir]{Address}
1994 \index[dir]{Directive!FD Address}
1995 \index[dir]{File Daemon Address}
1996 \index[dir]{Client Address}
1997 Where the address is a host name, a fully qualified domain name, or a
1998 network address in dotted quad notation for a Bacula File server daemon.
1999 This directive is required.
2001 \item [FD Port = \lt{}port-number\gt{}]
2002 \index[dir]{FD Port}
2003 \index[dir]{Directive!FD Port}
2004 Where the port is a port number at which the Bacula File server daemon can
2005 be contacted. The default is 9102.
2007 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2008 \index[dir]{Catalog}
2009 \index[dir]{Directive!Catalog}
2010 This specifies the name of the catalog resource to be used for this Client.
2011 This directive is required.
2013 \item [Password = \lt{}password\gt{}]
2014 \index[dir]{Password}
2015 \index[dir]{Directive!Password}
2016 This is the password to be used when establishing a connection with the File
2017 services, so the Client configuration file on the machine to be backed up
2018 must have the same password defined for this Director. This directive is
2019 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2020 Bacula will generate a random password during the configuration process,
2021 otherwise it will be left blank.
2023 The password is plain text. It is not generated through any special
2024 process, but it is preferable for security reasons to make the text
2027 \label{FileRetention}
2028 \item [File Retention = \lt{}time-period-specification\gt{}]
2029 \index[dir]{File Retention}
2030 \index[dir]{Directive!File Retention}
2031 The File Retention directive defines the length of time that Bacula will
2032 keep File records in the Catalog database after the End time of the
2033 Job corresponding to the File records.
2034 When this time period expires, and if
2035 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2036 that are older than the specified File Retention period. Note, this affects
2037 only records in the catalog database. It does not affect your archive
2040 File records may actually be retained for a shorter period than you specify
2041 on this directive if you specify either a shorter {\bf Job Retention} or a
2042 shorter {\bf Volume Retention} period. The shortest retention period of the
2043 three takes precedence. The time may be expressed in seconds, minutes,
2044 hours, days, weeks, months, quarters, or years. See the
2045 \ilink{ Configuration chapter}{Time} of this manual for
2046 additional details of time specification.
2048 The default is 60 days.
2050 \label{JobRetention}
2051 \item [Job Retention = \lt{}time-period-specification\gt{}]
2052 \index[dir]{Job Retention}
2053 \index[dir]{Directive!Job Retention}
2054 The Job Retention directive defines the length of time that Bacula will keep
2055 Job records in the Catalog database after the Job End time. When
2056 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2057 Bacula will prune (remove) Job records that are older than the specified
2058 File Retention period. As with the other retention periods, this
2059 affects only records in the catalog and not data in your archive backup.
2061 If a Job record is selected for pruning, all associated File and JobMedia
2062 records will also be pruned regardless of the File Retention period set.
2063 As a consequence, you normally will set the File retention period to be
2064 less than the Job retention period. The Job retention period can actually
2065 be less than the value you specify here if you set the {\bf Volume
2066 Retention} directive in the Pool resource to a smaller duration. This is
2067 because the Job retention period and the Volume retention period are
2068 independently applied, so the smaller of the two takes precedence.
2070 The Job retention period is specified as seconds, minutes, hours, days,
2071 weeks, months, quarters, or years. See the
2072 \ilink{ Configuration chapter}{Time} of this manual for
2073 additional details of time specification.
2075 The default is 180 days.
2078 \item [AutoPrune = \lt{}yes|no\gt{}]
2079 \index[dir]{AutoPrune}
2080 \index[dir]{Directive!AutoPrune}
2081 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2082 will automatically apply the File retention period and the Job retention
2083 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2084 pruning will not be done, and your Catalog will grow in size each time you
2085 run a Job. Pruning affects only information in the catalog and not data
2086 stored in the backup archives (on Volumes).
2088 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2089 \index[dir]{Maximum Concurrent Jobs}
2090 \index[dir]{Directive!Maximum Concurrent Jobs}
2091 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2092 that can run concurrently. Note, this directive limits only Jobs for Clients
2093 with the same name as the resource in which it appears. Any other
2094 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2095 Storage resources will also apply in addition to any limit specified here.
2096 The default is set to 1, but you may set it to a larger number. We strongly
2097 recommend that you read the WARNING documented under
2098 \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
2101 \item [Priority = \lt{}number\gt{}]
2102 \index[dir]{Priority}
2103 \index[dir]{Directive!Priority}
2104 The number specifies the priority of this client relative to other clients
2105 that the Director is processing simultaneously. The priority can range from
2106 1 to 1000. The clients are ordered such that the smaller number priorities
2107 are performed first (not currently implemented).
2110 The following is an example of a valid Client resource definition:
2116 FDAddress = minimatou
2118 Password = very_good
2123 \section{The Storage Resource}
2124 \label{StorageResource2}
2125 \index[general]{Resource!Storage}
2126 \index[general]{Storage Resource}
2128 The Storage resource defines which Storage daemons are available for use by
2134 \index[dir]{Storage}
2135 \index[dir]{Directive!Storage}
2136 Start of the Storage resources. At least one storage resource must be
2139 \item [Name = \lt{}name\gt{}]
2141 \index[dir]{Directive!Name}
2142 The name of the storage resource. This name appears on the Storage directive
2143 specified in the Job resource and is required.
2145 \item [Address = \lt{}address\gt{}]
2146 \index[dir]{Address}
2147 \index[dir]{Directive!SD Address}
2148 \index[dir]{Storage daemon Address}
2149 Where the address is a host name, a {\bf fully qualified domain name}, or an
2150 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2151 will be transmitted to the File daemon who will then use it to contact the
2152 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2153 the name but rather a fully qualified machine name or an IP address. This
2154 directive is required.
2156 \item [SD Port = \lt{}port\gt{}]
2157 \index[dir]{SD Port}
2158 \index[dir]{Directive!SD Port}
2159 Where port is the port to use to contact the storage daemon for information
2160 and to start jobs. This same port number must appear in the Storage resource
2161 of the Storage daemon's configuration file. The default is 9103.
2163 \item [Password = \lt{}password\gt{}]
2164 \index[dir]{Password}
2165 \index[dir]{Directive!Password}
2166 This is the password to be used when establishing a connection with the
2167 Storage services. This same password also must appear in the Director
2168 resource of the Storage daemon's configuration file. This directive is
2169 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2170 Bacula will generate a random password during the configuration process,
2171 otherwise it will be left blank.
2173 The password is plain text. It is not generated through any special
2174 process, but it is preferable for security reasons to use random text.
2176 \item [Device = \lt{}device-name\gt{}]
2178 \index[dir]{Directive!Device}
2179 This directive specifies the Storage daemon's name of the device
2180 resource to be used for the storage. If you are using an Autochanger,
2181 the name specified here should be the name of the Storage daemon's
2182 Autochanger resource rather than the name of an individual device. This
2183 name is not the physical device name, but the logical device name as
2184 defined on the {\bf Name} directive contained in the {\bf Device} or the
2185 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2186 configuration file. You can specify any name you would like (even the
2187 device name if you prefer) up to a maximum of 127 characters in length.
2188 The physical device name associated with this device is specified in the
2189 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2190 Please take care not to define two different Storage resource directives
2191 in the Director that point to the same Device in the Storage daemon.
2192 Doing so may cause the Storage daemon to block (or hang) attempting to
2193 open the same device that is already open. This directive is required.
2196 \item [Media Type = \lt{}MediaType\gt{}]
2197 \index[dir]{Media Type}
2198 \index[dir]{Directive!Media Type}
2199 This directive specifies the Media Type to be used to store the data.
2200 This is an arbitrary string of characters up to 127 maximum that you
2201 define. It can be anything you want. However, it is best to make it
2202 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2203 ...). In addition, it is essential that you make the {\bf Media Type}
2204 specification unique for each storage media type. If you have two DDS-4
2205 drives that have incompatible formats, or if you have a DDS-4 drive and
2206 a DDS-4 autochanger, you almost certainly should specify different {\bf
2207 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2208 associated with the Job, Bacula can decide to use any Storage daemon
2209 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2211 If you are writing to disk Volumes, you must make doubly sure that each
2212 Device resource defined in the Storage daemon (and hence in the
2213 Director's conf file) has a unique media type. Otherwise for Bacula
2214 versions 1.38 and older, your restores may not work because Bacula
2215 will assume that you can mount any Media Type with the same name on
2216 any Device associated with that Media Type. This is possible with
2217 tape drives, but with disk drives, unless you are very clever you
2218 cannot mount a Volume in any directory -- this can be done by creating
2219 an appropriate soft link.
2221 Currently Bacula permits only a single Media Type per Storage
2222 and Device definition. Consequently, if
2223 you have a drive that supports more than one Media Type, you can
2224 give a unique string to Volumes with different intrinsic Media
2225 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2226 those volumes will only be mounted on drives indicated with the
2227 dual type (DDS-3-4).
2229 If you want to tie Bacula to using a single Storage daemon or drive, you
2230 must specify a unique Media Type for that drive. This is an important
2231 point that should be carefully understood. Note, this applies equally
2232 to Disk Volumes. If you define more than one disk Device resource in
2233 your Storage daemon's conf file, the Volumes on those two devices are in
2234 fact incompatible because one can not be mounted on the other device
2235 since they are found in different directories. For this reason, you
2236 probably should use two different Media Types for your two disk Devices
2237 (even though you might think of them as both being File types). You can
2238 find more on this subject in the \ilink{Basic Volume
2239 Management}{DiskChapter} chapter of this manual.
2241 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2242 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2243 resource of the {\bf Storage daemon} configuration file. This directive
2244 is required, and it is used by the Director and the Storage daemon to
2245 ensure that a Volume automatically selected from the Pool corresponds to
2246 the physical device. If a Storage daemon handles multiple devices (e.g.
2247 will write to various file Volumes on different partitions), this
2248 directive allows you to specify exactly which device.
2250 As mentioned above, the value specified in the Director's Storage
2251 resource must agree with the value specified in the Device resource in
2252 the {\bf Storage daemon's} configuration file. It is also an additional
2253 check so that you don't try to write data for a DLT onto an 8mm device.
2255 \label{Autochanger1}
2256 \item [Autochanger = \lt{}yes|no\gt{}]
2257 \index[dir]{Autochanger}
2258 \index[dir]{Directive!Autochanger}
2259 If you specify {\bf yes} for this command (the default is {\bf no}),
2260 when you use the {\bf label} command or the {\bf add} command to create
2261 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2262 number. This simplifies creating database entries for Volumes in an
2263 autochanger. If you forget to specify the Slot, the autochanger will
2264 not be used. However, you may modify the Slot associated with a Volume
2265 at any time by using the {\bf update volume} or {\bf update slots}
2266 command in the console program. When {\bf autochanger} is enabled, the
2267 algorithm used by Bacula to search for available volumes will be
2268 modified to consider only Volumes that are known to be in the
2269 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2270 will attempt recycling, pruning, ..., and if still no volume is found,
2271 Bacula will search for any volume whether or not in the magazine. By
2272 privileging in changer volumes, this procedure minimizes operator
2273 intervention. The default is {\bf no}.
2275 For the autochanger to be used, you must also specify {\bf Autochanger =
2276 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2277 configuration file as well as other important Storage daemon
2278 configuration information. Please consult the \ilink{Using
2279 Autochangers}{AutochangersChapter} manual of this chapter for the
2280 details of using autochangers.
2282 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2283 \index[dir]{Maximum Concurrent Jobs}
2284 \index[dir]{Directive!Maximum Concurrent Jobs}
2285 where \lt{}number\gt{} is the maximum number of Jobs with the current
2286 Storage resource that can run concurrently. Note, this directive limits
2287 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2288 the maximum concurrent jobs such as in the Director, Job, or Client
2289 resources will also apply in addition to any limit specified here. The
2290 default is set to 1, but you may set it to a larger number. However, if
2291 you set the Storage daemon's number of concurrent jobs greater than one,
2292 we recommend that you read the waring documented under \ilink{Maximum
2293 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2294 turn data spooling on as documented in the \ilink{Data
2295 Spooling}{SpoolingChapter} chapter of this manual.
2297 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2298 \index[dir]{Heartbeat Interval}
2299 \index[dir]{Directive!Heartbeat}
2300 This directive is optional and if specified will cause the Director to
2301 set a keepalive interval (heartbeat) in seconds on each of the sockets
2302 it opens for the Storage resource. This value will override any
2303 specified at the Director level. It is implemented only on systems
2304 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2305 The default value is zero, which means no change is made to the socket.
2309 The following is an example of a valid Storage resource definition:
2313 # Definition of tape storage device
2317 Password = storage_password # password for Storage daemon
2318 Device = "HP DLT 80" # same as Device in Storage daemon
2319 Media Type = DLT8000 # same as MediaType in Storage daemon
2324 \section{The Pool Resource}
2325 \label{PoolResource}
2326 \index[general]{Resource!Pool}
2327 \index[general]{Pool Resource}
2329 The Pool resource defines the set of storage Volumes (tapes or files) to be
2330 used by Bacula to write the data. By configuring different Pools, you can
2331 determine which set of Volumes (media) receives the backup data. This permits,
2332 for example, to store all full backup data on one set of Volumes and all
2333 incremental backups on another set of Volumes. Alternatively, you could assign
2334 a different set of Volumes to each machine that you backup. This is most
2335 easily done by defining multiple Pools.
2337 Another important aspect of a Pool is that it contains the default attributes
2338 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2339 Volume when it is created. This avoids the need for you to answer a large
2340 number of questions when labeling a new Volume. Each of these attributes can
2341 later be changed on a Volume by Volume basis using the {\bf update} command in
2342 the console program. Note that you must explicitly specify which Pool Bacula
2343 is to use with each Job. Bacula will not automatically search for the correct
2346 Most often in Bacula installations all backups for all machines (Clients) go
2347 to a single set of Volumes. In this case, you will probably only use the {\bf
2348 Default} Pool. If your backup strategy calls for you to mount a different tape
2349 each day, you will probably want to define a separate Pool for each day. For
2350 more information on this subject, please see the
2351 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2355 To use a Pool, there are three distinct steps. First the Pool must be defined
2356 in the Director's configuration file. Then the Pool must be written to the
2357 Catalog database. This is done automatically by the Director each time that it
2358 starts, or alternatively can be done using the {\bf create} command in the
2359 console program. Finally, if you change the Pool definition in the Director's
2360 configuration file and restart Bacula, the pool will be updated alternatively
2361 you can use the {\bf update pool} console command to refresh the database
2362 image. It is this database image rather than the Director's resource image
2363 that is used for the default Volume attributes. Note, for the pool to be
2364 automatically created or updated, it must be explicitly referenced by a Job
2367 Next the physical media must be labeled. The labeling can either be done with
2368 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2369 program. The preferred method is to use the {\bf label} command in the {\bf
2372 Finally, you must add Volume names (and their attributes) to the Pool. For
2373 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2374 archive device specified for the job (i.e. if you are going to back up to a
2375 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2376 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2377 are backing up to files. When running a Job, you must explicitly specify which
2378 Pool to use. Bacula will then automatically select the next Volume to use from
2379 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2380 from the Pool is identical to that required by the Storage resource you have
2381 specified for the Job.
2383 If you use the {\bf label} command in the console program to label the
2384 Volumes, they will automatically be added to the Pool, so this last step is
2385 not normally required.
2387 It is also possible to add Volumes to the database without explicitly labeling
2388 the physical volume. This is done with the {\bf add} console command.
2390 As previously mentioned, each time Bacula starts, it scans all the Pools
2391 associated with each Catalog, and if the database record does not already
2392 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2393 probably should do an {\bf update pool} if you change the Pool definition, but
2394 currently, you must do this manually using the {\bf update pool} command in
2395 the Console program.
2397 The Pool Resource defined in the Director's configuration file
2398 (bacula-dir.conf) may contain the following directives:
2404 \index[dir]{Directive!Pool}
2405 Start of the Pool resource. There must be at least one Pool resource
2409 \item [Name = \lt{}name\gt{}]
2411 \index[dir]{Directive!Name}
2412 The name of the pool. For most applications, you will use the default
2413 pool name {\bf Default}. This directive is required.
2416 \item [Maximum Volumes = \lt{}number\gt{}]
2417 \index[dir]{Maximum Volumes}
2418 \index[dir]{Directive!Maximum Volumes}
2419 This directive specifies the maximum number of volumes (tapes or files)
2420 contained in the pool. This directive is optional, if omitted or set to
2421 zero, any number of volumes will be permitted. In general, this
2422 directive is useful for Autochangers where there is a fixed number of
2423 Volumes, or for File storage where you wish to ensure that the backups
2424 made to disk files do not become too numerous or consume too much space.
2426 \item [Pool Type = \lt{}type\gt{}]
2427 \index[dir]{Pool Type}
2428 \index[dir]{Directive!Pool Type}
2429 This directive defines the pool type, which corresponds to the type of
2430 Job being run. It is required and may be one of the following:
2440 Note, only Backup is current implemented.
2442 \item [Storage = \lt{}storage-resource-name\gt{}]
2443 \index[dir]{Storage}
2444 \index[dir]{Directive!Storage}
2445 The Storage directive defines the name of the storage services where you
2446 want to backup the FileSet data. For additional details, see the
2447 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2448 The Storage resource may also be specified in the Job resource,
2449 but the value, if any, in the Pool resource overrides any value
2450 in the Job. This Storage resource definition is not required by either
2451 the Job resource or in the Pool, but it must be specified in
2452 one or the other. If not configuration error will result.
2454 \item [Use Volume Once = \lt{}yes|no\gt{}]
2455 \index[dir]{Use Volume Once}
2456 \index[dir]{Directive!Use Volume Once}
2457 This directive if set to {\bf yes} specifies that each volume is to be
2458 used only once. This is most useful when the Media is a file and you
2459 want a new file for each backup that is done. The default is {\bf no}
2460 (i.e. use volume any number of times). This directive will most likely
2461 be phased out (deprecated), so you are recommended to use {\bf Maximum
2462 Volume Jobs = 1} instead.
2464 The value defined by this directive in the bacula-dir.conf file is the
2465 default value used when a Volume is created. Once the volume is
2466 created, changing the value in the bacula-dir.conf file will not change
2467 what is stored for the Volume. To change the value for an existing
2468 Volume you must use the {\bf update} command in the Console.
2470 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2471 using this directive with multiple simultaneous jobs.
2473 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2474 \index[dir]{Maximum Volume Jobs}
2475 \index[dir]{Directive!Maximum Volume Jobs}
2476 This directive specifies the maximum number of Jobs that can be written
2477 to the Volume. If you specify zero (the default), there is no limit.
2478 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2479 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2480 is marked {\bf Used} it can no longer be used for appending Jobs, much
2481 like the {\bf Full} status but it can be recycled if recycling is
2482 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2483 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2485 The value defined by this directive in the bacula-dir.conf
2486 file is the default value used when a Volume is created. Once the volume is
2487 created, changing the value in the bacula-dir.conf file will not change what
2488 is stored for the Volume. To change the value for an existing Volume you
2489 must use the {\bf update} command in the Console.
2491 If you are running multiple simultaneous jobs, this directive may not
2492 work correctly because when a drive is reserved for a job, this
2493 directive is not taken into account, so multiple jobs may try to
2494 start writing to the Volume. At some point, when the Media record is
2495 updated, multiple simultaneous jobs may fail since the Volume can no
2498 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2499 \index[dir]{Maximum Volume Files}
2500 \index[dir]{Directive!Maximum Volume Files}
2501 This directive specifies the maximum number of files that can be written
2502 to the Volume. If you specify zero (the default), there is no limit.
2503 Otherwise, when the number of files written to the Volume equals {\bf
2504 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2505 is marked {\bf Used} it can no longer be used for appending Jobs, much
2506 like the {\bf Full} status but it can be recycled if recycling is
2507 enabled and thus used again. This value is checked and the {\bf Used}
2508 status is set only at the end of a job that writes to the particular
2511 The value defined by this directive in the bacula-dir.conf file is the
2512 default value used when a Volume is created. Once the volume is
2513 created, changing the value in the bacula-dir.conf file will not change
2514 what is stored for the Volume. To change the value for an existing
2515 Volume you must use the {\bf update} command in the Console.
2517 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2518 \index[dir]{Maximum Volume Bytes}
2519 \index[dir]{Directive!Maximum Volume Bytes}
2520 This directive specifies the maximum number of bytes that can be written
2521 to the Volume. If you specify zero (the default), there is no limit
2522 except the physical size of the Volume. Otherwise, when the number of
2523 bytes written to the Volume equals {\bf size} the Volume will be marked
2524 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2525 used for appending Jobs, much like the {\bf Full} status but it can be
2526 recycled if recycling is enabled, and thus the Volume can be re-used
2527 after recycling. This value is checked and the {\bf Used} status set
2528 while the job is writing to the particular volume.
2530 This directive is particularly useful for restricting the size
2531 of disk volumes, and will work correctly even in the case of
2532 multiple simultaneous jobs writing to the volume.
2534 The value defined by this directive in the bacula-dir.conf file is the
2535 default value used when a Volume is created. Once the volume is
2536 created, changing the value in the bacula-dir.conf file will not change
2537 what is stored for the Volume. To change the value for an existing
2538 Volume you must use the {\bf update} command in the Console.
2540 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2541 \index[dir]{Volume Use Duration}
2542 \index[dir]{Directive!Volume Use Duration}
2543 The Volume Use Duration directive defines the time period that the
2544 Volume can be written beginning from the time of first data write to the
2545 Volume. If the time-period specified is zero (the default), the Volume
2546 can be written indefinitely. Otherwise, the next time a job
2547 runs that wants to access this Volume, and the time period from the
2548 first write to the volume (the first Job written) exceeds the
2549 time-period-specification, the Volume will be marked {\bf Used}, which
2550 means that no more Jobs can be appended to the Volume, but it may be
2551 recycled if recycling is enabled. Using the command {\bf
2552 status dir} applies algorithms similar to running jobs, so
2553 during such a command, the Volume status may also be changed.
2555 recycled, it will be available for use again.
2557 You might use this directive, for example, if you have a Volume used for
2558 Incremental backups, and Volumes used for Weekly Full backups. Once the
2559 Full backup is done, you will want to use a different Incremental
2560 Volume. This can be accomplished by setting the Volume Use Duration for
2561 the Incremental Volume to six days. I.e. it will be used for the 6
2562 days following a Full save, then a different Incremental volume will be
2563 used. Be careful about setting the duration to short periods such as 23
2564 hours, or you might experience problems of Bacula waiting for a tape
2565 over the weekend only to complete the backups Monday morning when an
2566 operator mounts a new tape.
2568 The use duration is checked and the {\bf Used} status is set only at the
2569 end of a job that writes to the particular volume, which means that even
2570 though the use duration may have expired, the catalog entry will not be
2571 updated until the next job that uses this volume is run. This
2572 directive is not intended to be used to limit volume sizes
2573 and will not work correctly (i.e. will fail jobs) if the use
2574 duration expires while multiple simultaneous jobs are writing
2577 Please note that the value defined by this directive in the bacula-dir.conf
2578 file is the default value used when a Volume is created. Once the volume is
2579 created, changing the value in the bacula-dir.conf file will not change what
2580 is stored for the Volume. To change the value for an existing Volume you
2582 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2584 \item [Catalog Files = \lt{}yes|no\gt{}]
2585 \index[dir]{Catalog Files}
2586 \index[dir]{Directive!Catalog Files}
2587 This directive defines whether or not you want the names of the files
2588 that were saved to be put into the catalog. The default is {\bf yes}.
2589 The advantage of specifying {\bf Catalog Files = No} is that you will
2590 have a significantly smaller Catalog database. The disadvantage is that
2591 you will not be able to produce a Catalog listing of the files backed up
2592 for each Job (this is often called Browsing). Also, without the File
2593 entries in the catalog, you will not be able to use the Console {\bf
2594 restore} command nor any other command that references File entries.
2596 \label{PoolAutoPrune}
2597 \item [AutoPrune = \lt{}yes|no\gt{}]
2598 \index[dir]{AutoPrune}
2599 \index[dir]{Directive!AutoPrune}
2600 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2601 greater) will automatically apply the Volume Retention period when new
2602 Volume is needed and no appendable Volumes exist in the Pool. Volume
2603 pruning causes expired Jobs (older than the {\bf Volume Retention}
2604 period) to be deleted from the Catalog and permits possible recycling of
2607 \label{VolRetention}
2608 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2609 \index[dir]{Volume Retention}
2610 \index[dir]{Directive!Volume Retention}
2611 The Volume Retention directive defines the length of time that {\bf
2612 Bacula} will keep records associated with the Volume in
2613 the Catalog database after the End time of each Job written to the
2614 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2615 {\bf yes} Bacula may prune (remove) Job records that are older than the
2616 specified Volume Retention period if it is necessary to free up a
2617 Volume. Recycling will not occur until it is absolutely necessary to
2618 free up a volume (i.e. no other writable volume exists).
2619 All File records associated with pruned Jobs are also
2620 pruned. The time may be specified as seconds, minutes, hours, days,
2621 weeks, months, quarters, or years. The {\bf Volume Retention} is
2622 applied independently of the {\bf Job Retention} and the {\bf File
2623 Retention} periods defined in the Client resource. This means that all
2624 the retentions periods are applied in turn and that the shorter period
2625 is the one that effectively takes precedence. Note, that when the {\bf
2626 Volume Retention} period has been reached, and it is necessary to obtain
2627 a new volume, Bacula will prune both the Job and the File records. This
2628 pruning could also occur during a {\bf status dir} command because it
2629 uses similar algorithms for finding the next available Volume.
2631 It is important to know that when the Volume Retention period expires,
2632 Bacula does not automatically recycle a Volume. It attempts to keep the
2633 Volume data intact as long as possible before over writing the Volume.
2636 By defining multiple Pools with different Volume Retention periods, you
2637 may effectively have a set of tapes that is recycled weekly, another
2638 Pool of tapes that is recycled monthly and so on. However, one must
2639 keep in mind that if your {\bf Volume Retention} period is too short, it
2640 may prune the last valid Full backup, and hence until the next Full
2641 backup is done, you will not have a complete backup of your system, and
2642 in addition, the next Incremental or Differential backup will be
2643 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2644 Retention} period should be at twice the interval of your Full backups.
2645 This means that if you do a Full backup once a month, the minimum Volume
2646 retention period should be two months.
2648 The default Volume retention period is 365 days, and either the default
2649 or the value defined by this directive in the bacula-dir.conf file is
2650 the default value used when a Volume is created. Once the volume is
2651 created, changing the value in the bacula-dir.conf file will not change
2652 what is stored for the Volume. To change the value for an existing
2653 Volume you must use the {\bf update} command in the Console.
2655 \label{PoolRecyclePool}
2656 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2657 \index[dir]{RecyclePool}
2658 \index[dir]{Directive!RecyclePool}
2659 On versions 2.1.4 or greater, this directive defines to which pool
2660 the Volume will be placed (moved) when it is recycled. Without
2661 this directive, a Volume will remain in the same pool when it is
2662 recycled. With this directive, it can be moved automatically to any
2663 existing pool during a recycle. This directive is probably most
2664 useful when defined in the Scratch pool, so that volumes will
2665 be recycled back into the Scratch pool. For more on the see the
2666 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2668 Although this directive is called RecyclePool, the Volume in
2669 question is actually moved from its current pool to the one
2670 you specify on this directive when Bacula prunes the Volume and
2671 discovers that there are no records left in the catalog and hence
2672 marks it as {\bf Purged}.
2676 \item [Recycle = \lt{}yes|no\gt{}]
2677 \index[dir]{Recycle}
2678 \index[dir]{Directive!Recycle}
2679 This directive specifies whether or not Purged Volumes may be recycled.
2680 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2681 none that are appendable, it will search for and recycle (reuse) Purged
2682 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2683 deleted from the Catalog). If the Volume is recycled, all previous data
2684 written to that Volume will be overwritten. If Recycle is set to {\bf
2685 no}, the Volume will not be recycled, and hence, the data will remain
2686 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2687 is no (0 in the catalog), you may manually set the recycle flag (update
2688 command) for a Volume to be reused.
2690 Please note that the value defined by this directive in the
2691 bacula-dir.conf file is the default value used when a Volume is created.
2692 Once the volume is created, changing the value in the bacula-dir.conf
2693 file will not change what is stored for the Volume. To change the value
2694 for an existing Volume you must use the {\bf update} command in the
2697 When all Job and File records have been pruned or purged from the
2698 catalog for a particular Volume, if that Volume is marked as
2699 Append, Full, Used, or Error, it will then be marked as Purged. Only
2700 Volumes marked as Purged will be considered to be converted to the
2701 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
2704 \label{RecycleOldest}
2705 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2706 \index[dir]{Recycle Oldest Volume}
2707 \index[dir]{Directive!Recycle Oldest Volume}
2708 This directive instructs the Director to search for the oldest used
2709 Volume in the Pool when another Volume is requested by the Storage
2710 daemon and none are available. The catalog is then {\bf pruned}
2711 respecting the retention periods of all Files and Jobs written to this
2712 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2713 Volume is recycled and will be used as the next Volume to be written.
2714 This directive respects any Job, File, or Volume retention periods that
2715 you may have specified, and as such it is {\bf much} better to use this
2716 directive than the Purge Oldest Volume.
2718 This directive can be useful if you have a fixed number of Volumes in the
2719 Pool and you want to cycle through them and you have specified the correct
2722 However, if you use this directive and have only one
2723 Volume in the Pool, you will immediately recycle your Volume if you fill
2724 it and Bacula needs another one. Thus your backup will be totally invalid.
2725 Please use this directive with care. The default is {\bf no}.
2727 \label{RecycleCurrent}
2729 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2730 \index[dir]{Recycle Current Volume}
2731 \index[dir]{Directive!Recycle Current Volume}
2732 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2733 the volume respecting the Job and File retention periods. If all Jobs
2734 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2735 will be used as the next Volume to be written. This directive respects
2736 any Job, File, or Volume retention periods that you may have specified,
2737 and thus it is {\bf much} better to use it rather than the Purge Oldest
2740 This directive can be useful if you have: a fixed number of Volumes in
2741 the Pool, you want to cycle through them, and you have specified
2742 retention periods that prune Volumes before you have cycled through the
2745 However, if you use this directive and have only one Volume in the Pool,
2746 you will immediately recycle your Volume if you fill it and Bacula needs
2747 another one. Thus your backup will be totally invalid. Please use this
2748 directive with care. The default is {\bf no}.
2752 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2753 \index[dir]{Purge Oldest Volume}
2754 \index[dir]{Directive!Purge Oldest Volume}
2755 This directive instructs the Director to search for the oldest used
2756 Volume in the Pool when another Volume is requested by the Storage
2757 daemon and none are available. The catalog is then {\bf purged}
2758 irrespective of retention periods of all Files and Jobs written to this
2759 Volume. The Volume is then recycled and will be used as the next Volume
2760 to be written. This directive overrides any Job, File, or Volume
2761 retention periods that you may have specified.
2763 This directive can be useful if you have a fixed number of Volumes in
2764 the Pool and you want to cycle through them and reusing the oldest one
2765 when all Volumes are full, but you don't want to worry about setting
2766 proper retention periods. However, by using this option you risk losing
2769 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2770 periods. If you have only a single Volume defined and you turn this
2771 variable on, that Volume will always be immediately overwritten when it
2772 fills! So at a minimum, ensure that you have a decent number of Volumes
2773 in your Pool before running any jobs. If you want retention periods to
2774 apply do not use this directive. To specify a retention period, use the
2775 {\bf Volume Retention} directive (see above).
2777 We {\bf highly} recommend against using this directive, because it is
2778 sure that some day, Bacula will recycle a Volume that contains current
2779 data. The default is {\bf no}.
2781 \item [Cleaning Prefix = \lt{}string\gt{}]
2782 \index[dir]{Cleaning Prefix}
2783 \index[dir]{Directive!Cleaning Prefix}
2784 This directive defines a prefix string, which if it matches the
2785 beginning of a Volume name during labeling of a Volume, the Volume will
2786 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2787 never attempt to use this tape. This is primarily for use with
2788 autochangers that accept barcodes where the convention is that barcodes
2789 beginning with {\bf CLN} are treated as cleaning tapes.
2792 \item [Label Format = \lt{}format\gt{}]
2793 \index[dir]{Label Format}
2794 \index[dir]{Directive!Label Format}
2795 This directive specifies the format of the labels contained in this
2796 pool. The format directive is used as a sort of template to create new
2797 Volume names during automatic Volume labeling.
2799 The {\bf format} should be specified in double quotes, and consists of
2800 letters, numbers and the special characters hyphen ({\bf -}), underscore
2801 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2802 characters for a Volume name. The {\bf format} should be enclosed in
2805 In addition, the format may contain a number of variable expansion
2806 characters which will be expanded by a complex algorithm allowing you to
2807 create Volume names of many different formats. In all cases, the
2808 expansion process must resolve to the set of characters noted above that
2809 are legal Volume names. Generally, these variable expansion characters
2810 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2811 specify variable expansion characters, you should always enclose the
2812 format with double quote characters ({\bf "}). For more details on
2813 variable expansion, please see the \ilink{Variable
2814 Expansion}{VarsChapter} Chapter of this manual.
2816 If no variable expansion characters are found in the string, the Volume
2817 name will be formed from the {\bf format} string appended with the
2818 number of volumes in the pool plus one, which will be edited as four
2819 digits with leading zeros. For example, with a {\bf Label Format =
2820 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2823 With the exception of Job specific variables, you can test your {\bf
2824 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2827 In almost all cases, you should enclose the format specification (part
2828 after the equal sign) in double quotes. Please note that this directive
2829 is deprecated and is replaced in version 1.37 and greater with a Python
2830 script for creating volume names.
2834 In order for a Pool to be used during a Backup Job, the Pool must have at
2835 least one Volume associated with it. Volumes are created for a Pool using
2836 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2837 program. In addition to adding Volumes to the Pool (i.e. putting the
2838 Volume names in the Catalog database), the physical Volume must be labeled
2839 with a valid Bacula software volume label before {\bf Bacula} will accept
2840 the Volume. This will be automatically done if you use the {\bf label}
2841 command. Bacula can automatically label Volumes if instructed to do so,
2842 but this feature is not yet fully implemented.
2844 The following is an example of a valid Pool resource definition:
2856 \subsection{The Scratch Pool}
2857 \label{TheScratchPool}
2858 \index[general]{Scratch Pool}
2859 In general, you can give your Pools any name you wish, but there is one
2860 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2861 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2862 writing and it cannot find one, it will look in the Scratch pool, and if
2863 it finds an available Volume, it will move it out of the Scratch pool into
2864 the Pool currently being used by the job.
2867 \section{The Catalog Resource}
2868 \label{CatalogResource}
2869 \index[general]{Resource!Catalog}
2870 \index[general]{Catalog Resource}
2872 The Catalog Resource defines what catalog to use for the current job.
2873 Currently, Bacula can only handle a single database server (SQLite, MySQL,
2874 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
2875 may be as many Catalogs (databases) defined as you wish. For example, you
2876 may want each Client to have its own Catalog database, or you may want
2877 backup jobs to use one database and verify or restore jobs to use another
2880 Since SQLite is compiled in, it always runs on the same machine
2881 as the Director and the database must be directly accessible (mounted) from
2882 the Director. However, since both MySQL and PostgreSQL are networked
2883 databases, they may reside either on the same machine as the Director
2884 or on a different machine on the network. See below for more details.
2889 \index[dir]{Catalog}
2890 \index[dir]{Directive!Catalog}
2891 Start of the Catalog resource. At least one Catalog resource must be
2895 \item [Name = \lt{}name\gt{}]
2897 \index[dir]{Directive!Name}
2898 The name of the Catalog. No necessary relation to the database server
2899 name. This name will be specified in the Client resource directive
2900 indicating that all catalog data for that Client is maintained in this
2901 Catalog. This directive is required.
2903 \item [password = \lt{}password\gt{}]
2904 \index[dir]{password}
2905 \index[dir]{Directive!password}
2906 This specifies the password to use when logging into the database. This
2907 directive is required.
2909 \item [DB Name = \lt{}name\gt{}]
2910 \index[dir]{DB Name}
2911 \index[dir]{Directive!DB Name}
2912 This specifies the name of the database. If you use multiple catalogs
2913 (databases), you specify which one here. If you are using an external
2914 database server rather than the internal one, you must specify a name
2915 that is known to the server (i.e. you explicitly created the Bacula
2916 tables using this name. This directive is required.
2918 \item [user = \lt{}user\gt{}]
2920 \index[dir]{Directive!user}
2921 This specifies what user name to use to log into the database. This
2922 directive is required.
2924 \item [DB Socket = \lt{}socket-name\gt{}]
2925 \index[dir]{DB Socket}
2926 \index[dir]{Directive!DB Socket}
2927 This is the name of a socket to use on the local host to connect to the
2928 database. This directive is used only by MySQL and is ignored by SQLite.
2929 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
2930 will use the default socket. If the DB Socket is specified, the
2931 MySQL server must reside on the same machine as the Director.
2933 \item [DB Address = \lt{}address\gt{}]
2934 \index[dir]{DB Address}
2935 \index[dir]{Directive!DB Address}
2936 This is the host address of the database server. Normally, you would specify
2937 this instead of {\bf DB Socket} if the database server is on another machine.
2938 In that case, you will also specify {\bf DB Port}. This directive is used
2939 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
2940 This directive is optional.
2942 \item [DB Port = \lt{}port\gt{}]
2943 \index[dir]{DB Port}
2944 \index[dir]{Directive!DB Port}
2945 This defines the port to be used in conjunction with {\bf DB Address} to
2946 access the database if it is on another machine. This directive is used only
2947 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
2948 directive is optional.
2950 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
2951 %% \index[dir]{Multiple Connections}
2952 %% \index[dir]{Directive!Multiple Connections}
2953 %% By default, this directive is set to no. In that case, each job that uses
2955 %% same Catalog will use a single connection to the catalog. It will be shared,
2956 %% and Bacula will allow only one Job at a time to communicate. If you set this
2957 %% directive to yes, Bacula will permit multiple connections to the database,
2958 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
2959 %% this is no problem. For MySQL, you must be *very* careful to have the
2960 %% multi-thread version of the client library loaded on your system. When this
2961 %% directive is set yes, each Job will have a separate connection to the
2962 %% database, and the database will control the interaction between the
2964 %% Jobs. This can significantly speed up the database operations if you are
2965 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
2966 %% Bacula will automatically enable transactions. This can significantly speed
2967 %% up insertion of attributes in the database either for a single Job or
2968 %% multiple simultaneous Jobs.
2970 %% This directive has not been tested. Please test carefully before running it
2971 %% in production and report back your results.
2975 The following is an example of a valid Catalog resource definition:
2984 password = "" # no password = no security
2989 or for a Catalog on another machine:
2999 DB Address = remote.acme.com
3005 \section{The Messages Resource}
3006 \label{MessagesResource2}
3007 \index[general]{Resource!Messages}
3008 \index[general]{Messages Resource}
3010 For the details of the Messages Resource, please see the
3011 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3014 \section{The Console Resource}
3015 \label{ConsoleResource1}
3016 \index[general]{Console Resource}
3017 \index[general]{Resource!Console}
3019 As of Bacula version 1.33 and higher, there are three different kinds of
3020 consoles, which the administrator or user can use to interact with the
3021 Director. These three kinds of consoles comprise three different security
3025 \item The first console type is an {\bf anonymous} or {\bf default} console,
3026 which has full privileges. There is no console resource necessary for
3027 this type since the password is specified in the Director's resource and
3028 consequently such consoles do not have a name as defined on a {\bf Name
3029 =} directive. This is the kind of console that was initially
3030 implemented in versions prior to 1.33 and remains valid. Typically you
3031 would use it only for administrators.
3033 \item The second type of console, and new to version 1.33 and higher is a
3034 "named" console defined within a Console resource in both the Director's
3035 configuration file and in the Console's configuration file. Both the
3036 names and the passwords in these two entries must match much as is the
3037 case for Client programs.
3039 This second type of console begins with absolutely no privileges except
3040 those explicitly specified in the Director's Console resource. Thus you
3041 can have multiple Consoles with different names and passwords, sort of
3042 like multiple users, each with different privileges. As a default,
3043 these consoles can do absolutely nothing -- no commands whatsoever. You
3044 give them privileges or rather access to commands and resources by
3045 specifying access control lists in the Director's Console resource. The
3046 ACLs are specified by a directive followed by a list of access names.
3047 Examples of this are shown below.
3049 \item The third type of console is similar to the above mentioned one in that
3050 it requires a Console resource definition in both the Director and the
3051 Console. In addition, if the console name, provided on the {\bf Name =}
3052 directive, is the same as a Client name, that console is permitted to
3053 use the {\bf SetIP} command to change the Address directive in the
3054 Director's client resource to the IP address of the Console. This
3055 permits portables or other machines using DHCP (non-fixed IP addresses)
3056 to "notify" the Director of their current IP address.
3059 The Console resource is optional and need not be specified. The following
3060 directives are permitted within the Director's configuration resource:
3064 \item [Name = \lt{}name\gt{}]
3066 \index[dir]{Directive!Name}
3067 The name of the console. This name must match the name specified in the
3068 Console's configuration resource (much as is the case with Client
3071 \item [Password = \lt{}password\gt{}]
3072 \index[dir]{Password}
3073 \index[dir]{Directive!Password}
3074 Specifies the password that must be supplied for a named Bacula Console
3075 to be authorized. The same password must appear in the {\bf Console}
3076 resource of the Console configuration file. For added security, the
3077 password is never actually passed across the network but rather a
3078 challenge response hash code created with the password. This directive
3079 is required. If you have either {\bf /dev/random} {\bf bc} on your
3080 machine, Bacula will generate a random password during the configuration
3081 process, otherwise it will be left blank.
3083 The password is plain text. It is not generated through any special
3084 process. However, it is preferable for security reasons to choose
3087 \item [JobACL = \lt{}name-list\gt{}]
3089 \index[dir]{Directive!JobACL}
3090 This directive is used to specify a list of Job resource names that can
3091 be accessed by the console. Without this directive, the console cannot
3092 access any of the Director's Job resources. Multiple Job resource names
3093 may be specified by separating them with commas, and/or by specifying
3094 multiple JobACL directives. For example, the directive may be specified
3099 JobACL = kernsave, "Backup client 1", "Backup client 2"
3100 JobACL = "RestoreFiles"
3105 With the above specification, the console can access the Director's resources
3106 for the four jobs named on the JobACL directives, but for no others.
3108 \item [ClientACL = \lt{}name-list\gt{}]
3109 \index[dir]{ClientACL}
3110 \index[dir]{Directive!ClientACL}
3111 This directive is used to specify a list of Client resource names that can
3113 accessed by the console.
3115 \item [StorageACL = \lt{}name-list\gt{}]
3116 \index[dir]{StorageACL}
3117 \index[dir]{Directive!StorageACL}
3118 This directive is used to specify a list of Storage resource names that can
3119 be accessed by the console.
3121 \item [ScheduleACL = \lt{}name-list\gt{}]
3122 \index[dir]{ScheduleACL}
3123 \index[dir]{Directive!ScheduleACL}
3124 This directive is used to specify a list of Schedule resource names that can
3125 be accessed by the console.
3127 \item [PoolACL = \lt{}name-list\gt{}]
3128 \index[dir]{PoolACL}
3129 \index[dir]{Directive!PoolACL}
3130 This directive is used to specify a list of Pool resource names that can be
3131 accessed by the console.
3133 \item [FileSetACL = \lt{}name-list\gt{}]
3134 \index[dir]{FileSetACL}
3135 \index[dir]{Directive!FileSetACL}
3136 This directive is used to specify a list of FileSet resource names that
3137 can be accessed by the console.
3139 \item [CatalogACL = \lt{}name-list\gt{}]
3140 \index[dir]{CatalogACL}
3141 \index[dir]{Directive!CatalogACL}
3142 This directive is used to specify a list of Catalog resource names that
3143 can be accessed by the console.
3145 \item [CommandACL = \lt{}name-list\gt{}]
3146 \index[dir]{CommandACL}
3147 \index[dir]{Directive!CommandACL}
3148 This directive is used to specify a list of of console commands that can
3149 be executed by the console.
3151 \item [WhereACL = \lt{}string\gt{}]
3152 \index[dir]{WhereACL}
3153 \index[dir]{Directive!WhereACL}
3154 This directive permits you to specify where a restricted console
3155 can restore files. If this directive is not specified, only the
3156 default restore location is permitted (normally {\bf
3157 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3158 user enters will be accepted (not very secure), any other
3159 value specified (there may be multiple WhereACL directives) will
3160 restrict the user to use that path. For example, on a Unix system,
3161 if you specify "/", the file will be restored to the original
3162 location. This directive is untested.
3166 Aside from Director resource names and console command names, the special
3167 keyword {\bf *all*} can be specified in any of the above access control lists.
3168 When this keyword is present, any resource or command name (which ever is
3169 appropriate) will be accepted. For an example configuration file, please see
3171 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3174 \section{The Counter Resource}
3175 \label{CounterResource}
3176 \index[general]{Resource!Counter}
3177 \index[general]{Counter Resource}
3179 The Counter Resource defines a counter variable that can be accessed by
3180 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3182 \ilink{LabelFormat}{Label} directive in this chapter for more
3188 \index[dir]{Counter}
3189 \index[dir]{Directive!Counter}
3190 Start of the Counter resource. Counter directives are optional.
3192 \item [Name = \lt{}name\gt{}]
3194 \index[dir]{Directive!Name}
3195 The name of the Counter. This is the name you will use in the variable
3196 expansion to reference the counter value.
3198 \item [Minimum = \lt{}integer\gt{}]
3199 \index[dir]{Minimum}
3200 \index[dir]{Directive!Minimum}
3201 This specifies the minimum value that the counter can have. It also becomes
3202 the default. If not supplied, zero is assumed.
3204 \item [Maximum = \lt{}integer\gt{}]
3205 \index[dir]{Maximum}
3206 \index[dir]{Directive!Maximum}
3207 \index[dir]{Directive!Maximum}
3208 This is the maximum value value that the counter can have. If not specified
3209 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3210 the 31 power). When the counter is incremented past this value, it is reset
3213 \item [*WrapCounter = \lt{}counter-name\gt{}]
3214 \index[dir]{*WrapCounter}
3215 \index[dir]{Directive!*WrapCounter}
3216 If this value is specified, when the counter is incremented past the
3218 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3219 is incremented. (This is not currently implemented).
3221 \item [Catalog = \lt{}catalog-name\gt{}]
3222 \index[dir]{Catalog}
3223 \index[dir]{Directive!Catalog}
3224 If this directive is specified, the counter and its values will be saved in
3225 the specified catalog. If this directive is not present, the counter will be
3226 redefined each time that Bacula is started.
3229 \section{Example Director Configuration File}
3230 \label{SampleDirectorConfiguration}
3231 \index[general]{File!Example Director Configuration}
3232 \index[general]{Example Director Configuration File}
3234 An example Director configuration file might be the following:
3239 # Default Bacula Director Configuration file
3241 # The only thing that MUST be changed is to add one or more
3242 # file or directory names in the Include directive of the
3245 # For Bacula release 1.15 (5 March 2002) -- redhat
3247 # You might also want to change the default email address
3248 # from root to your address. See the "mail" and "operator"
3249 # directives in the Messages resource.
3251 Director { # define myself
3253 QueryFile = "/home/kern/bacula/bin/query.sql"
3254 WorkingDirectory = "/home/kern/bacula/bin/working"
3255 PidDirectory = "/home/kern/bacula/bin/working"
3256 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3258 # Define the backup Job
3260 Name = "NightlySave"
3262 Level = Incremental # default
3265 Schedule = "WeeklyCycle"
3275 Where = /tmp/bacula-restores
3281 # List of files to be backed up
3285 Options { signature=SHA1}
3287 # Put your list of files here, one per line or include an
3288 # external list with:
3292 # Note: / backs up everything
3297 # When to do the backups
3299 Name = "WeeklyCycle"
3300 Run = level=Full sun at 2:05
3301 Run = level=Incremental mon-sat at 2:05
3303 # Client (File Services) to backup
3308 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3309 File Retention = 60d # sixty day file retention
3310 Job Retention = 1y # 1 year Job retention
3311 AutoPrune = yes # Auto apply retention periods
3313 # Definition of DLT tape storage device
3317 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3318 Device = "HP DLT 80" # same as Device in Storage daemon
3319 Media Type = DLT8000 # same as MediaType in Storage daemon
3321 # Definition for a DLT autochanger device
3325 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3326 Device = "Autochanger" # same as Device in Storage daemon
3327 Media Type = DLT-8000 # Different from DLTDrive
3330 # Definition of DDS tape storage device
3334 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3335 Device = SDT-10000 # same as Device in Storage daemon
3336 Media Type = DDS-4 # same as MediaType in Storage daemon
3338 # Definition of 8mm tape storage device
3342 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3343 Device = "Exabyte 8mm"
3346 # Definition of file storage device
3350 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3351 Device = FileStorage
3354 # Generic catalog service
3357 dbname = bacula; user = bacula; password = ""
3359 # Reasonable message delivery -- send most everything to
3360 # the email address and to the console
3363 mail = root@localhost = all, !skipped, !terminate
3364 operator = root@localhost = mount
3365 console = all, !skipped, !saved
3368 # Default pool definition
3376 # Restricted console used by tray-monitor to get the status of the director
3380 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3381 CommandACL = status, .status