4 \section*{Configuring the Director}
5 \label{_ChapterStart40}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
8 \addcontentsline{toc}{section}{Configuring the Director}
10 Of all the configuration files needed to run {\bf Bacula}, the Director's is
11 the most complicated, and the one that you will need to modify the most often
12 as you add clients or modify the FileSets.
14 For a general discussion of configuration files and resources including the
15 data types recognized by {\bf Bacula}. Please see the
16 \ilink{Configuration}{_ChapterStart16} chapter of this manual.
18 \subsection*{Director Resource Types}
19 \index[general]{Types!Director Resource}
20 \index[general]{Director Resource Types}
21 \addcontentsline{toc}{subsection}{Director Resource Types}
23 Director resource type may be one of the following:
25 Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
26 Messages. We present them here in the most logical order for defining them:
30 \ilink{Director}{DirectorResource4} -- to define the Director's
31 name and its access password used for authenticating the Console program.
32 Only a single Director resource definition may appear in the Director's
33 configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
34 machine, Bacula will generate a random password during the configuration
35 process, otherwise it will be left blank.
37 \ilink{Job}{JobResource} -- to define the backup/restore Jobs
38 and to tie together the Client, FileSet and Schedule resources to be used
41 \ilink{JobDefs}{JobDefsResource} -- optional resource for
42 providing defaults for Job resources.
44 \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
45 be automatically run by {\bf Bacula's} internal scheduler.
47 \ilink{FileSet}{FileSetResource} -- to define the set of files
48 to be backed up for each Client.
50 \ilink{Client}{ClientResource2} -- to define what Client is to be
53 \ilink{Storage}{StorageResource2} -- to define on what physical
54 device the Volumes should be mounted.
56 \ilink{Pool}{PoolResource} -- to define the pool of Volumes
57 that can be used for a particular Job.
59 \ilink{Catalog}{CatalogResource} -- to define in what database to
60 keep the list of files and the Volume names where they are backed up.
62 \ilink{Messages}{_ChapterStart15} -- to define where error and
63 information messages are to be sent or logged.
66 \subsection*{The Director Resource}
67 \label{DirectorResource4}
68 \index[general]{Director Resource}
69 \index[general]{Resource!Director}
70 \addcontentsline{toc}{subsection}{Director Resource}
72 The Director resource defines the attributes of the Directors running on the
73 network. In the current implementation, there is only a single Director
74 resource, but the final design will contain multiple Directors to maintain
75 index and media database redundancy.
81 Start of the Director resource. One and only one director resource must be
84 \item [Name = \lt{}name\gt{}]
86 The director name used by the system administrator. This directive is
89 \item [Description = \lt{}text\gt{}]
90 \index[dir]{Description }
91 The text field contains a description of the Director that will be displayed
92 in the graphical user interface. This directive is optional.
94 \item [Password = \lt{}UA-password\gt{}]
95 \index[dir]{Password }
96 Specifies the password that must be supplied for the default Bacula Console
97 to be authorized. The same password must appear in the {\bf Director}
98 resource of the Console configuration file. For added security, the password
99 is never actually passed across the network but rather a challenge response
100 hash code created with the password. This directive is required. If you have
101 either {\bf /dev/random} or {\bf bc} on your machine, Bacula will generate a
102 random password during the configuration process, otherwise it will be left
103 blank and you must manually supply it.
105 \item [Messages = \lt{}Messages-resource-name\gt{}]
106 \index[dir]{Messages }
107 The messages resource specifies where to deliver Director messages that are
108 not associated with a specific Job. Most messages are specific to a job and
109 will be directed to the Messages resource specified by the job. However,
110 there are a few messages that can occur when no job is running. This
111 directive is required.
113 \item [Working Directory = \lt{}Directory\gt{}]
114 \index[dir]{Working Directory }
115 This directive is mandatory and specifies a directory in which the Director
116 may put its status files. This directory should be used only by Bacula but
117 may be shared by other Bacula daemons. However, please note, if this
118 directory is shared with other Bacula daemons (the File daemon and Storage
119 daemon), you must ensure that the {\bf Name} given to each daemon is
120 unique so that the temporary filenames used do not collide. By default
121 the Bacula configure process creates unique daemon names by postfixing them
122 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
123 Directory} is done when the configuration file is read so that values such
124 as {\bf \$HOME} will be properly expanded. This directive is required.
126 \item [Pid Directory = \lt{}Directory\gt{}]
127 \index[dir]{Pid Directory }
128 This directive is mandatory and specifies a directory in which the Director
129 may put its process Id file. The process Id file is used to shutdown
130 Bacula and to prevent multiple copies of Bacula from running simultaneously.
131 Standard shell expansion of the {\bf Directory} is done when the
132 configuration file is read so that values such as {\bf \$HOME} will be
135 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
136 not installing Bacula in the system directories, you can use the {\bf Working
137 Directory} as defined above. This directive is required.
139 \item [Scripts Directory = \lt{}Directory\gt{}]
140 \index[dir]{Scripts Directory }
141 This directive is optional and, if defined, specifies a directory in
142 which the Director will look for the Python startup script {\bf
143 DirStartup.py}. This directory may be shared by other Bacula daemons.
144 Standard shell expansion of the directory is done when the configuration
145 file is read so that values such as {\bf \$HOME} will be properly
148 \item [QueryFile = \lt{}Path\gt{}]
149 \index[dir]{QueryFile }
150 This directive is mandatory and specifies a directory and file in which
151 the Director can find the canned SQL statements for the {\bf Query}
152 command of the Console. Standard shell expansion of the {\bf Path} is
153 done when the configuration file is read so that values such as {\bf
154 \$HOME} will be properly expanded. This directive is required.
156 \label{DirMaxConJobs}
157 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
158 \index[dir]{Maximum Concurrent Jobs }
159 \index[general]{Simultaneous Jobs}
160 \index[general]{Concurrent Jobs}
161 where \lt{}number\gt{} is the maximum number of total Director Jobs that
162 should run concurrently. The default is set to 1, but you may set it to a
165 Please note that the Volume format becomes much more complicated with
166 multiple simultaneous jobs, consequently, restores can take much longer if
167 Bacula must sort through interleaved volume blocks from multiple simultaneous
168 jobs. This can be avoided by having each simultaneously running job write to
169 a different volume or by using data spooling, which will first spool the data
170 to disk simultaneously, then write each spool file to the volume in
173 There may also still be some cases where directives such as {\bf Maximum
174 Volume Jobs} are not properly synchronized with multiple simultaneous jobs
175 (subtle timing issues can arise), so careful testing is recommended.
177 At the current time, there is no configuration parameter set to limit the
178 number of console connections. A maximum of five simultaneous console
179 connections are permitted.
181 For more details on getting concurrent jobs to run, please see
182 \ilink{Running Concurrent Jobs}{ConcurrentJobs} in the Tips chapter
185 \item [FD Connect Timeout = \lt{}time\gt{}]
186 \index[dir]{FD Connect Timeout }
187 where {\bf time} is the time that the Director should continue
188 attempting to contact the File daemon to start a job, and after which
189 the Director will cancel the job. The default is 30 minutes.
191 \item [SD Connect Timeout = \lt{}time\gt{}]
192 \index[dir]{SD Connect Timeout }
193 where {\bf time} is the time that the Director should continue
194 attempting to contact the Storage daemon to start a job, and after which
195 the Director will cancel the job. The default is 30 minutes.
197 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
198 \index[dir]{DirAddresses }
199 Specify the ports and addresses on which the Director daemon will listen
200 for Bacula Console connections. Probably the simplest way to explain
201 this is to show an example:
205 DirAddresses = { ip = {
206 addr = 1.2.3.4; port = 1205;}
208 addr = 1.2.3.4; port = http;}
221 addr = 201:220:222::2
224 addr = bluedot.thun.net
230 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
231 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
232 a symbolic name (only in the ip specification). Also, port can be specified
233 as a number or as the mnemonic value from the /etc/services file. If a port
234 is not specified, the default will be used. If an ip section is specified,
235 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
236 only IPv4 resolutions will be permitted, and likewise with ip6.
238 \item [DIRport = \lt{}port-number\gt{}]
239 \index[dir]{DIRport }
240 Specify the port (a positive integer) on which the Director daemon will
241 listen for Bacula Console connections. This same port number must be
242 specified in the Director resource of the Console configuration file. The
243 default is 9101, so normally this directive need not be specified. This
244 directive is not needed if you specify DirAddresses.
246 \item [DirAddress = \lt{}IP-Address\gt{}]
247 \index[dir]{DirAddress }
248 This directive is optional, but if it is specified, it will cause the
249 Director server (for the Console program) to bind to the specified {\bf
250 IP-Address}, which is either a domain name or an IP address specified as a
251 dotted quadruple in string or quoted string format. If this directive is not
252 specified, the Director will bind to any available address (the default).
253 Note, unlike the DirAddresses specification noted above, this directive only
254 permits a single address to be specified. This directive is not needed if you
255 specify a DirAddresses (not plural).
258 The following is an example of a valid Director resource definition:
264 WorkingDirectory = "$HOME/bacula/bin/working"
265 Password = UA_password
266 PidDirectory = "$HOME/bacula/bin/working"
267 QueryFile = "$HOME/bacula/bin/query.sql"
273 \subsection*{The Job Resource}
275 \index[general]{Resource!Job}
276 \index[general]{Job Resource}
277 \addcontentsline{toc}{subsection}{Job Resource}
279 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
280 perform. Each Job resource definition contains the name of a Client and
281 a FileSet to backup, the Schedule for the Job, where the data
282 are to be stored, and what media Pool can be used. In effect, each Job
283 resource must specify What, Where, How, and When or FileSet, Storage,
284 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
285 be specified for a restore job for historical reasons, but it is no longer used.
287 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
288 job. If you want to backup multiple FileSets on the same Client or multiple
289 Clients, you must define a Job for each one.
295 Start of the Job resource. At least one Job resource is required.
297 \item [Name = \lt{}name\gt{}]
299 The Job name. This name can be specified on the {\bf Run} command in the
300 console program to start a job. If the name contains spaces, it must be
301 specified between quotes. It is generally a good idea to give your job the
302 same name as the Client that it will backup. This permits easy
303 identification of jobs.
305 When the job actually runs, the unique Job Name will consist of the name you
306 specify here followed by the date and time the job was scheduled for
307 execution. This directive is required.
309 \item [Type = \lt{}job-type\gt{}]
311 The {\bf Type} directive specifies the Job type, which may be one of the
312 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
313 directive is required. Within a particular Job Type, there are also Levels
314 as discussed in the next item.
320 Run a backup Job. Normally you will have at least one Backup job for each
321 client you want to save. Normally, unless you turn off cataloging, most all
322 the important statistics and data concerning files backed up will be placed
327 Run a restore Job. Normally, you will specify only one Restore job which
329 as a sort of prototype that you will modify using the console program in
330 order to perform restores. Although certain basic information from a Restore
331 job is saved in the catalog, it is very minimal compared to the information
332 stored for a Backup job -- for example, no File database entries are
333 generated since no Files are saved.
337 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
338 contents of the catalog to the file system, or to what was backed up. In
339 addition, to verifying that a tape that was written can be read, you can
340 also use {\bf verify} as a sort of tripwire intrusion detection.
344 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
345 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
346 Although an Admin job is recorded in the catalog, very little data is saved.
351 \item [Level = \lt{}job-level\gt{}]
353 The Level directive specifies the default Job level to be run. Each
355 Job Type (Backup, Restore, ...) has a different set of Levels that can be
356 specified. The Level is normally overridden by a different value that is
357 specified in the {\bf Schedule} resource. This directive is not required, but
358 must be specified either by a {\bf Level} directive or as an override
359 specified in the {\bf Schedule} resource.
361 For a {\bf Backup} Job, the Level may be one of the following:
367 is all files in the FileSet whether or not they have changed.
370 \index[dir]{Incremental}
371 is all files specified in the FileSet that have changed since the last successful backup of the
372 the same Job using the same FileSet and Client.
373 If the Director cannot find a previous valid Full backup then
374 the job will be upgraded into a Full backup. When the Director looks for a
375 valid backup record in the catalog database, it looks for a previous
379 \item The same Job name.
380 \item The same Client name.
381 \item The same FileSet (any change to the definition of the FileSet such as
382 adding or deleting a file in the Include or Exclude sections constitutes a
384 \item The Job was a Full, Differential, or Incremental backup.
385 \item The Job terminated normally (i.e. did not fail or was not canceled).
388 If all the above conditions do not hold, the Director will upgrade the
389 Incremental to a Full save. Otherwise, the Incremental backup will be
390 performed as requested.
392 The File daemon (Client) decides which files to backup for an Incremental
393 backup by comparing start time of the prior Job (Full, Differential, or
394 Incremental) against the time each file was last "modified" (st\_mtime) and
395 the time its attributes were last "changed"(st\_ctime). If the file was
396 modified or its attributes changed on or after this start time, it will then
399 Please note that some virus scanning software may change st\_ctime while
400 doing the scan. For example, if the virus scanning program attempts to
401 reset the access time (st\_atime), which Bacula does not use, it will cause
402 st\_ctime to change and hence Bacula will backup the file during an
403 Incremental or Differential backup. In the case of Sophos virus scanning, you
404 can prevent it from resetting the access time (st\_atime) and hence changing
405 st\_ctime by using the {\bf \verb:--:no-reset-atime} option. For other
407 please see their manual.
409 When Bacula does an Incremental backup, all modified files that are still on
410 the system are backed up. However, any file that has been deleted since the
411 last Full backup remains in the Bacula catalog, which means that if between
412 a Full save and the time you do a restore, some files are deleted, those
413 deleted files will also be restored. The deleted files will no longer appear
414 in the catalog after doing another Full save. However, to remove deleted
415 files from the catalog during an Incremental backup is quite a time consuming
416 process and not currently implemented in Bacula.
418 In addition, if you move a directory rather than copy it, the files in it do not
419 have their modification time (st\_mtime) or their attribute change time
421 changed. As a consequence, those files will probably not be backed up by an
423 or Differential backup which depend solely on these time stamps. If you move a
425 and wish it to be properly backed up, it is generally preferable to copy it,
430 \index[dir]{Differential}
431 is all files specified in the FileSet that have changed since the last
432 successful Full backup of the same Job. If the Director cannot find a
433 valid previous Full backup for the same Job, FileSet, and Client,
434 backup, then the Differential job will be upgraded into a Full backup.
435 When the Director looks for a valid Full backup record in the catalog
436 database, it looks for a previous Job with:
439 \item The same Job name.
440 \item The same Client name.
441 \item The same FileSet (any change to the definition of the FileSet such as
442 adding or deleting a file in the Include or Exclude sections constitutes a
444 \item The Job was a FULL backup.
445 \item The Job terminated normally (i.e. did not fail or was not canceled).
448 If all the above conditions do not hold, the Director will upgrade the
449 Differential to a Full save. Otherwise, the Differential backup will be
450 performed as requested.
452 The File daemon (Client) decides which files to backup for a differential
453 backup by comparing the start time of the prior Full backup Job against the
454 time each file was last "modified" (st\_mtime) and the time its attributes
455 were last "changed" (st\_ctime). If the file was modified or its attributes
456 were changed on or after this start time, it will then be backed up. The
457 start time used is displayed after the {\bf Since} on the Job report. In rare
458 cases, using the start time of the prior backup may cause some files to be
459 backed up twice, but it ensures that no change is missed. As with the
460 Incremental option, you should ensure that the clocks on your server and
461 client are synchronized or as close as possible to avoid the possibility of a
462 file being skipped. Note, on versions 1.33 or greater Bacula automatically
463 makes the necessary adjustments to the time between the server and the client
464 so that the times Bacula uses are synchronized.
466 When Bacula does a Differential backup, all modified files that are still
467 on the system are backed up. However, any file that has been deleted since
468 the last Full backup remains in the Bacula catalog, which means that if
469 between a Full save and the time you do a restore, some files are deleted,
470 those deleted files will also be restored. The deleted files will no
471 longer appear in the catalog after doing another Full save. However, to
472 remove deleted files from the catalog during a Differential backup is quite
473 a time consuming process and not currently implemented in Bacula. It is,
474 however, a planned future feature.
477 As noted above, if you move a directory rather than copy it, the
478 files in it do not have their modification time (st\_mtime) or
479 their attribute change time (st\_ctime) changed. As a
480 consequence, those files will probably not be backed up by an
481 Incremental or Differential backup which depend solely on these
482 time stamps. If you move a directory, and wish it to be
483 properly backed up, it is generally preferable to copy it, then
484 delete the original. Alternatively, you can move the directory, then
485 use the {\bf touch} program to update the timestamps.
487 Every once and a while, someone asks why we need Differential
488 backups as long as Incremental backups pickup all changed files.
489 There are possibly many answers to this question, but the one
490 that is the most important for me is that it effectively combines
491 all the Incremental and Differential backups since the last Full
492 backup into a single Differential backup. This has two effects:
493 1. It gives some redundancy. 2. More importantly, it reduces the
494 number of Volumes that are needed to do a restore effectively
495 eliminating the need to read all the volumes on which the
496 preceding Incremental and Differential backups since the last
502 For a {\bf Restore} Job, no level needs to be specified.
504 For a {\bf Verify} Job, the Level may be one of the following:
509 \index[dir]{InitCatalog}
510 does a scan of the specified {\bf FileSet} and stores the file
511 attributes in the Catalog database. Since no file data is saved, you
512 might ask why you would want to do this. It turns out to be a very
513 simple and easy way to have a {\bf Tripwire} like feature using {\bf
514 Bacula}. In other words, it allows you to save the state of a set of
515 files defined by the {\bf FileSet} and later check to see if those files
516 have been modified or deleted and if any new files have been added.
517 This can be used to detect system intrusion. Typically you would
518 specify a {\bf FileSet} that contains the set of system files that
519 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
520 run the {\bf InitCatalog} level verify one time when your system is
521 first setup, and then once again after each modification (upgrade) to
522 your system. Thereafter, when your want to check the state of your
523 system files, you use a {\bf Verify} {\bf level = Catalog}. This
524 compares the results of your {\bf InitCatalog} with the current state of
529 Compares the current state of the files against the state previously
530 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
531 items reported are determined by the {\bf verify} options specified on
532 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
533 FileSet} resource below for more details). Typically this command will
534 be run once a day (or night) to check for any changes to your system
537 Please note! If you run two Verify Catalog jobs on the same client at
538 the same time, the results will certainly be incorrect. This is because
539 Verify Catalog modifies the Catalog database while running in order to
542 \item [VolumeToCatalog]
543 \index[dir]{VolumeToCatalog}
544 This level causes Bacula to read the file attribute data written to the
545 Volume from the last Job. The file attribute data are compared to the values
546 saved in the Catalog database and any differences are reported. This is
547 similar to the {\bf Catalog} level except that instead of comparing the disk
548 file attributes to the catalog database, the attribute data written to the
549 Volume is read and compared to the catalog database. Although the attribute
550 data including the signatures (MD5 or SHA1) are compared, the actual file data
551 is not compared (it is not in the catalog).
553 Please note! If you run two Verify VolumeToCatalog jobs on the same client at
554 the same time, the results will certainly be incorrect. This is because the
555 Verify VolumeToCatalog modifies the Catalog database while running.
557 \item [DiskToCatalog]
558 \index[dir]{DiskToCatalog}
559 This level causes Bacula to read the files as they currently are on disk,
561 to compare the current file attributes with the attributes saved in the
562 catalog from the last backup for the job specified on the {\bf VerifyJob}
563 directive. This level differs from the {\bf Catalog} level described above by
564 the fact that it doesn't compare against a previous Verify job but against a
565 previous backup. When you run this level, you must supply the verify options
566 on your Include statements. Those options determine what attribute fields are
569 This command can be very useful if you have disk problems because it will
570 compare the current state of your disk against the last successful backup,
571 which may be several jobs.
573 Note, the current implementation (1.32c) does not identify files that have
577 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
578 \index[dir]{Verify Job }
579 If you run a verify job without this directive, the last job run will be
580 compared with the catalog, which means that you must immediately follow a
581 backup by a verify command. If you specify a {\bf Verify Job} Bacula will
582 find the last job with that name that ran. This permits you to run all your
583 backups, then run Verify jobs on those that you wish to be verified (most
584 often a {\bf VolumeToCatalog}) so that the tape just written is re-read.
586 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
587 \index[dir]{JobDefs }
588 If a JobDefs-Resource-Name is specified, all the values contained in the
589 named JobDefs resource will be used as the defaults for the current Job. Any
590 value that you explicitly define in the current Job resource, will override
591 any defaults specified in the JobDefs resource. The use of this directive
592 permits writing much more compact Job resources where the bulk of the
593 directives are defined in one or more JobDefs. This is particularly useful if
594 you have many similar Jobs but with minor variations such as different
595 Clients. A simple example of the use of JobDefs is provided in the default
596 bacula-dir.conf file.
598 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
599 \index[dir]{Bootstrap }
600 The Bootstrap directive specifies a bootstrap file that, if provided, will
601 be used during {\bf Restore} Jobs and is ignored in other Job types. The {\bf
602 bootstrap} file contains the list of tapes to be used in a restore Job as
603 well as which files are to be restored. Specification of this directive is
604 optional, and if specified, it is used only for a restore job. In addition,
605 when running a Restore job from the console, this value can be changed.
607 If you use the {\bf Restore} command in the Console program, to start a
608 restore job, the {\bf bootstrap} file will be created automatically from the
609 files you select to be restored.
611 For additional details of the {\bf bootstrap} file, please see
612 \ilink{Restoring Files with the Bootstrap File}{_ChapterStart43}
613 chapter of this manual.
615 \label{writebootstrap}
616 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
618 The {\bf writebootstrap} directive specifies a file name where Bacula will
619 write a {\bf bootstrap} file for each Backup job run. Thus this directive
620 applies only to Backup Jobs. If the Backup job is a Full save, Bacula will
621 erase any current contents of the specified file before writing the bootstrap
622 records. If the Job is an Incremental save, Bacula will append the current
623 bootstrap record to the end of the file.
625 Using this feature, permits you to constantly have a bootstrap file that can
626 recover the current state of your system. Normally, the file specified should
627 be a mounted drive on another machine, so that if your hard disk is lost,
628 you will immediately have a bootstrap record available. Alternatively, you
629 should copy the bootstrap file to another machine after it is updated.
631 If the {\bf bootstrap-file-specification} begins with a vertical bar (|),
632 Bacula will use the specification as the name of a program to which it will
633 pipe the bootstrap record. It could for example be a shell script that emails
634 you the bootstrap record.
636 For more details on using this file, please see the chapter entitled
637 \ilink{The Bootstrap File}{_ChapterStart43} of this manual.
639 \item [Client = \lt{}client-resource-name\gt{}]
641 The Client directive specifies the Client (File daemon) that will be used in
642 the current Job. Only a single Client may be specified in any one Job. The
643 Client runs on the machine to be backed up, and sends the requested files to
644 the Storage daemon for backup, or receives them when restoring. For
645 additional details, see the
646 \ilink{Client Resource section}{ClientResource2} of this chapter.
647 This directive is required.
649 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
650 \index[dir]{FileSet }
651 The FileSet directive specifies the FileSet that will be used in the
653 Job. The FileSet specifies which directories (or files) are to be backed up,
654 and what options to use (e.g. compression, ...). Only a single FileSet
655 resource may be specified in any one Job. For additional details, see the
656 \ilink{FileSet Resource section}{FileSetResource} of this
657 chapter. This directive is required.
659 \item [Messages = \lt{}messages-resource-name\gt{}]
660 \index[dir]{Messages }
661 The Messages directive defines what Messages resource should be used for
663 job, and thus how and where the various messages are to be delivered. For
664 example, you can direct some messages to a log file, and others can be sent
665 by email. For additional details, see the
666 \ilink{Messages Resource}{_ChapterStart15} Chapter of this
667 manual. This directive is required.
669 \item [Pool = \lt{}pool-resource-name\gt{}]
671 The Pool directive defines the pool of Volumes where your data can be backed
672 up. Many Bacula installations will use only the {\bf Default} pool. However,
673 if you want to specify a different set of Volumes for different Clients or
674 different Jobs, you will probably want to use Pools. For additional details,
676 \ilink{Pool Resource section}{PoolResource} of this chapter. This
677 directive is required.
679 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
680 \index[dir]{Full Backup Pool }
681 The {\it Full Backup Pool} specifies a Pool to be used for Full backups. It
682 will override any Pool specification during a Full backup. This directive is
685 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
686 \index[dir]{Differential Backup Pool }
687 The {\it Differential Backup Pool} specifies a Pool to be used for
688 Differential backups. It will override any Pool specification during a
689 Differential backup. This directive is optional.
691 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
692 \index[dir]{Incremental Backup Pool }
693 The {\it Incremental Backup Pool} specifies a Pool to be used for
695 backups. It will override any Pool specification during an Incremental
697 This directive is optional.
699 \item [Schedule = \lt{}schedule-name\gt{}]
700 \index[dir]{Schedule }
701 The Schedule directive defines what schedule is to be used for the Job.
702 The schedule in turn determines when the Job will be automatically
703 started and what Job level (i.e. Full, Incremental, ...) is to be run.
704 This directive is optional, and if left out, the Job can only be started
705 manually using the Console program. Although you may specify only a
706 single Schedule resource for any one job, the Schedule resource may
707 contain multiple {\bf Run} directives, which allow you to run the Job at
708 many different times, and each {\bf run} directive permits overriding
709 the default Job Level Pool, Storage, and Messages resources. This gives
710 considerable flexibility in what can be done with a single Job. For
711 additional details, see the \ilink{Schedule Resource
712 Chapter}{ScheduleResource} of this manual.
715 \item [Storage = \lt{}storage-resource-name\gt{}]
716 \index[dir]{Storage }
717 The Storage directive defines the name of the storage services where you
719 to backup the FileSet data. For additional details, see the
720 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
721 This directive is required.
723 \item [Max Start Delay = \lt{}time\gt{}]
724 \index[dir]{Max Start Delay }
725 The time specifies the maximum delay between the scheduled time and the
726 actual start time for the Job. For example, a job can be scheduled to
727 run at 1:00am, but because other jobs are running, it may wait to run.
728 If the delay is set to 3600 (one hour) and the job has not begun to run
729 by 2:00am, the job will be canceled. This can be useful, for example,
730 to prevent jobs from running during day time hours. The default is 0
731 which indicates no limit.
733 \item [Max Run Time = \lt{}time\gt{}]
734 \index[dir]{Max Run Time }
735 The time specifies the maximum allowed time that a job may run, counted
736 from when the job starts, ({\bf not} necessarily the same as when the
737 job was scheduled). This directive is implemented in version 1.33 and
740 \item [Max Wait Time = \lt{}time\gt{}]
741 \index[dir]{Max Wait Time }
742 The time specifies the maximum allowed time that a job may block waiting
743 for a resource (such as waiting for a tape to be mounted, or waiting for
744 the storage or file daemons to perform their duties), counted from the
745 when the job starts, ({\bf not} necessarily the same as when the job was
746 scheduled). This directive is implemented only in version 1.33 and
751 \item [Incremental Max Wait Time = \lt{}time\gt{}]
752 \index[dir]{Incremental Max Wait Time }
753 The time specifies the maximum allowed time that an Incremental backup
754 job may block waiting for a resource (such as waiting for a tape to be
755 mounted, or waiting for the storage or file daemons to perform their
756 duties), counted from the when the job starts, ({\bf not} necessarily
757 the same as when the job was scheduled). Please note that if there is a
758 {\bf Max Wait Time} it may also be applied to the job.
760 \item [Differential Max Wait Time = \lt{}time\gt{}]
761 \index[dir]{Differential Max Wait Time }
762 The time specifies the maximum allowed time that a Differential backup
763 job may block waiting for a resource (such as waiting for a tape to be
764 mounted, or waiting for the storage or file daemons to perform their
765 duties), counted from the when the job starts, ({\bf not} necessarily
766 the same as when the job was scheduled). Please note that if there is a
767 {\bf Max Wait Time} it may also be applied to the job.
769 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
770 \index[dir]{Prefer Mounted Volumes}
771 It the Prefer Mounted Volumes directive is set to {\bf yes}
772 (default yes), it is used to inform the Storage daemon
773 to select either an Autochanger or a drive with a valid
774 Volume already mounted in preference to a drive that is
775 not ready. If none is available, it will select the first
776 available drive. If the directive is set to {\bf no}, the
777 Storage daemon will prefer finding an unused drive. This
778 can potentially be useful for those sites that prefer to
779 maximum backup throughput at the expense of using additional
783 \item [Prune Jobs = \lt{}yes|no\gt{}]
784 \index[dir]{Prune Jobs }
785 Normally, pruning of Jobs from the Catalog is specified on a Client by
786 Client basis in the Client resource with the {\bf AutoPrune} directive.
787 If this directive is specified (not normally) and the value is {\bf
788 yes}, it will override the value specified in the Client resource. The
792 \item [Prune Files = \lt{}yes|no\gt{}]
793 \index[dir]{Prune Files }
794 Normally, pruning of Files from the Catalog is specified on a Client by
795 Client basis in the Client resource with the {\bf AutoPrune} directive.
796 If this directive is specified (not normally) and the value is {\bf
797 yes}, it will override the value specified in the Client resource. The
800 \item [Prune Volumes = \lt{}yes|no\gt{}]
801 \index[dir]{Prune Volumes }
802 Normally, pruning of Volumes from the Catalog is specified on a Client
803 by Client basis in the Client resource with the {\bf AutoPrune}
804 directive. If this directive is specified (not normally) and the value
805 is {\bf yes}, it will override the value specified in the Client
806 resource. The default is {\bf no}.
808 \item [Run Before Job = \lt{}command\gt{}]
809 \index[dir]{Run Before Job }
810 The specified {\bf command} is run as an external program prior to
811 running the current Job. Any output sent by the command to standard output
812 will be included in the Bacula job report. The command string must be a
813 valid program name or name of a shell script. This directive is not
814 required, but if it is defined, and if the exit code of the program run
815 is non-zero, the current Bacula job will be canceled. In addition, the
816 command string is parsed then fed to the execvp() function, which means
817 that the path will be searched to execute your specified command, but
818 there is no shell interpretation, as a consequence, if you invoke
819 complicated commands or want any shell features such as redirection or
820 piping, you must call a shell script and do it inside that script.
822 Before submitting the specified command to the operating system, Bacula
823 performs character substitution of the following characters:
841 The Job Exit Status code \%e edits the following values:
843 \index[dir]{Exit Status}
850 \item Unknown term code
853 Thus if you edit it on a command line, you will need to enclose
854 it within some sort of quotes.
856 Bacula checks the exit status of the RunBeforeJob program. If it is
857 non-zero, the job will be error terminated. Lutz Kittler has pointed
858 out that using the RunBeforJob directive can be a simple way to modify
859 your schedules during a holiday. For example, suppose that you normally
860 do Full backups on Fridays, but Thursday and Friday are holidays. To
861 avoid having to change tapes between Thursday and Friday when no one is
862 in the office, you can create a RunBeforeJob that returns a non-zero
863 status on Thursday and zero on all other days. That way, the Thursday
864 job will not run, and on Friday the tape you inserted on Wednesday
865 before leaving will be used.
867 \item [Run After Job = \lt{}command\gt{}]
868 \index[dir]{Run After Job }
869 The specified {\bf command} is run as an external program after the
870 current job terminates. This directive is not required. The command
871 string must be a valid program name or name of a shell script. If the
872 exit code of the program run is non-zero, the current Bacula job will
873 terminate in error. Before submitting the specified command to the
874 operating system, Bacula performs character substitution as described
875 above for the {\bf Run Before Job} directive.
877 An example of the use of this directive is given in the
878 \ilink{Tips Chapter}{JobNotification} of this manual. As of version
879 1.30, Bacula checks the exit status of the RunAfter program. If it is
880 non-zero, the job will be terminated in error.
882 \item [Client Run Before Job = \lt{}command\gt{}]
883 \index[dir]{Client Run Before Job }
884 This directive is the same as {\bf Run Before Job} except that the program is run on
885 the client machine. The same restrictions apply to Unix systems as noted
886 above for the {\bf Run Before Job}. In addition, for a Windows client on
887 version 1.33 and above, please take careful note that you must ensure a
888 correct path to your script. The script or program can be a .com, .exe or
889 a .bat file. However, if you specify a path, you must also specify the full
890 extension. Unix like commands will not work unless you have installed and
891 properly configured Cygwin in addition to and separately from Bacula.
893 {\bf Special Windows Considerations}
894 The command can be anything that cmd.exe or command.com will recognize as an
895 executable file. Specifying the executable's extension is optional, unless
896 there is an ambiguity. (i.e. ls.bat, ls.exe)
898 The System \%Path\% will be searched for the command. (under the environment
899 variable dialog you have have both System Environment and User Environment,
900 we believe that only the System environment will be available to bacula-fd,
901 if it is running as a service.)
903 System environment variables can be referenced with \%var\% and
904 used as either part of the command name or arguments.
906 When specifying a full path to an executable if the path or executable name
907 contains whitespace or special characters they will need to be quoted.
908 Arguments containing whitespace or special characters will also have to be
913 ClientRunBeforeJob = "\"C:/Program Files/Software
914 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
918 The special characters \&()[]\{\}\^{}=;!'+,`\~{} will need to be quoted if
919 they are part of a filename or argument.
921 If someone is logged in, a blank "command" window running the commands
923 be present during the execution of the command.
925 Some Suggestions from Phil Stracchino for running on Win32 machines with the
926 native Win32 File daemon:
929 \item You might want the ClientRunBeforeJob directive to specify a .bat file
930 which runs the actual client-side commands, rather than trying to run
932 example) regedit /e directly.
933 \item The batch file should explicitly 'exit 0' on successful completion.
934 \item The path to the batch file should be specified in Unix form:
936 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
938 rather than DOS/Windows form:
942 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
946 The following example of the use of the Client Run Before Job directive was
947 submitted by a user:\\
948 You could write a shell script to back up a DB2 database to a FIFO. The shell
958 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
963 The following line in the Job resource in the bacula-dir.conf file:
966 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
970 When the job is run, you will get messages from the output of the script
972 that the backup has started. Even though the command being run is
973 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
975 thus the backup stalls.
977 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
982 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
987 It is important to redirect the input and outputs of a backgrounded command to
988 /dev/null to prevent the script from blocking.
991 \item [Client Run After Job = \lt{}command\gt{}]
992 \index[dir]{Client Run After Job }
993 This directive is the same as {\bf Run After Job} except that it is run on
995 client machine. Note, please see the notes above in {\bf Client Run Before
996 Job} concerning Windows clients.
998 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
999 \index[dir]{Rerun Failed Levels }
1000 If this directive is set to {\bf yes} (default no), and Bacula detects that
1002 previous job at a higher level (i.e. Full or Differential) has failed, the
1003 current job level will be upgraded to the higher level. This is particularly
1004 useful for Laptops where they may often be unreachable, and if a prior Full
1005 save has failed, you wish the very next backup to be a Full save rather
1007 whatever level it is started as.
1009 \item [Spool Data = \lt{}yes|no\gt{}]
1010 \index[dir]{Spool Data }
1011 If this directive is set to {\bf yes} (default no), the Storage daemon will
1012 be requested to spool the data for this Job to disk rather than write it
1013 directly to tape. Once all the data arrives or the spool files' maximum sizes
1014 are reached, the data will be despooled and written to tape. When this
1015 directive is set to yes, the Spool Attributes is also automatically set to
1016 yes. Spooling data prevents tape shoe-shine (start and stop) during
1017 Incremental saves. This option should not be used if you are writing to a
1020 \item [Spool Attributes = \lt{}yes|no\gt{}]
1021 \index[dir]{Spool Attributes }
1022 The default is set to {\bf no}, which means that the File attributes are
1024 by the Storage daemon to the Director as they are stored on tape. However,
1025 if you want to avoid the possibility that database updates will slow down
1026 writing to the tape, you may want to set the value to {\bf yes}, in which
1027 case the Storage daemon will buffer the File attributes and Storage
1028 coordinates to a temporary file in the Working Directory, then when writing
1029 the Job data to the tape is completed, the attributes and storage coordinates
1030 will be sent to the Director.
1032 \item [Where = \lt{}directory\gt{}]
1034 This directive applies only to a Restore job and specifies a prefix to the
1035 directory name of all files being restored. This permits files to be restored
1036 in a different location from which they were saved. If {\bf Where} is not
1037 specified or is set to backslash ({\bf /}), the files will be restored to
1038 their original location. By default, we have set {\bf Where} in the example
1039 configuration files to be {\bf /tmp/bacula-restores}. This is to prevent
1040 accidental overwriting of your files.
1042 \item [Replace = \lt{}replace-option\gt{}]
1043 \index[dir]{Replace }
1044 This directive applies only to a Restore job and specifies what happens when
1045 Bacula wants to restore a file or directory that already exists. You have the
1046 following options for {\bf replace-option}:
1052 when the file to be restored already exists, it is deleted and then replaced
1054 the copy that was backed up.
1057 \index[dir]{ifnewer}
1058 if the backed up file (on tape) is newer than the existing file, the existing
1059 file is deleted and replaced by the back up.
1062 \index[dir]{ifolder}
1063 if the backed up file (on tape) is older than the existing file, the existing
1064 file is deleted and replaced by the back up.
1068 if the backed up file already exists, Bacula skips restoring this file.
1071 \item [Prefix Links=\lt{}yes|no\gt{}]
1072 \index[dir]{Prefix Links}
1073 If a {\bf Where} path prefix is specified for a recovery job, apply it
1074 to absolute links as well. The default is {\bf No}. When set to {\bf
1075 Yes} then while restoring files to an alternate directory, any absolute
1076 soft links will also be modified to point to the new alternate
1077 directory. Normally this is what is desired -- i.e. everything is self
1078 consistent. However, if you wish to later move the files to their
1079 original locations, all files linked with absolute names will be broken.
1081 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1082 \index[dir]{Maximum Concurrent Jobs }
1083 where \lt{}number\gt{} is the maximum number of Jobs from the current
1084 Job resource that can run concurrently. Note, this directive limits
1085 only Jobs with the same name as the resource in which it appears. Any
1086 other restrictions on the maximum concurrent jobs such as in the
1087 Director, Client, or Storage resources will also apply in addition to
1088 the limit specified here. The default is set to 1, but you may set it
1089 to a larger number. We strongly recommend that you read the WARNING
1090 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1091 Director's resource.
1093 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1094 \index[dir]{Reschedule On Error }
1095 If this directive is enabled, and the job terminates in error, the job
1096 will be rescheduled as determined by the {\bf Reschedule Interval} and
1097 {\bf Reschedule Times} directives. If you cancel the job, it will not
1098 be rescheduled. The default is {\bf no} (i.e. the job will not be
1102 This specification can be useful for portables, laptops, or other
1103 machines that are not always connected to the network or switched on.
1105 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1106 \index[dir]{Reschedule Interval }
1107 If you have specified {\bf Reschedule On Error = yes} and the job
1108 terminates in error, it will be rescheduled after the interval of time
1109 specified by {\bf time-specification}. See \ilink{the time
1110 specification formats}{Time} in the Configure chapter for details of
1111 time specifications. If no interval is specified, the job will not be
1112 rescheduled on error.
1114 \item [Reschedule Times = \lt{}count\gt{}]
1115 \index[dir]{Reschedule Times }
1116 This directive specifies the maximum number of times to reschedule the
1117 job. If it is set to zero (the default) the job will be rescheduled an
1118 indefinite number of times.
1120 \item [Run = \lt{}job-name\gt{}]
1121 \index[dir]{Run directive}
1122 \index[dir]{Clone a Job}
1123 The Run directive (not to be confused with the Run option in a
1124 Schedule) allows you to start other jobs or to clone jobs. By using the
1125 cloning keywords (see below), you can backup
1126 the same data (or almost the same data) to two or more drives
1127 at the same time. The {\bf job-name} is normally the same name
1128 as the current Job resource (thus creating a clone). However, it
1129 may be any Job name, so one job may start other related jobs.
1131 The part after the equal sign must be enclosed in double quotes,
1132 and can contain any string or set of options (overrides) that you
1133 can specify when entering the Run command from the console. For
1134 example {\bf storage=DDS-4 ...}. In addition, there are two special
1135 keywords that permit you to clone the current job. They are {\bf level=\%l}
1136 and {\bf since=\%s}. The \%l in the level keyword permits
1137 entering the actual level of the current job and the \%s in the since
1138 keyword permits putting the same time for comparison as used on the
1139 current job. Note, in the case of the since keyword, the \%s must be
1140 enclosed in double quotes, and thus they must be preceded by a backslash
1141 since they are already inside quotes. For example:
1144 run = "Nightly-backup level=%s since=\"%s\" storage=DDS-4"
1148 A cloned job will not start additional clones, so it is not
1149 possible to recurse.
1154 \item [Priority = \lt{}number\gt{}]
1155 \index[dir]{Priority }
1156 This directive permits you to control the order in which your jobs run
1157 by specifying a positive non-zero number. The higher the number, the
1158 lower the job priority. Assuming you are not running concurrent jobs,
1159 all queued jobs of priority 1 will run before queued jobs of priority 2
1160 and so on, regardless of the original scheduling order.
1162 The priority only affects waiting jobs that are queued to run, not jobs
1163 that are already running. If one or more jobs of priority 2 are already
1164 running, and a new job is scheduled with priority 1, the currently
1165 running priority 2 jobs must complete before the priority 1 job is run.
1167 The default priority is 10.
1169 If you want to run concurrent jobs, which is not recommended, you should
1171 these points in mind:
1174 \item To run concurrent jobs, you must set Maximum Concurrent Jobs = 2 in 5
1175 or 6 distinct places: in bacula-dir.conf in the Director, the Job, the
1176 Client, the Storage resources; in bacula-fd in the FileDaemon (or Client)
1177 resource, and in bacula-sd.conf in the Storage resource. If any one is
1178 missing, it will throttle the jobs to one at a time.
1179 \item Bacula concurrently runs jobs of only one priority at a time. It will
1180 not simultaneously run a priority 1 and a priority 2 job.
1181 \item If Bacula is running a priority 2 job and a new priority 1 job is
1182 scheduled, it will wait until the running priority 2 job terminates even if
1183 the Maximum Concurrent Jobs settings would otherwise allow two jobs to run
1185 \item Suppose that bacula is running a priority 2 job and a new priority 1 job
1186 is scheduled and queued waiting for the running priority 2 job to terminate.
1187 If you then start a second priority 2 job, the waiting priority 1 job will
1188 prevent the new priority 2 job from running concurrently with the running
1189 priority 2 job. That is: as long as there is a higher priority job waiting
1191 run, no new lower priority jobs will start even if the Maximum Concurrent
1192 Jobs settings would normally allow them to run. This ensures that higher
1193 priority jobs will be run as soon as possible.
1196 If you have several jobs of different priority, it may not best to start
1197 them at exactly the same time, because Bacula must examine them one at a
1198 time. If by Bacula starts a lower priority job first, then it will run
1199 before your high priority jobs. If you experience this problem, you may
1200 avoid it by starting any higher priority jobs a few seconds before lower
1201 priority ones. This insures that Bacula will examine the jobs in the
1202 correct order, and that your priority scheme will be respected.
1204 \label{WritePartAfterJob}
1205 \item [Write Part After Job = \lt{}yes|no\gt{}]
1206 \index[dir]{Write Part After Job }
1207 This directive is only implemented in version 1.37 and later.
1208 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1209 will be created after the job is finished.
1211 It should be set to {\bf yes} when writing to devices that require mount
1212 (for example DVD), so you are sure that the current part, containing
1213 this job's data, is written to the device, and that no data is left in
1214 the temporary file on the hard disk. However, on some media, like DVD+R
1215 and DVD-R, a lot of space (about 10Mb) is lost everytime a part is
1216 written. So, if you run several jobs each after another, you could set
1217 this directive to {\bf no} for all jobs, except the last one, to avoid
1218 wasting too much space, but to ensure that the data is written to the
1219 medium when all jobs are finished.
1221 It is ignored with tape and FIFO devices.
1224 The following is an example of a valid Job resource definition:
1231 Level = Incremental # default
1233 FileSet="Minou Full Set"
1236 Schedule = "MinouWeeklyCycle"
1242 \subsection*{The JobDefs Resource}
1243 \label{JobDefsResource}
1244 \index[general]{JobDefs Resource}
1245 \index[general]{Resource!JobDefs}
1246 \addcontentsline{toc}{subsection}{JobDefs Resource}
1248 The JobDefs resource permits all the same directives that can appear in a Job
1249 resource. However, a JobDefs resource does not create a Job, rather it can be
1250 referenced within a Job to provide defaults for that Job. This permits you to
1251 concisely define several nearly identical Jobs, each one referencing a JobDefs
1252 resource which contains the defaults. Only the changes from the defaults need to
1253 be mentioned in each Job.
1255 \subsection*{The Schedule Resource}
1256 \label{ScheduleResource}
1257 \index[general]{Resource!Schedule}
1258 \index[general]{Schedule Resource}
1259 \addcontentsline{toc}{subsection}{Schedule Resource}
1261 The Schedule resource provides a means of automatically scheduling a Job as
1262 well as the ability to override the default Level, Pool, Storage and Messages
1263 resources. If a Schedule resource is not referenced in a Job, the Job can only
1264 be run manually. In general, you specify an action to be taken and when.
1269 \index[dir]{Schedule}
1270 Start of the Schedule directives. No {\bf Schedule} resource is required,
1272 you will need at least one if you want Jobs to be automatically started.
1274 \item [Name = \lt{}name\gt{}]
1276 The name of the schedule being defined. The Name directive is required.
1278 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1280 The Run directive defines when a Job is to be run, and what overrides if any
1281 to apply. You may specify multiple {\bf run} directives within a {\bf
1282 Schedule} resource. If you do, they will all be applied (i.e. multiple
1283 schedules). If you have two {\bf Run} directives that start at the same time,
1284 two Jobs will start at the same time (well, within one second of each
1287 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1288 Messages, and the Pool specifications provided in the Job resource. In
1289 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1290 specifications permit overriding the Pool specification according to what
1291 backup Job Level is in effect.
1293 By the use of overrides, you may customize a particular Job. For example, you
1294 may specify a Messages override for your Incremental backups that outputs
1295 messages to a log file, but for your weekly or monthly Full backups, you may
1296 send the output by email by using a different Messages override.
1298 {\bf Job-overrides} are specified as: {\bf keyword=value} where the keyword
1299 is Level, Storage, Messages, Pool, FullPool, DifferentialPool, or
1300 IncrementalPool, and the {\bf value} is as defined on the respective
1301 directive formats for the Job resource. You may specify multiple {\bf
1302 Job-overrides} on one {\bf Run} directive by separating them with one or more
1303 spaces or by separating them with a trailing comma. For example:
1309 is all files in the FileSet whether or not they have changed.
1311 \item [Level=Incremental]
1313 is all files that have changed since the last backup.
1317 specifies to use the Pool named {\bf Weekly}.
1319 \item [Storage=DLT\_Drive]
1320 \index[dir]{Storage}
1321 specifies to use {\bf DLT\_Drive} for the storage device.
1323 \item [Messages=Verbose]
1324 \index[dir]{Messages}
1325 specifies to use the {\bf Verbose} message resource for the Job.
1327 \item [FullPool=Full]
1328 \index[dir]{FullPool}
1329 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1331 upgraded from another type to a full backup.
1333 \item [DifferentialPool=Differential]
1334 \index[dir]{DifferentialPool}
1335 specifies to use the Pool named {\bf Differential} if the job is a
1336 differential backup.
1338 \item [IncrementalPool=Incremental]
1339 \index[dir]{IncrementalPool}
1340 specifies to use the Pool named {\bf Incremental} if the job is an
1343 \item [SpoolData=yes|no]
1344 \index[dir]{SpoolData}
1345 tells Bacula to request the Storage daemon to spool data to a disk file
1346 before putting it on tape.
1348 \item [WritePartAfterJob=yes|no]
1349 \index[dir]{WritePartAfterJob}
1350 tells Bacula to request the Storage daemon to write the current part file to
1351 the device when the job is finished (see
1352 \ilink{Write Part After Job directive in the Job
1353 resource}{WritePartAfterJob}). Please note, this directive is implemented
1354 only in version 1.37 and later.
1358 {\bf Date-time-specification} determines when the Job is to be run. The
1359 specification is a repetition, and as a default Bacula is set to run a job at
1360 the beginning of the hour of every hour of every day of every week of every
1361 month of every year. This is not normally what you want, so you must specify
1362 or limit when you want the job to run. Any specification given is assumed to
1363 be repetitive in nature and will serve to override or limit the default
1364 repetition. This is done by specifying masks or times for the hour, day of the
1365 month, day of the week, week of the month, week of the year, and month when
1366 you want the job to run. By specifying one or more of the above, you can
1367 define a schedule to repeat at almost any frequency you want.
1369 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1370 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1371 is special in that you may either specify a day of the month such as 1, 2,
1372 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1373 Sunday. Finally, you may also specify a week qualifier to restrict the
1374 schedule to the first, second, third, fourth, or fifth week of the month.
1376 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1377 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1378 month} and {\bf hour} remain set to the defaults of every month and all
1381 Note, by default with no other specification, your job will run at the
1382 beginning of every hour. If you wish your job to run more than once in any
1383 given hour, you will need to specify multiple {\bf run} specifications each
1384 with a different minute.
1386 The date/time to run the Job can be specified in the following way in
1393 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1394 second | third | forth | fifth
1395 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1396 sunday | monday | tuesday | wednesday |
1397 thursday | friday | saturday
1398 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1399 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1400 aug | sep | oct | nov | dec | january |
1401 february | ... | december
1402 <daily-keyword> = daily
1403 <weekly-keyword> = weekly
1404 <monthly-keyword> = monthly
1405 <hourly-keyword> = hourly
1406 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1407 <number> = <digit> | <digit><number>
1408 <12hour> = 0 | 1 | 2 | ... 12
1409 <hour> = 0 | 1 | 2 | ... 23
1410 <minute> = 0 | 1 | 2 | ... 59
1411 <day> = 1 | 2 | ... 31
1412 <time> = <hour>:<minute> |
1413 <12hour>:<minute>am |
1415 <time-spec> = <at-keyword> <time> |
1417 <date-keyword> = <void-keyword> <weekly-keyword>
1418 <day-range> = <day>-<day>
1419 <month-range> = <month-keyword>-<month-keyword>
1420 <wday-range> = <wday-keyword>-<wday-keyword>
1421 <range> = <day-range> | <month-range> |
1423 <date> = <date-keyword> | <day> | <range>
1424 <date-spec> = <date> | <date-spec>
1425 <day-spec> = <day> | <wday-keyword> |
1426 <day-range> | <wday-range> |
1428 <day-spec> = <day> | <wday-keyword> |
1429 <day> | <wday-range> |
1430 <week-keyword> <wday-keyword> |
1431 <week-keyword> <wday-range>
1432 <month-spec> = <month-keyword> | <month-range> |
1434 <date-time-spec> = <month-spec> <day-spec> <time-spec>
1440 Note, the Week of Year specification wnn follows the ISO standard definition
1441 of the week of the year, where Week 1 is the week in which the first Thursday
1442 of the year occurs, or alternatively, the week which contains the 4th of
1443 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
1444 precedes the first ISO week (i.e. has the first few days of the year if any
1445 occur before Thursday). w00 is not defined by the ISO specification. A week
1446 starts with Monday and ends with Sunday.
1448 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
1449 with level full each Sunday at 1:05am and an incremental job Monday through
1450 Saturday at 1:05am is:
1455 Name = "WeeklyCycle"
1456 Run = Level=Full sun at 1:05
1457 Run = Level=Incremental mon-sat at 1:05
1462 An example of a possible monthly cycle is as follows:
1467 Name = "MonthlyCycle"
1468 Run = Level=Full Pool=Monthly 1st sun at 1:05
1469 Run = Level=Differential 2nd-5th sun at 1:05
1470 Run = Level=Incremental Pool=Daily mon-sat at 1:05
1475 The first of every month:
1481 Run = Level=Full on 1 at 1:05
1482 Run = Level=Incremental on 2-31 at 1:05
1493 Run = Level=Full hourly at 0:05
1494 Run = Level=Full hourly at 0:15
1495 Run = Level=Full hourly at 0:25
1496 Run = Level=Full hourly at 0:35
1497 Run = Level=Full hourly at 0:45
1498 Run = Level=Full hourly at 0:55
1503 \subsection*{Technical Notes on Schedules}
1504 \index[general]{Schedules!Technical Notes on}
1505 \index[general]{Technical Notes on Schedules}
1506 \addcontentsline{toc}{subsection}{Technical Notes on Schedules}
1508 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
1509 minute field to each schedule. The masks are hour, day of the month (mday),
1510 month, day of the week (wday), week of the month (wom), and week of the year
1511 (woy). The schedule is initialized to have the bits of each of these masks
1512 set, which means that at the beginning of every hour, the job will run. When
1513 you specify a month for the first time, the mask will be cleared and the bit
1514 corresponding to your selected month will be selected. If you specify a second
1515 month, the bit corresponding to it will also be added to the mask. Thus when
1516 Bacula checks the masks to see if the bits are set corresponding to the
1517 current time, your job will run only in the two months you have set. Likewise,
1518 if you set a time (hour), the hour mask will be cleared, and the hour you
1519 specify will be set in the bit mask and the minutes will be stored in the
1522 For any schedule you have defined, you can see how these bits are set by doing
1523 a {\bf show schedules} command in the Console program. Please note that the
1524 bit mask is zero based, and Sunday is the first day of the week (bit zero).
1528 \subsection*{The Client Resource}
1529 \label{ClientResource2}
1530 \index[general]{Resource!Client}
1531 \index[general]{Client Resource}
1532 \addcontentsline{toc}{subsection}{Client Resource}
1534 The Client resource defines the attributes of the Clients that are served by
1535 this Director; that is the machines that are to be backed up. You will need
1536 one Client resource definition for each machine to be backed up.
1540 \item [Client (or FileDaemon)]
1541 \index[dir]{Client (or FileDaemon)}
1542 Start of the Client directives.
1544 \item [Name = \lt{}name\gt{}]
1546 The client name which will be used in the Job resource directive or in the
1547 console run command. This directive is required.
1549 \item [Address = \lt{}address\gt{}]
1550 \index[dir]{Address }
1551 Where the address is a host name, a fully qualified domain name, or a
1553 address in dotted quad notation for a Bacula File server daemon. This
1554 directive is required.
1556 \item [FD Port = \lt{}port-number\gt{}]
1557 \index[dir]{FD Port }
1558 Where the port is a port number at which the Bacula File server daemon can
1560 contacted. The default is 9102.
1562 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
1563 \index[dir]{Catalog }
1564 This specifies the name of the catalog resource to be used for this Client.
1565 This directive is required.
1567 \item [Password = \lt{}password\gt{}]
1568 \index[dir]{Password }
1569 This is the password to be used when establishing a connection with the File
1570 services, so the Client configuration file on the machine to be backed up
1571 must have the same password defined for this Director. This directive is
1572 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1573 Bacula will generate a random password during the configuration process,
1574 otherwise it will be left blank.
1575 \label{FileRetention}
1577 \item [File Retention = \lt{}time-period-specification\gt{}]
1578 \index[dir]{File Retention }
1579 The File Retention directive defines the length of time that Bacula will
1581 File records in the Catalog database. When this time period expires, and if
1582 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
1583 that are older than the specified File Retention period. Note, this affects
1584 only records in the catalog database. It does not affect your archive
1587 File records may actually be retained for a shorter period than you specify
1588 on this directive if you specify either a shorter {\bf Job Retention} or a
1589 shorter {\bf Volume Retention} period. The shortest retention period of the
1590 three takes precedence. The time may be expressed in seconds, minutes,
1591 hours, days, weeks, months, quarters, or years. See the
1592 \ilink{ Configuration chapter}{Time} of this manual for
1593 additional details of time specification.
1595 The default is 60 days.
1596 \label{JobRetention}
1598 \item [Job Retention = \lt{}time-period-specification\gt{}]
1599 \index[dir]{Job Retention }
1600 The Job Retention directive defines the length of time that Bacula will keep
1601 Job records in the Catalog database. When this time period expires, and if
1602 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) Job records
1603 that are older than the specified File Retention period. As with the other
1604 retention periods, this affects only records in the catalog and not data in
1605 your archive backup.
1607 If a Job record is selected for pruning, all associated File and JobMedia
1608 records will also be pruned regardless of the File Retention period set.
1609 As a consequence, you normally will set the File retention period to be
1610 less than the Job retention period. The Job retention period can actually
1611 be less than the value you specify here if you set the {\bf Volume
1612 Retention} directive in the Pool resource to a smaller duration. This is
1613 because the Job retention period and the Volume retention period are
1614 independently applied, so the smaller of the two takes precedence.
1616 The Job retention period is specified as seconds, minutes, hours, days,
1617 weeks, months, quarters, or years. See the
1618 \ilink{ Configuration chapter}{Time} of this manual for
1619 additional details of time specification.
1621 The default is 180 days.
1624 \item [AutoPrune = \lt{}yes|no\gt{}]
1625 \index[dir]{AutoPrune }
1626 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
1627 will automatically apply the File retention period and the Job retention
1628 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
1629 pruning will not be done, and your Catalog will grow in size each time you
1630 run a Job. Pruning affects only information in the catalog and not data
1631 stored in the backup archives (on Volumes).
1633 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1634 \index[dir]{Maximum Concurrent Jobs }
1635 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
1636 that can run concurrently. Note, this directive limits only Jobs for Clients
1637 with the same name as the resource in which it appears. Any other
1638 restrictions on the maximum concurrent jobs such as in the Director, Job, or
1639 Storage resources will also apply in addition to any limit specified here.
1640 The default is set to 1, but you may set it to a larger number. We strongly
1641 recommend that you read the WARNING documented under
1642 \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
1645 \item [*Priority = \lt{}number\gt{}]
1646 \index[dir]{*Priority }
1647 The number specifies the priority of this client relative to other clients
1648 that the Director is processing simultaneously. The priority can range from
1649 1 to 1000. The clients are ordered such that the smaller number priorities
1650 are performed first (not currently implemented).
1653 The following is an example of a valid Client resource definition:
1661 Password = very_good
1666 \subsection*{The Storage Resource}
1667 \label{StorageResource2}
1668 \index[general]{Resource!Storage}
1669 \index[general]{Storage Resource}
1670 \addcontentsline{toc}{subsection}{Storage Resource}
1672 The Storage resource defines which Storage daemons are available for use by
1678 \index[dir]{Storage}
1679 Start of the Storage resources. At least one storage resource must be
1682 \item [Name = \lt{}name\gt{}]
1684 The name of the storage resource. This name appears on the Storage directive
1685 specified in the Job directive and is required.
1687 \item [Address = \lt{}address\gt{}]
1688 \index[dir]{Address }
1689 Where the address is a host name, a {\bf fully qualified domain name}, or an
1690 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
1691 will be transmitted to the File daemon who will then use it to contact the
1692 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
1693 the name but rather a fully qualified machine name or an IP address. This
1694 directive is required.
1696 \item [SD Port = \lt{}port\gt{}]
1697 \index[dir]{SD Port }
1698 Where port is the port to use to contact the storage daemon for information
1699 and to start jobs. This same port number must appear in the Storage resource
1700 of the Storage daemon's configuration file. The default is 9103.
1702 \item [Password = \lt{}password\gt{}]
1703 \index[dir]{Password}
1704 This is the password to be used when establishing a connection with the
1705 Storage services. This same password also must appear in the Director
1706 resource of the Storage daemon's configuration file. This directive is
1707 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
1708 Bacula will generate a random password during the configuration process,
1709 otherwise it will be left blank.
1711 \item [Device = \lt{}device-name\gt{}]
1713 This directive specifies the name of the device to be used for the
1714 storage. This name is not the physical device name, but the logical
1715 device name as defined on the {\bf Name} directive contained in the {\bf
1716 Device} resource definition of the {\bf Storage daemon} configuration
1717 file or if the device is an Autochanger, you must put the name as
1718 defined on the {\bf Name} directive contained in the {\bf Autochanger}
1719 resource definition of the {\bf Storage daemon}. You can specify any
1720 name you would like (even the device name if you prefer) up to a maximum
1721 of 127 characters in length. The physical device name associated with
1722 this device is specified in the {\bf Storage daemon} configuration file
1723 (as {\bf Archive Device}). Please take care not to define two different
1724 Storage resource directives in the Director that point to the same
1725 Device in the Storage daemon. Doing so may cause the Storage daemon to
1726 block (or hang) attempting to open the same device that is already open.
1727 This directive is required.
1730 \item [Media Type = \lt{}MediaType\gt{}]
1731 \index[dir]{Media Type}
1732 This directive specifies the Media Type to be used to store the data.
1733 This is an arbitrary string of characters up to 127 maximum that you
1734 define. It can be anything you want. However, it is best to make it
1735 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
1736 ...). In addition, it is essential that you make the {\bf Media Type}
1737 specification unique for each storage media type. If you have two DDS-4
1738 drives that have incompatible formats, or if you have a DDS-4 drive and
1739 a DDS-4 autochanger, you almost certainly should specify different {\bf
1740 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
1741 associated with the Job, Bacula can decide to use any Storage daemon
1742 that supports Media Type {\bf DDS-4} and on any drive that supports it.
1744 If you want to tie Bacula to using a single Storage daemon or drive, you
1745 must specify a unique Media Type for that drive. This is an important
1746 point that should be carefully understood. Note, this applies equally
1747 to Disk Volumes. If you define more than one disk Device resource in
1748 your Storage daemon's conf file, the Volumes on thoes two devices are in
1749 fact incompatible because one can not be mounted on the other device
1750 since they are found in different directories. For this reason, you
1751 probably should use two different Media Types for your two disk Devices
1752 (even though you might think of them as both being File types). You can
1753 find more on this subject in the \ilink{Basic Volume
1754 Management}{_ChapterStart39} chapter of this manual.
1756 The {\bf MediaType} specified here, {\bf must} correspond to the {\bf
1757 Media Type} specified in the {\bf Device} resource of the {\bf Storage
1758 daemon} configuration file. This directive is required, and it is used
1759 by the Director and the Storage daemon to ensure that a Volume
1760 automatically selected from the Pool corresponds to the physical device.
1761 If a Storage daemon handles multiple devices (e.g. will write to
1762 various file Volumes on different partitions), this directive allows you
1763 to specify exactly which device.
1765 As mentioned above, the value specified in the Director's Storage resource
1766 must agree with the value specified in the Device resource in the {\bf
1767 Storage daemon's} configuration file. It is also an additional check so that
1768 you don't try to write data for a DLT onto an 8mm device.
1770 \label{Autochanger1}
1771 \item [Autochanger = \lt{}yes|no\gt{}]
1772 \index[dir]{Autochanger }
1773 If you specify {\bf yes} for this command (the default is {\bf no}), when
1774 you use the {\bf label} command or the {\bf add} command to create a new
1775 Volume, {\bf Bacula} will also request the Autochanger Slot number.
1776 This simplifies creating database entries for Volumes in an autochanger.
1777 If you forget to specify the Slot, the autochanger will not be used.
1778 However, you may modify the Slot associated with a Volume at any time by
1779 using the {\bf update volume} command in the console program. When {\bf
1780 autochanger} is enabled, the algorithm used by Bacula to search for
1781 available volumes will be modified to consider only Volumes that are
1782 known to be in the autochanger's magazine. If no {\bf in changer}
1783 volume is found, Bacula will attempt recycling, pruning, ..., and if
1784 still no volume is found, Bacula will search for any volume whether or
1785 not in the magazine. By privileging in changer volumes, this procedure
1786 minimizes operator intervention. The default is {\bf no}.
1788 For the autochanger to be used, you must also specify {\bf Autochanger =
1789 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
1790 configuration file as well as other important Storage daemon
1791 configuration information. Please consult the \ilink{Using
1792 Autochangers}{_ChapterStart18} manual of this chapter for the details of
1795 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1796 \index[dir]{Maximum Concurrent Jobs }
1797 where \lt{}number\gt{} is the maximum number of Jobs with the current
1799 resource that can run concurrently. Note, this directive limits only Jobs
1800 for Jobs using this Storage daemon. Any other restrictions on the maximum
1801 concurrent jobs such as in the Director, Job, or Client resources will also
1802 apply in addition to any limit specified here. The default is set to 1, but
1803 you may set it to a larger number. We strongly recommend that you read the
1804 WARNING documented under
1805 \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
1808 While it is possible to set the Director's, Job's, or Client's maximum
1809 concurrent jobs greater than one, you should take great care in setting the
1810 Storage daemon's greater than one. By keeping this directive set to one, you
1811 will avoid having two jobs simultaneously write to the same Volume. Although
1812 this is supported, it is not currently recommended.
1815 The following is an example of a valid Storage resource definition:
1819 # Definition of tape storage device
1823 Password = storage_password # password for Storage daemon
1824 Device = "HP DLT 80" # same as Device in Storage daemon
1825 Media Type = DLT8000 # same as MediaType in Storage daemon
1830 \subsection*{The Pool Resource}
1831 \label{PoolResource}
1832 \index[general]{Resource!Pool}
1833 \index[general]{Pool Resource}
1834 \addcontentsline{toc}{subsection}{Pool Resource}
1836 The Pool resource defines the set of storage Volumes (tapes or files) to be
1837 used by Bacula to write the data. By configuring different Pools, you can
1838 determine which set of Volumes (media) receives the backup data. This permits,
1839 for example, to store all full backup data on one set of Volumes and all
1840 incremental backups on another set of Volumes. Alternatively, you could assign
1841 a different set of Volumes to each machine that you backup. This is most
1842 easily done by defining multiple Pools.
1844 Another important aspect of a Pool is that it contains the default attributes
1845 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
1846 Volume when it is created. This avoids the need for you to answer a large
1847 number of questions when labeling a new Volume. Each of these attributes can
1848 later be changed on a Volume by Volume basis using the {\bf update} command in
1849 the console program. Note that you must explicitly specify which Pool Bacula
1850 is to use with each Job. Bacula will not automatically search for the correct
1853 Most often in Bacula installations all backups for all machines (Clients) go
1854 to a single set of Volumes. In this case, you will probably only use the {\bf
1855 Default} Pool. If your backup strategy calls for you to mount a different tape
1856 each day, you will probably want to define a separate Pool for each day. For
1857 more information on this subject, please see the
1858 \ilink{Backup Strategies}{_ChapterStart3} chapter of this
1862 To use a Pool, there are three distinct steps. First the Pool must be defined
1863 in the Director's configuration file. Then the Pool must be written to the
1864 Catalog database. This is done automatically by the Director each time that it
1865 starts, or alternatively can be done using the {\bf create} command in the
1866 console program. Finally, if you change the Pool definition in the Director's
1867 configuration file and restart Bacula, the pool will be updated alternatively
1868 you can use the {\bf update pool} console command to refresh the database
1869 image. It is this database image rather than the Director's resource image
1870 that is used for the default Volume attributes. Note, for the pool to be
1871 automatically created or updated, it must be explicitly referenced by a Job
1874 Next the physical media must be labeled. The labeling can either be done with
1875 the {\bf label} command in the {\bf console} program or using the {\bf btape}
1876 program. The preferred method is to use the {\bf label} command in the {\bf
1879 Finally, you must add Volume names (and their attributes) to the Pool. For
1880 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
1881 archive device specified for the job (i.e. if you are going to back up to a
1882 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
1883 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
1884 are backing up to files. When running a Job, you must explicitly specify which
1885 Pool to use. Bacula will then automatically select the next Volume to use from
1886 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
1887 from the Pool is identical to that required by the Storage resource you have
1888 specified for the Job.
1890 If you use the {\bf label} command in the console program to label the
1891 Volumes, they will automatically be added to the Pool, so this last step is
1892 not normally required.
1894 It is also possible to add Volumes to the database without explicitly labeling
1895 the physical volume. This is done with the {\bf add} console command.
1897 As previously mentioned, each time Bacula starts, it scans all the Pools
1898 associated with each Catalog, and if the database record does not already
1899 exist, it will be created from the Pool Resource definition. {\bf Bacula}
1900 probably should do an {\bf update pool} if you change the Pool definition, but
1901 currently, you must do this manually using the {\bf update pool} command in
1902 the Console program.
1904 The Pool Resource defined in the Director's configuration file
1905 (bacula-dir.conf) may contain the following directives:
1911 Start of the Pool resource. There must be at least one Pool resource
1915 \item [Name = \lt{}name\gt{}]
1917 The name of the pool. For most applications, you will use the default
1918 pool name {\bf Default}. This directive is required.
1921 \item [Maximum Volumes = \lt{}number\gt{}]
1922 \index[dir]{Maximum Volumes }
1923 This directive specifies the maximum number of volumes (tapes or files)
1924 contained in the pool. This directive is optional, if omitted or set to
1925 zero, any number of volumes will be permitted. In general, this
1926 directive is useful for Autochangers where there is a fixed number of
1927 Volumes, or for File storage where you wish to ensure that the backups
1928 made to disk files do not become too numerous or consume too much space.
1930 \item [Pool Type = \lt{}type\gt{}]
1931 \index[dir]{Pool Type }
1932 This directive defines the pool type, which corresponds to the type of
1933 Job being run. It is required and may be one of the following:
1944 \item [Use Volume Once = \lt{}yes|no\gt{}]
1945 \index[dir]{Use Volume Once }
1946 This directive if set to {\bf yes} specifies that each volume is to be
1947 used only once. This is most useful when the Media is a file and you
1948 want a new file for each backup that is done. The default is {\bf no}
1949 (i.e. use volume any number of times). This directive will most likely
1950 be phased out (deprecated), so you are recommended to use {\bf Maximum
1951 Volume Jobs = 1} instead.
1953 The value defined by this directive in the bacula-dir.conf file is the
1954 default value used when a Volume is created. Once the volume is
1955 created, changing the value in the bacula-dir.conf file will not change
1956 what is stored for the Volume. To change the value for an existing
1957 Volume you must use the {\bf update} command in the Console.
1959 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
1960 \index[dir]{Maximum Volume Jobs }
1961 This directive specifies the maximum number of Jobs that can be written
1962 to the Volume. If you specify zero (the default), there is no limit.
1963 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
1964 positive-integer} the Volume will be marked {\bf Used}. When the Volume
1965 is marked {\bf Used} it can no longer be used for appending Jobs, much
1966 like the {\bf Full} status but it can be recycled if recycling is
1967 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
1968 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
1970 The value defined by this directive in the bacula-dir.conf
1971 file is the default value used when a Volume is created. Once the volume is
1972 created, changing the value in the bacula-dir.conf file will not change what
1973 is stored for the Volume. To change the value for an existing Volume you
1974 must use the {\bf update} command in the Console.
1976 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
1977 \index[dir]{Maximum Volume Files }
1978 This directive specifies the maximum number of files that can be written
1979 to the Volume. If you specify zero (the default), there is no limit.
1980 Otherwise, when the number of files written to the Volume equals {\bf
1981 positive-integer} the Volume will be marked {\bf Used}. When the Volume
1982 is marked {\bf Used} it can no longer be used for appending Jobs, much
1983 like the {\bf Full} status but it can be recycled if recycling is
1984 enabled and thus used again. This value is checked and the {\bf Used}
1985 status is set only at the end of a job that writes to the particular
1988 The value defined by this directive in the bacula-dir.conf file is the
1989 default value used when a Volume is created. Once the volume is
1990 created, changing the value in the bacula-dir.conf file will not change
1991 what is stored for the Volume. To change the value for an existing
1992 Volume you must use the {\bf update} command in the Console.
1994 \item [Maximum Volume Bytes = \lt{}size\gt{}]
1995 \index[dir]{Maximum Volume Bytes }
1996 This directive specifies the maximum number of bytes that can be written
1997 to the Volume. If you specify zero (the default), there is no limit
1998 except the physical size of the Volume. Otherwise, when the number of
1999 bytes written to the Volume equals {\bf size} the Volume will be marked
2000 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2001 used for appending Jobs, much like the {\bf Full} status but it can be
2002 recycled if recycling is enabled, and thus the Volume can be re-used
2003 after recycling. This value is checked and the {\bf Used} status set
2004 while the job is writing to the particular volume.
2006 The value defined by this directive in the bacula-dir.conf file is the
2007 default value used when a Volume is created. Once the volume is
2008 created, changing the value in the bacula-dir.conf file will not change
2009 what is stored for the Volume. To change the value for an existing
2010 Volume you must use the {\bf update} command in the Console.
2012 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2013 \index[dir]{Volume Use Duration }
2014 The Volume Use Duration directive defines the time period that the
2015 Volume can be written beginning from the time of first data write to the
2016 Volume. If the time-period specified is zero (the default), the Volume
2017 can be written indefinitely. Otherwise, when the time period from the
2018 first write to the volume (the first Job written) exceeds the
2019 time-period-specification, the Volume will be marked {\bf Used}, which
2020 means that no more Jobs can be appended to the Volume, but it may be
2021 recycled if recycling is enabled. Once the Volume is
2022 recycled, it will be available for use again.
2024 You might use this directive, for example, if you have a Volume used for
2025 Incremental backups, and Volumes used for Weekly Full backups. Once the
2026 Full backup is done, you will want to use a different Incremental
2027 Volume. This can be accomplished by setting the Volume Use Duration for
2028 the Incremental Volume to six days. I.e. it will be used for the 6
2029 days following a Full save, then a different Incremental volume will be
2030 used. Be careful about setting the duration to short periods such as 23
2031 hours, or you might experience problems of Bacula waiting for a tape
2032 over the weekend only to complete the backups Monday morning when an
2033 operator mounts a new tape.
2035 The use duration is checked and the {\bf Used} status is set only at the
2036 end of a job that writes to the particular volume, which means that even
2037 though the use duration may have expired, the catalog entry will not be
2038 updated until the next job that uses this volume is run.
2040 Please note that the value defined by this directive in the bacula-dir.conf
2041 file is the default value used when a Volume is created. Once the volume is
2042 created, changing the value in the bacula-dir.conf file will not change what
2043 is stored for the Volume. To change the value for an existing Volume you
2045 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2047 \item [Catalog Files = \lt{}yes|no\gt{}]
2048 \index[dir]{Catalog Files }
2049 This directive defines whether or not you want the names of the files
2050 that were saved to be put into the catalog. The default is {\bf yes}.
2051 The advantage of specifying {\bf Catalog Files = No} is that you will
2052 have a significantly smaller Catalog database. The disadvantage is that
2053 you will not be able to produce a Catalog listing of the files backed up
2054 for each Job (this is often called Browsing). Also, without the File
2055 entries in the catalog, you will not be able to use the Console {\bf
2056 restore} command nor any other command that references File entries.
2058 \label{PoolAutoPrune}
2059 \item [AutoPrune = \lt{}yes|no\gt{}]
2060 \index[dir]{AutoPrune }
2061 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2062 will automatically apply the Volume Retention period when new Volume is
2063 needed and no appendable Volumes exist in the Pool. Volume pruning causes
2064 expired Jobs (older than the {\bf Volume Retention} period) to be deleted
2065 from the Catalog and permits possible recycling of the Volume.
2067 \label{VolRetention}
2068 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2069 \index[dir]{Volume Retention }
2070 The Volume Retention directive defines the length of time that {\bf
2071 Bacula} will keep Job records associated with the Volume in the Catalog
2072 database. When this time period expires, and if {\bf AutoPrune} is set
2073 to {\bf yes} Bacula may prune (remove) Job records that are older than
2074 the specified Volume Retention period if it is necessary to free up a
2075 Volume. Recycling will not occur until it is absolutely necessary to
2076 free up a volume. All File records associated with pruned Jobs are also
2077 pruned. The time may be specified as seconds, minutes, hours, days,
2078 weeks, months, quarters, or years. The {\bf Volume Retention} is
2079 applied independently of the {\bf Job Retention} and the {\bf File
2080 Retention} periods defined in the Client resource. This means that all
2081 the retentions periods are applied in turn and that the shorter period
2082 is the one that effectively takes precedence. Note, that when the {\bf
2083 Volume Retention} period has been reached, and it is necessary to obtain
2084 a new volume, Bacula will prune both the Job and the File records.
2086 It is important to know that when the Volume Retention period expires,
2087 Bacula does not automatically recycle a Volume. It attempts to keep the
2088 Volume data intact as long as possible before over writing the Volume.
2090 The default Volume retention period is 365 days. Note, this directive
2091 sets the default value for each Volume entry in the Catalog when the
2092 Volume is created. The value in the catalog may be later individually
2093 changed for each Volume using the Console program.
2095 By defining multiple Pools with different Volume Retention periods, you
2096 may effectively have a set of tapes that is recycled weekly, another
2097 Pool of tapes that is recycled monthly and so on. However, one must
2098 keep in mind that if your {\bf Volume Retention} period is too short, it
2099 may prune the last valid Full backup, and hence until the next Full
2100 backup is done, you will not have a complete backup of your system, and
2101 in addition, the next Incremental or Differential backup will be
2102 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2103 Retention} period should be at twice the interval of your Full backups.
2104 This means that if you do a Full backup once a month, the minimum Volume
2105 retention period should be two months.
2107 Please note that the value defined by this directive in the bacula-dir.conf
2108 file is the default value used when a Volume is created. Once the volume is
2109 created, changing the value in the bacula-dir.conf file will not change what
2110 is stored for the Volume. To change the value for an existing Volume you
2111 must use the {\bf update} command in the Console.
2114 \item [Recycle = \lt{}yes|no\gt{}]
2115 \index[dir]{Recycle }
2116 This directive specifies whether or not Purged Volumes may be recycled.
2117 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2118 none that are appendable, it will search for and recycle (reuse) Purged
2119 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2120 deleted from the Catalog). If the Volume is recycled, all previous data
2121 written to that Volume will be overwritten. If Recycle is set to {\bf
2122 no}, the Volume will not be recycled, and hence, the data will remain
2123 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2124 is no (0 in the catalog), you may manually set the recycle flag (update
2125 command) for a Volume to be reused.
2127 Please note that the value defined by this directive in the
2128 bacula-dir.conf file is the default value used when a Volume is created.
2129 Once the volume is created, changing the value in the bacula-dir.conf
2130 file will not change what is stored for the Volume. To change the value
2131 for an existing Volume you must use the {\bf update} command in the
2134 \label{RecycleOldest}
2135 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2136 \index[dir]{Recycle Oldest Volume }
2137 This directive instructs the Director to search for the oldest used
2138 Volume in the Pool when another Volume is requested by the Storage
2139 daemon and none are available. The catalog is then {\bf pruned}
2140 respecting the retention periods of all Files and Jobs written to this
2141 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2142 Volume is recycled and will be used as the next Volume to be written.
2143 This directive respects any Job, File, or Volume retention periods that
2144 you may have specified, and as such it is {\bf much} better to use this
2145 directive than the Purge Oldest Volume.
2147 This directive can be useful if you have a fixed number of Volumes in the
2148 Pool and you want to cycle through them and you have specified the correct
2151 However, if you use this directive and have only one
2152 Volume in the Pool, you will immediately recycle your Volume if you fill
2153 it and Bacula needs another one. Thus your backup will be totally invalid.
2154 Please use this directive with care. The default is {\bf no}.
2156 \label{RecycleCurrent}
2158 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2159 \index[dir]{Recycle Current Volume }
2160 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2161 the volume respecting the Job and File retention periods. If all Jobs
2162 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2163 will be used as the next Volume to be written. This directive respects
2164 any Job, File, or Volume retention periods that you may have specified,
2165 and thus it is {\bf much} better to use it rather than the Purge Oldest
2168 This directive can be useful if you have: a fixed number of Volumes in
2169 the Pool, you want to cycle through them, and you have specified
2170 retention periods that prune Volumes before you have cycled through the
2173 However, if you use this directive and have only one Volume in the Pool,
2174 you will immediately recycle your Volume if you fill it and Bacula needs
2175 another one. Thus your backup will be totally invalid. Please use this
2176 directive with care. The default is {\bf no}.
2180 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2181 \index[dir]{Purge Oldest Volume }
2182 This directive instructs the Director to search for the oldest used
2183 Volume in the Pool when another Volume is requested by the Storage
2184 daemon and none are available. The catalog is then {\bf purged}
2185 irrespective of retention periods of all Files and Jobs written to this
2186 Volume. The Volume is then recycled and will be used as the next Volume
2187 to be written. This directive overrides any Job, File, or Volume
2188 retention periods that you may have specified.
2190 This directive can be useful if you have a fixed number of Volumes in
2191 the Pool and you want to cycle through them and reusing the oldest one
2192 when all Volumes are full, but you don't want to worry about setting
2193 proper retention periods. However, by using this option you risk losing
2196 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2197 periods. If you have only a single Volume defined and you turn this
2198 variable on, that Volume will always be immediately overwritten when it
2199 fills! So at a minimum, ensure that you have a decent number of Volumes
2200 in your Pool before running any jobs. If you want retention periods to
2201 apply do not use this directive. To specify a retention period, use the
2202 {\bf Volume Retention} directive (see above).
2204 We {\bf highly} recommend against using this directive, because it is
2205 sure that some day, Bacula will recycle a Volume that contains current
2206 data. The default is {\bf no}.
2208 \item [Cleaning Prefix = \lt{}string\gt{}]
2209 \index[dir]{Cleaning Prefix }
2210 This directive defines a prefix string, which if it matches the
2211 beginning of a Volume name during labeling of a Volume, the Volume will
2212 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2213 never attempt to use this tape. This is primarily for use with
2214 autochangers that accept barcodes where the convention is that barcodes
2215 beginning with {\bf CLN} are treated as cleaning tapes.
2218 \item [Label Format = \lt{}format\gt{}]
2219 \index[dir]{Label Format }
2220 This directive specifies the format of the labels contained in this
2221 pool. The format directive is used as a sort of template to create new
2222 Volume names during automatic Volume labeling.
2224 The {\bf format} should be specified in double quotes, and consists of
2225 letters, numbers and the special characters hyphen ({\bf -}), underscore
2226 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2227 characters for a Volume name. The {\bf format} should be enclosed in
2230 In addition, the format may contain a number of variable expansion
2231 characters which will be expanded by a complex algorithm allowing you to
2232 create Volume names of many different formats. In all cases, the
2233 expansion process must resolve to the set of characters noted above that
2234 are legal Volume names. Generally, these variable expansion characters
2235 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2236 specify variable expansion characters, you should always enclose the
2237 format with double quote characters ({\bf "}). For more details on
2238 variable expansion, please see the \ilink{Variable
2239 Expansion}{_ChapterStart50} Chapter of this manual.
2241 If no variable expansion characters are found in the string, the Volume
2242 name will be formed from the {\bf format} string appended with the
2243 number of volumes in the pool plus one, which will be edited as four
2244 digits with leading zeros. For example, with a {\bf Label Format =
2245 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2248 With the exception of Job specific variables, you can test your {\bf
2249 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2252 In almost all cases, you should enclose the format specification (part
2253 after the equal sign) in double quotes. Please note that this directive
2254 is deprecated and is replaced in version 1.37 and greater with a Python
2255 script for creating volume names.
2259 In order for a Pool to be used during a Backup Job, the Pool must have at
2260 least one Volume associated with it. Volumes are created for a Pool using
2261 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2262 program. In addition to adding Volumes to the Pool (i.e. putting the
2263 Volume names in the Catalog database), the physical Volume must be labeled
2264 with a valid Bacula software volume label before {\bf Bacula} will accept
2265 the Volume. This will be automatically done if you use the {\bf label}
2266 command. Bacula can automatically label Volumes if instructed to do so,
2267 but this feature is not yet fully implemented.
2269 The following is an example of a valid Pool resource definition:
2281 \subsubsection*{The Scratch Pool}
2282 \addcontentsline{toc}{subsection}{Scratch Pool}
2283 \index[general]{Scratch Pool}
2284 In general, you can give your Pools any name you wish, but there is one
2285 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2286 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2287 writing and it cannot find one, it will look in the Scratch pool, and if
2288 it finds an available Volume, it will move it out of the Scratch pool into
2289 the Pool currently being used by the job.
2292 \subsection*{The Catalog Resource}
2293 \label{CatalogResource}
2294 \index[general]{Resource!Catalog}
2295 \index[general]{Catalog Resource}
2296 \addcontentsline{toc}{subsection}{Catalog Resource}
2298 The Catalog Resource defines what catalog to use for the current job.
2299 Currently, Bacula can only handle a single database server (SQLite, MySQL,
2300 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
2301 may be as many Catalogs (databases) defined as you wish. For example, you
2302 may want each Client to have its own Catalog database, or you may want
2303 backup jobs to use one database and verify or restore jobs to use another
2309 \index[dir]{Catalog}
2310 Start of the Catalog resource. At least one Catalog resource must be
2314 \item [Name = \lt{}name\gt{}]
2316 The name of the Catalog. No necessary relation to the database server
2317 name. This name will be specified in the Client resource directive
2318 indicating that all catalog data for that Client is maintained in this
2319 Catalog. This directive is required.
2321 \item [password = \lt{}password\gt{}]
2322 \index[dir]{password }
2323 This specifies the password to use when logging into the database. This
2324 directive is required.
2326 \item [DB Name = \lt{}name\gt{}]
2327 \index[dir]{DB Name }
2328 This specifies the name of the database. If you use multiple catalogs
2329 (databases), you specify which one here. If you are using an external
2330 database server rather than the internal one, you must specify a name
2331 that is known to the server (i.e. you explicitly created the Bacula
2332 tables using this name. This directive is required.
2334 \item [user = \lt{}user\gt{}]
2336 This specifies what user name to use to log into the database. This
2337 directive is required.
2339 \item [DB Socket = \lt{}socket-name\gt{}]
2340 \index[dir]{DB Socket }
2341 This is the name of a socket to use on the local host to connect to the
2342 database. This directive is used only by MySQL and is ignored by SQLite.
2343 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
2344 will use the default socket.
2346 \item [DB Address = \lt{}address\gt{}]
2347 \index[dir]{DB Address }
2348 This is the host address of the database server. Normally, you would specify
2349 this instead of {\bf DB Socket} if the database server is on another machine.
2350 In that case, you will also specify {\bf DB Port}. This directive is used
2351 only by MySQL and is ignored by SQLite if provided. This directive is
2354 \item [DB Port = \lt{}port\gt{}]
2355 \index[dir]{DB Port }
2356 This defines the port to be used in conjunction with {\bf DB Address} to
2357 access the database if it is on another machine. This directive is used only
2358 by MySQL and is ignored by SQLite if provided. This directive is optional.
2360 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
2361 %% \index[dir]{Multiple Connections }
2362 %% By default, this directive is set to no. In that case, each job that uses
2364 %% same Catalog will use a single connection to the catalog. It will be shared,
2365 %% and Bacula will allow only one Job at a time to communicate. If you set this
2366 %% directive to yes, Bacula will permit multiple connections to the database,
2367 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
2368 %% this is no problem. For MySQL, you must be *very* careful to have the
2369 %% multi-thread version of the client library loaded on your system. When this
2370 %% directive is set yes, each Job will have a separate connection to the
2371 %% database, and the database will control the interaction between the
2373 %% Jobs. This can significantly speed up the database operations if you are
2374 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
2375 %% Bacula will automatically enable transactions. This can significantly speed
2376 %% up insertion of attributes in the database either for a single Job or
2377 %% multiple simultaneous Jobs.
2379 %% This directive has not been tested. Please test carefully before running it
2380 %% in production and report back your results.
2384 The following is an example of a valid Catalog resource definition:
2393 password = "" # no password = no security
2398 or for a Catalog on another machine:
2408 DB Address = remote.acme.com
2414 \subsection*{The Messages Resource}
2415 \label{MessagesResource2}
2416 \index[general]{Resource!Messages}
2417 \index[general]{Messages Resource}
2418 \addcontentsline{toc}{subsection}{Messages Resource}
2420 For the details of the Messages Resource, please see the
2421 \ilink{Messages Resource Chapter}{_ChapterStart15} of this
2424 \subsection*{The Console Resource}
2425 \label{ConsoleResource1}
2426 \index[general]{Console Resource}
2427 \index[general]{Resource!Console}
2428 \addcontentsline{toc}{subsection}{Console Resource}
2430 As of Bacula version 1.33 and higher, there are three different kinds of
2431 consoles, which the administrator or user can use to interact with the
2432 Director. These three kinds of consoles comprise three different security
2436 \item The first console type is an {\bf anonymous} or {\bf default} console,
2437 which has full privileges. There is no console resource necessary for
2438 this type since the password is specified in the Director's resource and
2439 consequently such consoles do not have a name as defined on a {\bf Name
2440 =} directive. This is the kind of console that was initially
2441 implemented in versions prior to 1.33 and remains valid. Typically you
2442 would use it only for administrators.
2444 \item The second type of console, and new to version 1.33 and higher is a
2445 "named" console defined within a Console resource in both the Director's
2446 configuration file and in the Console's configuration file. Both the
2447 names and the passwords in these two entries must match much as is the
2448 case for Client programs.
2450 This second type of console begins with absolutely no privileges except
2451 those explicitly specified in the Director's Console resource. Thus you
2452 can have multiple Consoles with different names and passwords, sort of
2453 like multiple users, each with different privileges. As a default,
2454 these consoles can do absolutely nothing -- no commands whatsoever. You
2455 give them privileges or rather access to commands and resources by
2456 specifying access control lists in the Director's Console resource. The
2457 ACLs are specified by a directive followed by a list of access names.
2458 Examples of this are shown below.
2460 \item The third type of console is similar to the above mentioned one in that
2461 it requires a Console resource definition in both the Director and the
2462 Console. In addition, if the console name, provided on the {\bf Name =}
2463 directive, is the same as a Client name, that console is permitted to
2464 use the {\bf SetIP} command to change the Address directive in the
2465 Director's client resource to the IP address of the Console. This
2466 permits portables or other machines using DHCP (non-fixed IP addresses)
2467 to "notify" the Director of their current IP address.
2470 The Console resource is optional and need not be specified. The following
2471 directives are permitted within the Director's configuration resource:
2475 \item [Name = \lt{}name\gt{}]
2477 The name of the console. This name must match the name specified in the
2478 Console's configuration resource (much as is the case with Client
2481 \item [Password = \lt{}password\gt{}]
2482 \index[dir]{Password }
2483 Specifies the password that must be supplied for a named Bacula Console
2484 to be authorized. The same password must appear in the {\bf Console}
2485 resource of the Console configuration file. For added security, the
2486 password is never actually passed across the network but rather a
2487 challenge response hash code created with the password. This directive
2488 is required. If you have either {\bf /dev/random} {\bf bc} on your
2489 machine, Bacula will generate a random password during the configuration
2490 process, otherwise it will be left blank.
2492 \item [JobACL = \lt{}name-list\gt{}]
2493 \index[dir]{JobACL }
2494 This directive is used to specify a list of Job resource names that can
2495 be accessed by the console. Without this directive, the console cannot
2496 access any of the Director's Job resources. Multiple Job resource names
2497 may be specified by separating them with commas, and/or by specifying
2498 multiple JobACL directives. For example, the directive may be specified
2503 JobACL = kernsave, "Backup client 1", "Backup client 2"
2504 JobACL = "RestoreFiles"
2509 With the above specification, the console can access the Director's resources
2510 for the four jobs named on the JobACL directives, but for no others.
2512 \item [ClientACL = \lt{}name-list\gt{}]
2513 \index[dir]{ClientACL }
2514 This directive is used to specify a list of Client resource names that can
2516 accessed by the console.
2518 \item [StorageACL = \lt{}name-list\gt{}]
2519 \index[dir]{StorageACL }
2520 This directive is used to specify a list of Storage resource names that can
2521 be accessed by the console.
2523 \item [ScheduleACL = \lt{}name-list\gt{}]
2524 \index[dir]{ScheduleACL }
2525 This directive is used to specify a list of Schedule resource names that can
2526 be accessed by the console.
2528 \item [PoolACL = \lt{}name-list\gt{}]
2529 \index[dir]{PoolACL }
2530 This directive is used to specify a list of Pool resource names that can be
2531 accessed by the console.
2533 \item [FileSetACL = \lt{}name-list\gt{}]
2534 \index[dir]{FileSetACL }
2535 This directive is used to specify a list of FileSet resource names that can
2536 be accessed by the console.
2538 \item [CatalogACL = \lt{}name-list\gt{}]
2539 \index[dir]{CatalogACL }
2540 This directive is used to specify a list of Catalog resource names that can
2541 be accessed by the console.
2543 \item [CommandACL = \lt{}name-list\gt{}]
2544 \index[dir]{CommandACL }
2545 This directive is used to specify a list of of console commands that can be
2546 executed by the console.
2549 Aside from Director resource names and console command names, the special
2550 keyword {\bf *all*} can be specified in any of the above access control lists.
2551 When this keyword is present, any resource or command name (which ever is
2552 appropriate) will be accepted. For an example configuration file, please see
2554 \ilink{Console Configuration}{_ChapterStart36} chapter of this
2557 \subsection*{The Counter Resource}
2558 \label{CounterResource}
2559 \index[general]{Resource!Counter}
2560 \index[general]{Counter Resource}
2561 \addcontentsline{toc}{subsection}{Counter Resource}
2563 The Counter Resource defines a counter variable that can be accessed by
2564 variable expansion used for creating Volume labels with the {\bf LabelFormat}
2566 \ilink{LabelFormat}{Label} directive in this chapter for more
2572 \index[dir]{Counter}
2573 Start of the Counter resource. Counter directives are optional.
2575 \item [Name = \lt{}name\gt{}]
2577 The name of the Counter. This is the name you will use in the variable
2578 expansion to reference the counter value.
2580 \item [Minimum = \lt{}integer\gt{}]
2581 \index[dir]{Minimum }
2582 This specifies the minimum value that the counter can have. It also becomes
2583 the default. If not supplied, zero is assumed.
2585 \item [Maximum = \lt{}integer\gt{}]
2586 \index[dir]{Maximum }
2587 This is the maximum value value that the counter can have. If not specified
2588 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
2589 the 31 power). When the counter is incremented past this value, it is reset
2592 \item [*WrapCounter = \lt{}counter-name\gt{}]
2593 \index[dir]{*WrapCounter }
2594 If this value is specified, when the counter is incremented past the
2596 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
2597 is incremented. (This is not currently implemented).
2599 \item [Catalog = \lt{}catalog-name\gt{}]
2600 \index[dir]{Catalog }
2601 If this directive is specified, the counter and its values will be saved in
2602 the specified catalog. If this directive is not present, the counter will be
2603 redefined each time that Bacula is started.
2606 \subsection*{Example Director Configuration File}
2607 \label{SampleDirectorConfiguration}
2608 \index[general]{File!Example Director Configuration}
2609 \index[general]{Example Director Configuration File}
2610 \addcontentsline{toc}{subsection}{Example Director Configuration File}
2612 An example Director configuration file might be the following:
2617 # Default Bacula Director Configuration file
2619 # The only thing that MUST be changed is to add one or more
2620 # file or directory names in the Include directive of the
2623 # For Bacula release 1.15 (5 March 2002) -- redhat
2625 # You might also want to change the default email address
2626 # from root to your address. See the "mail" and "operator"
2627 # directives in the Messages resource.
2629 Director { # define myself
2631 QueryFile = "/home/kern/bacula/bin/query.sql"
2632 WorkingDirectory = "/home/kern/bacula/bin/working"
2633 PidDirectory = "/home/kern/bacula/bin/working"
2634 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
2636 # Define the backup Job
2638 Name = "NightlySave"
2640 Level = Incremental # default
2643 Schedule = "WeeklyCycle"
2653 Where = /tmp/bacula-restores
2659 # List of files to be backed up
2663 Options { signature=SHA1 }
2665 # Put your list of files here, one per line or include an
2666 # external list with:
2670 # Note: / backs up everything
2675 # When to do the backups
2677 Name = "WeeklyCycle"
2678 Run = Full sun at 1:05
2679 Run = Incremental mon-sat at 1:05
2681 # Client (File Services) to backup
2686 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
2687 File Retention = 60d # sixty day file retention
2688 Job Retention = 1y # 1 year Job retention
2689 AutoPrune = yes # Auto apply retention periods
2691 # Definition of DLT tape storage device
2695 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2696 Device = "HP DLT 80" # same as Device in Storage daemon
2697 Media Type = DLT8000 # same as MediaType in Storage daemon
2699 # Definition for a DLT autochanger device
2703 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2704 Device = "Autochanger" # same as Device in Storage daemon
2705 Media Type = DLT-8000 # Different from DLTDrive
2708 # Definition of DDS tape storage device
2712 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2713 Device = SDT-10000 # same as Device in Storage daemon
2714 Media Type = DDS-4 # same as MediaType in Storage daemon
2716 # Definition of 8mm tape storage device
2720 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2721 Device = "Exabyte 8mm"
2724 # Definition of file storage device
2728 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
2729 Device = FileStorage
2732 # Generic catalog service
2735 dbname = bacula; user = bacula; password = ""
2737 # Reasonable message delivery -- send most everything to
2738 # the email address and to the console
2741 mail = root@localhost = all, !skipped, !terminate
2742 operator = root@localhost = mount
2743 console = all, !skipped, !saved
2746 # Default pool definition
2754 # Restricted console used by tray-monitor to get the status of the director
2758 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
2759 CommandACL = status, .status