4 \chapter{Configuring the Director}
5 \label{DirectorChapter}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
9 Of all the configuration files needed to run {\bf Bacula}, the Director's is
10 the most complicated, and the one that you will need to modify the most often
11 as you add clients or modify the FileSets.
13 For a general discussion of configuration files and resources including the
14 data types recognized by {\bf Bacula}. Please see the
15 \ilink{Configuration}{ConfigureChapter} chapter of this manual.
17 \section{Director Resource Types}
18 \index[general]{Types!Director Resource}
19 \index[general]{Director Resource Types}
21 Director resource type may be one of the following:
23 Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
24 Messages. We present them here in the most logical order for defining them:
26 Note, everything revolves around a job and is tied to a job in one
31 \ilink{Director}{DirectorResource4} -- to define the Director's
32 name and its access password used for authenticating the Console program.
33 Only a single Director resource definition may appear in the Director's
34 configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
35 machine, Bacula will generate a random password during the configuration
36 process, otherwise it will be left blank.
38 \ilink{Job}{JobResource} -- to define the backup/restore Jobs
39 and to tie together the Client, FileSet and Schedule resources to be used
40 for each Job. Normally, you will Jobs of different names corresponding
41 to each client (i.e. one Job per client, but a different one with a different name
44 \ilink{JobDefs}{JobDefsResource} -- optional resource for
45 providing defaults for Job resources.
47 \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
48 be automatically run by {\bf Bacula's} internal scheduler. You
49 may have any number of Schedules, but each job will reference only
52 \ilink{FileSet}{FileSetResource} -- to define the set of files
53 to be backed up for each Client. You may have any number of
54 FileSets but each Job will reference only one.
56 \ilink{Client}{ClientResource2} -- to define what Client is to be
57 backed up. You will generally have multiple Client definitions. Each
58 Job will reference only a single client.
60 \ilink{Storage}{StorageResource2} -- to define on what physical
61 device the Volumes should be mounted. You may have one or
62 more Storage definitions.
64 \ilink{Pool}{PoolResource} -- to define the pool of Volumes
65 that can be used for a particular Job. Most people use a
66 single default Pool. However, if you have a large number
67 of clients or volumes, you may want to have multiple Pools.
68 Pools allow you to restrict a Job (or a Client) to use
69 only a particular set of Volumes.
71 \ilink{Catalog}{CatalogResource} -- to define in what database to
72 keep the list of files and the Volume names where they are backed up.
73 Most people only use a single catalog. However, if you want to
74 scale the Director to many clients, multiple catalogs can be helpful.
75 Multiple catalogs require a bit more management because in general
76 you must know what catalog contains what data. Currently, all
77 Pools are defined in each catalog. This restriction will be removed
80 \ilink{Messages}{MessagesChapter} -- to define where error and
81 information messages are to be sent or logged. You may define
82 multiple different message resources and hence direct particular
83 classes of messages to different users or locations (files, ...).
86 \section{The Director Resource}
87 \label{DirectorResource4}
88 \index[general]{Director Resource}
89 \index[general]{Resource!Director}
91 The Director resource defines the attributes of the Directors running on the
92 network. In the current implementation, there is only a single Director
93 resource, but the final design will contain multiple Directors to maintain
94 index and media database redundancy.
100 Start of the Director resource. One and only one director resource must be
103 \item [Name = \lt{}name\gt{}]
105 \index[dir]{Directive!Name}
106 The director name used by the system administrator. This directive is
109 \item [Description = \lt{}text\gt{}]
110 \index[dir]{Description}
111 \index[dir]{Directive!Description}
112 The text field contains a description of the Director that will be displayed
113 in the graphical user interface. This directive is optional.
115 \item [Password = \lt{}UA-password\gt{}]
116 \index[dir]{Password}
117 \index[dir]{Directive!Password}
118 Specifies the password that must be supplied for the default Bacula
119 Console to be authorized. The same password must appear in the {\bf
120 Director} resource of the Console configuration file. For added
121 security, the password is never passed across the network but instead a
122 challenge response hash code created with the password. This directive
123 is required. If you have either {\bf /dev/random} or {\bf bc} on your
124 machine, Bacula will generate a random password during the configuration
125 process, otherwise it will be left blank and you must manually supply
128 The password is plain text. It is not generated through any special
129 process but as noted above, it is better to use random text for
132 \item [Messages = \lt{}Messages-resource-name\gt{}]
133 \index[dir]{Messages}
134 \index[dir]{Directive!Messages}
135 The messages resource specifies where to deliver Director messages that are
136 not associated with a specific Job. Most messages are specific to a job and
137 will be directed to the Messages resource specified by the job. However,
138 there are a few messages that can occur when no job is running. This
139 directive is required.
141 \item [Working Directory = \lt{}Directory\gt{}]
142 \index[dir]{Working Directory}
143 \index[dir]{Directive!Working Directory}
144 This directive is mandatory and specifies a directory in which the Director
145 may put its status files. This directory should be used only by Bacula but
146 may be shared by other Bacula daemons. However, please note, if this
147 directory is shared with other Bacula daemons (the File daemon and Storage
148 daemon), you must ensure that the {\bf Name} given to each daemon is
149 unique so that the temporary filenames used do not collide. By default
150 the Bacula configure process creates unique daemon names by postfixing them
151 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
152 Directory} is done when the configuration file is read so that values such
153 as {\bf \$HOME} will be properly expanded. This directive is required.
154 The working directory specified must already exist and be
155 readable and writable by the Bacula daemon referencing it.
157 If you have specified a Director user and/or a Director group on your
158 ./configure line with {\bf {-}{-}with-dir-user} and/or
159 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
160 be set to those values.
162 \item [Pid Directory = \lt{}Directory\gt{}]
163 \index[dir]{Pid Directory}
164 \index[dir]{Directive!Pid Directory}
165 This directive is mandatory and specifies a directory in which the Director
166 may put its process Id file. The process Id file is used to shutdown
167 Bacula and to prevent multiple copies of Bacula from running simultaneously.
168 Standard shell expansion of the {\bf Directory} is done when the
169 configuration file is read so that values such as {\bf \$HOME} will be
172 The PID directory specified must already exist and be
173 readable and writable by the Bacula daemon referencing it
175 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
176 not installing Bacula in the system directories, you can use the {\bf Working
177 Directory} as defined above. This directive is required.
179 \item [Scripts Directory = \lt{}Directory\gt{}]
180 \index[dir]{Scripts Directory}
181 \index[dir]{Directive!Scripts Directory}
182 This directive is optional and, if defined, specifies a directory in
183 which the Director will look for the Python startup script {\bf
184 DirStartup.py}. This directory may be shared by other Bacula daemons.
185 Standard shell expansion of the directory is done when the configuration
186 file is read so that values such as {\bf \$HOME} will be properly
189 \item [QueryFile = \lt{}Path\gt{}]
190 \index[dir]{QueryFile}
191 \index[dir]{Directive!QueryFile}
192 This directive is mandatory and specifies a directory and file in which
193 the Director can find the canned SQL statements for the {\bf Query}
194 command of the Console. Standard shell expansion of the {\bf Path} is
195 done when the configuration file is read so that values such as {\bf
196 \$HOME} will be properly expanded. This directive is required.
198 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
199 \index[dir]{Heartbeat Interval}
200 \index[dir]{Directive!Heartbeat}
201 This directive is optional and if specified will cause the Director to
202 set a keepalive interval (heartbeat) in seconds on each of the sockets
203 it opens for the Client resource. This value will override any
204 specified at the Director level. It is implemented only on systems
205 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
206 The default value is zero, which means no change is made to the socket.
209 \label{DirMaxConJobs}
210 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
211 \index[dir]{Maximum Concurrent Jobs}
212 \index[dir]{Directive!Maximum Concurrent Jobs}
213 \index[general]{Simultaneous Jobs}
214 \index[general]{Concurrent Jobs}
215 where \lt{}number\gt{} is the maximum number of total Director Jobs that
216 should run concurrently. The default is set to 1, but you may set it to a
219 The Volume format becomes more complicated with
220 multiple simultaneous jobs, consequently, restores may take longer if
221 Bacula must sort through interleaved volume blocks from multiple simultaneous
222 jobs. This can be avoided by having each simultaneous job write to
223 a different volume or by using data spooling, which will first spool the data
224 to disk simultaneously, then write one spool file at a time to the volume
225 thus avoiding excessive interleaving of the different job blocks.
227 \item [FD Connect Timeout = \lt{}time\gt{}]
228 \index[dir]{FD Connect Timeout}
229 \index[dir]{Directive!FD Connect Timeout}
230 where {\bf time} is the time that the Director should continue
231 attempting to contact the File daemon to start a job, and after which
232 the Director will cancel the job. The default is 30 minutes.
234 \item [SD Connect Timeout = \lt{}time\gt{}]
235 \index[dir]{SD Connect Timeout}
236 \index[dir]{Directive!SD Connect Timeout}
237 where {\bf time} is the time that the Director should continue
238 attempting to contact the Storage daemon to start a job, and after which
239 the Director will cancel the job. The default is 30 minutes.
241 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
242 \index[dir]{DirAddresses}
244 \index[general]{Address}
245 \index[dir]{Directive!DirAddresses}
246 Specify the ports and addresses on which the Director daemon will listen
247 for Bacula Console connections. Probably the simplest way to explain
248 this is to show an example:
253 ip = { addr = 1.2.3.4; port = 1205;}
255 addr = 1.2.3.4; port = http;}
264 ip = { addr = 1.2.3.4 }
265 ip = { addr = 201:220:222::2 }
267 addr = bluedot.thun.net
273 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
274 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
275 a symbolic name (only in the ip specification). Also, port can be specified
276 as a number or as the mnemonic value from the /etc/services file. If a port
277 is not specified, the default will be used. If an ip section is specified,
278 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
279 only IPv4 resolutions will be permitted, and likewise with ip6.
281 Please note that if you use the DirAddresses directive, you must
282 not use either a DirPort or a DirAddress directive in the same
285 \item [DirPort = \lt{}port-number\gt{}]
287 \index[dir]{Directive!DirPort}
288 Specify the port (a positive integer) on which the Director daemon will
289 listen for Bacula Console connections. This same port number must be
290 specified in the Director resource of the Console configuration file. The
291 default is 9101, so normally this directive need not be specified. This
292 directive should not be used if you specify DirAddresses (N.B plural)
295 \item [DirAddress = \lt{}IP-Address\gt{}]
296 \index[dir]{DirAddress}
297 \index[dir]{Directive!DirAddress}
298 This directive is optional, but if it is specified, it will cause the
299 Director server (for the Console program) to bind to the specified {\bf
300 IP-Address}, which is either a domain name or an IP address specified as a
301 dotted quadruple in string or quoted string format. If this directive is
302 not specified, the Director will bind to any available address (the
303 default). Note, unlike the DirAddresses specification noted above, this
304 directive only permits a single address to be specified. This directive
305 should not be used if you specify a DirAddresses (N.B. plural) directive.
307 \item[Statistics Retention = \lt{}time\gt{}]
308 \index[dir]{StatisticsRetention}
309 \index[dir]{Directive!StatisticsRetention}
310 \label{PruneStatistics}
312 The \texttt{Statistics Retention} directive defines the length of time that
313 Bacula will keep statistics job records in the Catalog database after the
314 Job End time. (In \texttt{JobHistory} table) When this time period expires,
315 and if user runs \texttt{prune stats} command, Bacula will prune (remove)
316 Job records that are older than the specified period.
318 Theses statistics records aren't use for restore purpose, but mainly for
319 capacity planning, billings, etc. See \ilink{Statistics chapter} for
320 additional information.
322 See the \ilink{ Configuration chapter}{Time} of this manual for additional
323 details of time specification.
325 The default is 5 years.
327 \item[VerId = \lt{}string\gt{}]
328 \index[dir]{Directive!VerId}
329 where \lt{}string\gt{} is an identifier which can be used for support purpose.
330 This string is displayed using the \texttt{version} command.
332 \item[MaxConsoleConnections = \lt{}number\gt{}]
333 \index[dir]{MaximumConsoleConnections}
334 \index[dir]{MaxConsoleConnections}
335 \index[dir]{Directive!MaxConsoleConnections}
337 where \lt{}number\gt{} is the maximum number of Console Connections that
338 could run concurrently. The default is set to 20, but you may set it to a
343 The following is an example of a valid Director resource definition:
349 WorkingDirectory = "$HOME/bacula/bin/working"
350 Password = UA_password
351 PidDirectory = "$HOME/bacula/bin/working"
352 QueryFile = "$HOME/bacula/bin/query.sql"
358 \section{The Job Resource}
360 \index[general]{Resource!Job}
361 \index[general]{Job Resource}
363 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
364 perform. Each Job resource definition contains the name of a Client and
365 a FileSet to backup, the Schedule for the Job, where the data
366 are to be stored, and what media Pool can be used. In effect, each Job
367 resource must specify What, Where, How, and When or FileSet, Storage,
368 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
369 be specified for a restore job for historical reasons, but it is no longer used.
371 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
372 job. If you want to backup multiple FileSets on the same Client or multiple
373 Clients, you must define a Job for each one.
375 Note, you define only a single Job to do the Full, Differential, and
376 Incremental backups since the different backup levels are tied together by
377 a unique Job name. Normally, you will have only one Job per Client, but
378 if a client has a really huge number of files (more than several million),
379 you might want to split it into to Jobs each with a different FileSet
380 covering only part of the total files.
382 Multiple Storage daemons are not currently supported for Jobs, so if
383 you do want to use multiple storage daemons, you will need to create
384 a different Job and ensure that for each Job that the combination of
385 Client and FileSet are unique. The Client and FileSet are what Bacula
386 uses to restore a client, so if there are multiple Jobs with the same
387 Client and FileSet or multiple Storage daemons that are used, the
388 restore will not work. This problem can be resolved by defining multiple
389 FileSet definitions (the names must be different, but the contents of
390 the FileSets may be the same).
397 \index[dir]{Directive!Job}
398 Start of the Job resource. At least one Job resource is required.
400 \item [Name = \lt{}name\gt{}]
402 \index[dir]{Directive!Name}
403 The Job name. This name can be specified on the {\bf Run} command in the
404 console program to start a job. If the name contains spaces, it must be
405 specified between quotes. It is generally a good idea to give your job the
406 same name as the Client that it will backup. This permits easy
407 identification of jobs.
409 When the job actually runs, the unique Job Name will consist of the name you
410 specify here followed by the date and time the job was scheduled for
411 execution. This directive is required.
413 \item [Enabled = \lt{}yes|no\gt{}]
415 \index[dir]{Directive!Enable}
416 This directive allows you to enable or disable automatic execution
417 via the scheduler of a Job.
419 \item [Type = \lt{}job-type\gt{}]
421 \index[dir]{Directive!Type}
422 The {\bf Type} directive specifies the Job type, which may be one of the
423 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
424 directive is required. Within a particular Job Type, there are also Levels
425 as discussed in the next item.
431 Run a backup Job. Normally you will have at least one Backup job for each
432 client you want to save. Normally, unless you turn off cataloging, most all
433 the important statistics and data concerning files backed up will be placed
438 Run a restore Job. Normally, you will specify only one Restore job
439 which acts as a sort of prototype that you will modify using the console
440 program in order to perform restores. Although certain basic
441 information from a Restore job is saved in the catalog, it is very
442 minimal compared to the information stored for a Backup job -- for
443 example, no File database entries are generated since no Files are
446 {\bf Restore} jobs cannot be
447 automatically started by the scheduler as is the case for Backup, Verify
448 and Admin jobs. To restore files, you must use the {\bf restore} command
454 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
455 contents of the catalog to the file system, or to what was backed up. In
456 addition, to verifying that a tape that was written can be read, you can
457 also use {\bf verify} as a sort of tripwire intrusion detection.
461 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
462 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
463 Although an Admin job is recorded in the catalog, very little data is saved.
468 \item [Level = \lt{}job-level\gt{}]
470 \index[dir]{Directive!Level}
471 The Level directive specifies the default Job level to be run. Each
472 different Job Type (Backup, Restore, ...) has a different set of Levels
473 that can be specified. The Level is normally overridden by a different
474 value that is specified in the {\bf Schedule} resource. This directive
475 is not required, but must be specified either by a {\bf Level} directive
476 or as an override specified in the {\bf Schedule} resource.
478 For a {\bf Backup} Job, the Level may be one of the following:
484 When the Level is set to Full all files in the FileSet whether or not
485 they have changed will be backed up.
488 \index[dir]{Incremental}
489 When the Level is set to Incremental all files specified in the FileSet
490 that have changed since the last successful backup of the the same Job
491 using the same FileSet and Client, will be backed up. If the Director
492 cannot find a previous valid Full backup then the job will be upgraded
493 into a Full backup. When the Director looks for a valid backup record
494 in the catalog database, it looks for a previous Job with:
497 \item The same Job name.
498 \item The same Client name.
499 \item The same FileSet (any change to the definition of the FileSet such as
500 adding or deleting a file in the Include or Exclude sections constitutes a
502 \item The Job was a Full, Differential, or Incremental backup.
503 \item The Job terminated normally (i.e. did not fail or was not canceled).
504 \item The Job started no longer ago than {\bf Max Full Age}.
507 If all the above conditions do not hold, the Director will upgrade the
508 Incremental to a Full save. Otherwise, the Incremental backup will be
509 performed as requested.
511 The File daemon (Client) decides which files to backup for an
512 Incremental backup by comparing start time of the prior Job (Full,
513 Differential, or Incremental) against the time each file was last
514 "modified" (st\_mtime) and the time its attributes were last
515 "changed"(st\_ctime). If the file was modified or its attributes
516 changed on or after this start time, it will then be backed up.
518 Some virus scanning software may change st\_ctime while
519 doing the scan. For example, if the virus scanning program attempts to
520 reset the access time (st\_atime), which Bacula does not use, it will
521 cause st\_ctime to change and hence Bacula will backup the file during
522 an Incremental or Differential backup. In the case of Sophos virus
523 scanning, you can prevent it from resetting the access time (st\_atime)
524 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
525 option. For other software, please see their manual.
527 When Bacula does an Incremental backup, all modified files that are
528 still on the system are backed up. However, any file that has been
529 deleted since the last Full backup remains in the Bacula catalog,
530 which means that if between a Full save and the time you do a
531 restore, some files are deleted, those deleted files will also be
532 restored. The deleted files will no longer appear in the catalog
533 after doing another Full save.
535 In addition, if you move a directory rather than copy it, the files in
536 it do not have their modification time (st\_mtime) or their attribute
537 change time (st\_ctime) changed. As a consequence, those files will
538 probably not be backed up by an Incremental or Differential backup which
539 depend solely on these time stamps. If you move a directory, and wish
540 it to be properly backed up, it is generally preferable to copy it, then
543 However, to manage deleted files or directories changes in the
544 catalog during an Incremental backup you can use \texttt{accurate}
545 mode. This is quite memory consuming process. See \ilink{Accurate
546 mode}{accuratemode} for more details.
549 \index[dir]{Differential}
550 When the Level is set to Differential
551 all files specified in the FileSet that have changed since the last
552 successful Full backup of the same Job will be backed up.
553 If the Director cannot find a
554 valid previous Full backup for the same Job, FileSet, and Client,
555 backup, then the Differential job will be upgraded into a Full backup.
556 When the Director looks for a valid Full backup record in the catalog
557 database, it looks for a previous Job with:
560 \item The same Job name.
561 \item The same Client name.
562 \item The same FileSet (any change to the definition of the FileSet such as
563 adding or deleting a file in the Include or Exclude sections constitutes a
565 \item The Job was a FULL backup.
566 \item The Job terminated normally (i.e. did not fail or was not canceled).
567 \item The Job started no longer ago than {\bf Max Full Age}.
570 If all the above conditions do not hold, the Director will upgrade the
571 Differential to a Full save. Otherwise, the Differential backup will be
572 performed as requested.
574 The File daemon (Client) decides which files to backup for a
575 differential backup by comparing the start time of the prior Full backup
576 Job against the time each file was last "modified" (st\_mtime) and the
577 time its attributes were last "changed" (st\_ctime). If the file was
578 modified or its attributes were changed on or after this start time, it
579 will then be backed up. The start time used is displayed after the {\bf
580 Since} on the Job report. In rare cases, using the start time of the
581 prior backup may cause some files to be backed up twice, but it ensures
582 that no change is missed. As with the Incremental option, you should
583 ensure that the clocks on your server and client are synchronized or as
584 close as possible to avoid the possibility of a file being skipped.
585 Note, on versions 1.33 or greater Bacula automatically makes the
586 necessary adjustments to the time between the server and the client so
587 that the times Bacula uses are synchronized.
589 When Bacula does a Differential backup, all modified files that are
590 still on the system are backed up. However, any file that has been
591 deleted since the last Full backup remains in the Bacula catalog, which
592 means that if between a Full save and the time you do a restore, some
593 files are deleted, those deleted files will also be restored. The
594 deleted files will no longer appear in the catalog after doing another
595 Full save. However, to remove deleted files from the catalog during a
596 Differential backup is quite a time consuming process and not currently
597 implemented in Bacula. It is, however, a planned future feature.
599 As noted above, if you move a directory rather than copy it, the
600 files in it do not have their modification time (st\_mtime) or
601 their attribute change time (st\_ctime) changed. As a
602 consequence, those files will probably not be backed up by an
603 Incremental or Differential backup which depend solely on these
604 time stamps. If you move a directory, and wish it to be
605 properly backed up, it is generally preferable to copy it, then
606 delete the original. Alternatively, you can move the directory, then
607 use the {\bf touch} program to update the timestamps.
609 %% TODO: merge this with incremental
610 However, to manage deleted files or directories changes in the
611 catalog during an Differential backup you can use \texttt{accurate}
612 mode. This is quite memory consuming process. See \ilink{Accurate
613 mode}{accuratemode} for more details.
615 Every once and a while, someone asks why we need Differential
616 backups as long as Incremental backups pickup all changed files.
617 There are possibly many answers to this question, but the one
618 that is the most important for me is that a Differential backup
620 all the Incremental and Differential backups since the last Full backup
621 into a single Differential backup. This has two effects: 1. It gives
622 some redundancy since the old backups could be used if the merged backup
623 cannot be read. 2. More importantly, it reduces the number of Volumes
624 that are needed to do a restore effectively eliminating the need to read
625 all the volumes on which the preceding Incremental and Differential
626 backups since the last Full are done.
630 For a {\bf Restore} Job, no level needs to be specified.
632 For a {\bf Verify} Job, the Level may be one of the following:
637 \index[dir]{InitCatalog}
638 does a scan of the specified {\bf FileSet} and stores the file
639 attributes in the Catalog database. Since no file data is saved, you
640 might ask why you would want to do this. It turns out to be a very
641 simple and easy way to have a {\bf Tripwire} like feature using {\bf
642 Bacula}. In other words, it allows you to save the state of a set of
643 files defined by the {\bf FileSet} and later check to see if those files
644 have been modified or deleted and if any new files have been added.
645 This can be used to detect system intrusion. Typically you would
646 specify a {\bf FileSet} that contains the set of system files that
647 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
648 run the {\bf InitCatalog} level verify one time when your system is
649 first setup, and then once again after each modification (upgrade) to
650 your system. Thereafter, when your want to check the state of your
651 system files, you use a {\bf Verify} {\bf level = Catalog}. This
652 compares the results of your {\bf InitCatalog} with the current state of
657 Compares the current state of the files against the state previously
658 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
659 items reported are determined by the {\bf verify} options specified on
660 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
661 FileSet} resource below for more details). Typically this command will
662 be run once a day (or night) to check for any changes to your system
665 Please note! If you run two Verify Catalog jobs on the same client at
666 the same time, the results will certainly be incorrect. This is because
667 Verify Catalog modifies the Catalog database while running in order to
670 \item [VolumeToCatalog]
671 \index[dir]{VolumeToCatalog}
672 This level causes Bacula to read the file attribute data written to the
673 Volume from the last Job. The file attribute data are compared to the
674 values saved in the Catalog database and any differences are reported.
675 This is similar to the {\bf Catalog} level except that instead of
676 comparing the disk file attributes to the catalog database, the
677 attribute data written to the Volume is read and compared to the catalog
678 database. Although the attribute data including the signatures (MD5 or
679 SHA1) are compared, the actual file data is not compared (it is not in
682 Please note! If you run two Verify VolumeToCatalog jobs on the same
683 client at the same time, the results will certainly be incorrect. This
684 is because the Verify VolumeToCatalog modifies the Catalog database
687 \item [DiskToCatalog]
688 \index[dir]{DiskToCatalog}
689 This level causes Bacula to read the files as they currently are on
690 disk, and to compare the current file attributes with the attributes
691 saved in the catalog from the last backup for the job specified on the
692 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
693 level described above by the fact that it doesn't compare against a
694 previous Verify job but against a previous backup. When you run this
695 level, you must supply the verify options on your Include statements.
696 Those options determine what attribute fields are compared.
698 This command can be very useful if you have disk problems because it
699 will compare the current state of your disk against the last successful
700 backup, which may be several jobs.
702 Note, the current implementation (1.32c) does not identify files that
706 \item [Accurate = \lt{}yes|no\gt{}]
707 \index[dir]{Accurate}
708 In accurate mode, FileDaemon known exactly which files were present
709 after last backup. So it is able to handle deleted or renamed files.
711 When restoring a fileset for a specified date (including "most
712 recent"), Bacula is able to give you exactly the files and
713 directories that existed at the time of the last backup prior to
716 In this mode, FileDaemon have to keep all files in memory. So you have
717 to check that your memory and swap are sufficent.
719 $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
721 For 500.000 files (typical desktop linux system), it will take
722 around 64MB of RAM on your FileDaemon.
724 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
725 \index[dir]{Verify Job}
726 \index[dir]{Directive!Verify Job}
727 If you run a verify job without this directive, the last job run will be
728 compared with the catalog, which means that you must immediately follow
729 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
730 will find the last job with that name that ran. This permits you to run
731 all your backups, then run Verify jobs on those that you wish to be
732 verified (most often a {\bf VolumeToCatalog}) so that the tape just
735 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
737 \index[dir]{Directive!JobDefs}
738 If a JobDefs-Resource-Name is specified, all the values contained in the
739 named JobDefs resource will be used as the defaults for the current Job.
740 Any value that you explicitly define in the current Job resource, will
741 override any defaults specified in the JobDefs resource. The use of
742 this directive permits writing much more compact Job resources where the
743 bulk of the directives are defined in one or more JobDefs. This is
744 particularly useful if you have many similar Jobs but with minor
745 variations such as different Clients. A simple example of the use of
746 JobDefs is provided in the default bacula-dir.conf file.
748 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
749 \index[dir]{Bootstrap}
750 \index[dir]{Directive!Bootstrap}
751 The Bootstrap directive specifies a bootstrap file that, if provided,
752 will be used during {\bf Restore} Jobs and is ignored in other Job
753 types. The {\bf bootstrap} file contains the list of tapes to be used
754 in a restore Job as well as which files are to be restored.
755 Specification of this directive is optional, and if specified, it is
756 used only for a restore job. In addition, when running a Restore job
757 from the console, this value can be changed.
759 If you use the {\bf Restore} command in the Console program, to start a
760 restore job, the {\bf bootstrap} file will be created automatically from
761 the files you select to be restored.
763 For additional details of the {\bf bootstrap} file, please see
764 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
767 \label{writebootstrap}
768 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
769 \index[dir]{Write Bootstrap}
770 \index[dir]{Directive!Write Bootstrap}
771 The {\bf writebootstrap} directive specifies a file name where Bacula
772 will write a {\bf bootstrap} file for each Backup job run. This
773 directive applies only to Backup Jobs. If the Backup job is a Full
774 save, Bacula will erase any current contents of the specified file
775 before writing the bootstrap records. If the Job is an Incremental
777 save, Bacula will append the current bootstrap record to the end of the
780 Using this feature, permits you to constantly have a bootstrap file that
781 can recover the current state of your system. Normally, the file
782 specified should be a mounted drive on another machine, so that if your
783 hard disk is lost, you will immediately have a bootstrap record
784 available. Alternatively, you should copy the bootstrap file to another
785 machine after it is updated. Note, it is a good idea to write a separate
786 bootstrap file for each Job backed up including the job that backs up
787 your catalog database.
789 If the {\bf bootstrap-file-specification} begins with a vertical bar
790 (|), Bacula will use the specification as the name of a program to which
791 it will pipe the bootstrap record. It could for example be a shell
792 script that emails you the bootstrap record.
794 On versions 1.39.22 or greater, before opening the file or executing the
795 specified command, Bacula performs
796 \ilink{character substitution}{character substitution} like in RunScript
797 directive. To automatically manage your bootstrap files, you can use
798 this in your {\bf JobDefs} resources:
801 Write Bootstrap = "%c_%n.bsr"
806 For more details on using this file, please see the chapter entitled
807 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
809 \item [Client = \lt{}client-resource-name\gt{}]
811 \index[dir]{Directive!Client}
812 The Client directive specifies the Client (File daemon) that will be used in
813 the current Job. Only a single Client may be specified in any one Job. The
814 Client runs on the machine to be backed up, and sends the requested files to
815 the Storage daemon for backup, or receives them when restoring. For
816 additional details, see the
817 \ilink{Client Resource section}{ClientResource2} of this chapter.
818 This directive is required.
820 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
823 The FileSet directive specifies the FileSet that will be used in the
824 current Job. The FileSet specifies which directories (or files) are to
825 be backed up, and what options to use (e.g. compression, ...). Only a
826 single FileSet resource may be specified in any one Job. For additional
827 details, see the \ilink{FileSet Resource section}{FileSetResource} of
828 this chapter. This directive is required.
830 \item [Messages = \lt{}messages-resource-name\gt{}]
831 \index[dir]{Messages}
832 \index[dir]{Directive!Messages}
833 The Messages directive defines what Messages resource should be used for
834 this job, and thus how and where the various messages are to be
835 delivered. For example, you can direct some messages to a log file, and
836 others can be sent by email. For additional details, see the
837 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
838 directive is required.
840 \item [Pool = \lt{}pool-resource-name\gt{}]
842 \index[dir]{Directive!Pool}
843 The Pool directive defines the pool of Volumes where your data can be
844 backed up. Many Bacula installations will use only the {\bf Default}
845 pool. However, if you want to specify a different set of Volumes for
846 different Clients or different Jobs, you will probably want to use
847 Pools. For additional details, see the \ilink{Pool Resource
848 section}{PoolResource} of this chapter. This directive is required.
850 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
851 \index[dir]{Full Backup Pool}
852 \index[dir]{Directive!Full Backup Pool}
853 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
854 It will override any Pool specification during a Full backup. This
855 directive is optional.
857 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
858 \index[dir]{Differential Backup Pool}
859 \index[dir]{Directive!Differential Backup Pool}
860 The {\it Differential Backup Pool} specifies a Pool to be used for
861 Differential backups. It will override any Pool specification during a
862 Differential backup. This directive is optional.
864 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
865 \index[dir]{Incremental Backup Pool}
866 \index[dir]{Directive!Incremental Backup Pool}
867 The {\it Incremental Backup Pool} specifies a Pool to be used for
868 Incremental backups. It will override any Pool specification during an
869 Incremental backup. This directive is optional.
871 \item [Schedule = \lt{}schedule-name\gt{}]
872 \index[dir]{Schedule}
873 \index[dir]{Directive!Schedule}
874 The Schedule directive defines what schedule is to be used for the Job.
875 The schedule in turn determines when the Job will be automatically
876 started and what Job level (i.e. Full, Incremental, ...) is to be run.
877 This directive is optional, and if left out, the Job can only be started
878 manually using the Console program. Although you may specify only a
879 single Schedule resource for any one job, the Schedule resource may
880 contain multiple {\bf Run} directives, which allow you to run the Job at
881 many different times, and each {\bf run} directive permits overriding
882 the default Job Level Pool, Storage, and Messages resources. This gives
883 considerable flexibility in what can be done with a single Job. For
884 additional details, see the \ilink{Schedule Resource
885 Chapter}{ScheduleResource} of this manual.
888 \item [Storage = \lt{}storage-resource-name\gt{}]
890 \index[dir]{Directive!Storage}
891 The Storage directive defines the name of the storage services where you
892 want to backup the FileSet data. For additional details, see the
893 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
894 The Storage resource may also be specified in the Job's Pool resource,
895 in which case the value in the Pool resource overrides any value
896 in the Job. This Storage resource definition is not required by either
897 the Job resource or in the Pool, but it must be specified in
898 one or the other, if not an error will result.
900 \item [Max Start Delay = \lt{}time\gt{}]
901 \index[dir]{Max Start Delay}
902 \index[dir]{Directive!Max Start Delay}
903 The time specifies the maximum delay between the scheduled time and the
904 actual start time for the Job. For example, a job can be scheduled to
905 run at 1:00am, but because other jobs are running, it may wait to run.
906 If the delay is set to 3600 (one hour) and the job has not begun to run
907 by 2:00am, the job will be canceled. This can be useful, for example,
908 to prevent jobs from running during day time hours. The default is 0
909 which indicates no limit.
911 \item [Max Run Time = \lt{}time\gt{}]
912 \index[dir]{Max Run Time}
913 \index[dir]{Directive!Max Run Time}
914 The time specifies the maximum allowed time that a job may run, counted
915 from when the job starts, ({\bf not} necessarily the same as when the
918 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
919 \index[dir]{Incremental Wait Run Time}
920 \index[dir]{Differential Wait Run Time}
921 \index[dir]{Directive!Differential Max Wait Time}
922 Theses directives have been deprecated in favor of
923 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
925 \item [Incremental Max Run Time = \lt{}time\gt{}]
926 \index[dir]{Incremental Max Run Time}
927 \index[dir]{Directive!Incremental Max Run Time}
928 The time specifies the maximum allowed time that an Incremental backup job may
929 run, counted from when the job starts, ({\bf not} necessarily the same as when
930 the job was scheduled).
932 \item [Differential Max Wait Time = \lt{}time\gt{}]
933 \index[dir]{Differential Max Run Time}
934 \index[dir]{Directive!Differential Max Run Time}
935 The time specifies the maximum allowed time that a Differential backup job may
936 run, counted from when the job starts, ({\bf not} necessarily the same as when
937 the job was scheduled).
939 \item [Max Run Sched Time = \lt{}time\gt{}]
940 \index[dir]{Max Run Sched Time}
941 \index[dir]{Directive!Max Run Sched Time}
943 The time specifies the maximum allowed time that a job may run, counted from
944 when the job was scheduled. This can be useful to prevent jobs from running
945 during working hours. We can see it like \texttt{Max Start Delay + Max Run
948 \item [Max Wait Time = \lt{}time\gt{}]
949 \index[dir]{Max Wait Time}
950 \index[dir]{Directive!Max Wait Time}
951 The time specifies the maximum allowed time that a job may block waiting
952 for a resource (such as waiting for a tape to be mounted, or waiting for
953 the storage or file daemons to perform their duties), counted from the
954 when the job starts, ({\bf not} necessarily the same as when the job was
955 scheduled). This directive works as expected since bacula 2.3.18.
957 \addcontentsline{lof}{figure}{Job time control directives}
958 \includegraphics{\idir different_time.eps}
960 \item [Max Full Age = \lt{}time\gt{}]
961 \index[dir]{Max Full Age}
962 \index[dir]{Directive!Max Full Age}
963 The time specifies the maximum allowed age (counting from start time) of
964 the most recent successful Full backup that is required in order to run
965 Incremental or Differential backup jobs. If the most recent Full backup
966 is older than this interval, Incremental and Differential backups will be
967 upgraded to Full backups automatically. If this directive is not present,
968 or specified as 0, then the age of the previous Full backup is not
971 \label{PreferMountedVolumes}
972 \item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
973 \index[dir]{Prefer Mounted Volumes}
974 \index[dir]{Directive!Prefer Mounted Volumes}
975 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
976 yes), the Storage daemon is requested to select either an Autochanger or
977 a drive with a valid Volume already mounted in preference to a drive
978 that is not ready. This means that all jobs will attempt to append
979 to the same Volume (providing the Volume is appropriate -- right Pool,
980 ... for that job). If no drive with a suitable Volume is available, it
981 will select the first available drive. Note, any Volume that has
982 been requested to be mounted, will be considered valid as a mounted
983 volume by another job. This if multiple jobs start at the same time
984 and they all prefer mounted volumes, the first job will request the
985 mount, and the other jobs will use the same volume.
987 If the directive is set to {\bf no}, the Storage daemon will prefer
988 finding an unused drive, otherwise, each job started will append to the
989 same Volume (assuming the Pool is the same for all jobs). Setting
990 Prefer Mounted Volumes to no can be useful for those sites
991 with multiple drive autochangers that prefer to maximize backup
992 throughput at the expense of using additional drives and Volumes.
993 This means that the job will prefer to use an unused drive rather
994 than use a drive that is already in use.
996 \item [Prune Jobs = \lt{}yes|no\gt{}]
997 \index[dir]{Prune Jobs}
998 \index[dir]{Directive!Prune Jobs}
999 Normally, pruning of Jobs from the Catalog is specified on a Client by
1000 Client basis in the Client resource with the {\bf AutoPrune} directive.
1001 If this directive is specified (not normally) and the value is {\bf
1002 yes}, it will override the value specified in the Client resource. The
1003 default is {\bf no}.
1006 \item [Prune Files = \lt{}yes|no\gt{}]
1007 \index[dir]{Prune Files}
1008 \index[dir]{Directive!Prune Files}
1009 Normally, pruning of Files from the Catalog is specified on a Client by
1010 Client basis in the Client resource with the {\bf AutoPrune} directive.
1011 If this directive is specified (not normally) and the value is {\bf
1012 yes}, it will override the value specified in the Client resource. The
1013 default is {\bf no}.
1015 \item [Prune Volumes = \lt{}yes|no\gt{}]
1016 \index[dir]{Prune Volumes}
1017 \index[dir]{Directive!Prune Volumes}
1018 Normally, pruning of Volumes from the Catalog is specified on a Client
1019 by Client basis in the Client resource with the {\bf AutoPrune}
1020 directive. If this directive is specified (not normally) and the value
1021 is {\bf yes}, it will override the value specified in the Client
1022 resource. The default is {\bf no}.
1024 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1025 \index[dir]{RunScript}
1026 \index[dir]{Directive!Run Script}
1028 This directive is implemented in version 1.39.22 and later.
1029 The RunScript directive behaves like a resource in that it
1030 requires opening and closing braces around a number of directives
1031 that make up the body of the runscript.
1033 The specified {\bf Command} (see below for details) is run as an
1034 external program prior or after the current Job. This is optional.
1036 \textbf{Console} options are special commands that are sent to the director instead
1037 of the OS. At this time, console command ouputs are redirected to log with
1040 You can use following console command : \texttt{delete}, \texttt{disable},
1041 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1042 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1043 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1044 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1045 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1046 more information. You need to specify needed information on command line, nothing
1047 will be prompted. Example :
1050 Console = "prune files client=%c"
1051 Console = "update stats age=3"
1054 You can specify more than one Command/Console option per RunScript.
1056 You can use following options may be specified in the body
1059 \begin{tabular}{|c|c|c|l}
1060 Options & Value & Default & Information \\
1063 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
1065 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
1067 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
1069 Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
1071 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
1072 something different from 0 \\
1074 Command & & & Path to your script\\
1076 Console & & & Console command\\
1081 Any output sent by the command to standard output will be included in the
1082 Bacula job report. The command string must be a valid program name or name
1085 In addition, the command string is parsed then fed to the OS,
1086 which means that the path will be searched to execute your specified
1087 command, but there is no shell interpretation, as a consequence, if you
1088 invoke complicated commands or want any shell features such as redirection
1089 or piping, you must call a shell script and do it inside that script.
1091 Before submitting the specified command to the operating system, Bacula
1092 performs character substitution of the following characters:
1094 \label{character substitution}
1099 %d = Director's name
1100 %e = Job Exit Status
1106 %t = Job type (Backup, ...)
1107 %v = Volume name (Only on director side)
1112 The Job Exit Status code \%e edits the following values:
1114 \index[dir]{Exit Status}
1121 \item Unknown term code
1124 Thus if you edit it on a command line, you will need to enclose
1125 it within some sort of quotes.
1128 You can use these following shortcuts:\\
1130 \begin{tabular}{|c|c|c|c|c|c}
1131 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1133 Run Before Job & & & Yes & No & Before \\
1135 Run After Job & Yes & No & & No & After \\
1137 Run After Failed Job & No & Yes & & No & After \\
1139 Client Run Before Job & & & Yes & Yes & Before \\
1141 Client Run After Job & Yes & No & & Yes & After \\
1149 Command = "/etc/init.d/apache stop"
1155 Command = "/etc/init.d/apache start"
1159 {\bf Notes about ClientRunBeforeJob}
1161 For compatibility reasons, with this shortcut, the command is executed
1162 directly when the client recieve it. And if the command is in error, other
1163 remote runscripts will be discarded. To be sure that all commands will be
1164 sent and executed, you have to use RunScript syntax.
1166 {\bf Special Windows Considerations}
1168 You can run scripts just after snapshots initializations with
1169 \textsl{AfterVSS} keyword.
1171 In addition, for a Windows client on version 1.33 and above, please take
1172 note that you must ensure a correct path to your script. The script or
1173 program can be a .com, .exe or a .bat file. If you just put the program
1174 name in then Bacula will search using the same rules that cmd.exe uses
1175 (current directory, Bacula bin directory, and PATH). It will even try the
1176 different extensions in the same order as cmd.exe.
1177 The command can be anything that cmd.exe or command.com will recognize
1178 as an executable file.
1180 However, if you have slashes in the program name then Bacula figures you
1181 are fully specifying the name, so you must also explicitly add the three
1182 character extension.
1184 The command is run in a Win32 environment, so Unix like commands will not
1185 work unless you have installed and properly configured Cygwin in addition
1186 to and separately from Bacula.
1188 The System \%Path\% will be searched for the command. (under the
1189 environment variable dialog you have have both System Environment and
1190 User Environment, we believe that only the System environment will be
1191 available to bacula-fd, if it is running as a service.)
1193 System environment variables can be referenced with \%var\% and
1194 used as either part of the command name or arguments.
1196 So if you have a script in the Bacula\\bin directory then the following lines
1201 Client Run Before Job = systemstate
1203 Client Run Before Job = systemstate.bat
1205 Client Run Before Job = "systemstate"
1207 Client Run Before Job = "systemstate.bat"
1209 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1213 The outer set of quotes is removed when the configuration file is parsed.
1214 You need to escape the inner quotes so that they are there when the code
1215 that parses the command line for execution runs so it can tell what the
1221 ClientRunBeforeJob = "\"C:/Program Files/Software
1222 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1226 The special characters
1230 will need to be quoted,
1231 if they are part of a filename or argument.
1233 If someone is logged in, a blank "command" window running the commands
1234 will be present during the execution of the command.
1236 Some Suggestions from Phil Stracchino for running on Win32 machines with
1237 the native Win32 File daemon:
1240 \item You might want the ClientRunBeforeJob directive to specify a .bat
1241 file which runs the actual client-side commands, rather than trying
1242 to run (for example) regedit /e directly.
1243 \item The batch file should explicitly 'exit 0' on successful completion.
1244 \item The path to the batch file should be specified in Unix form:
1246 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1248 rather than DOS/Windows form:
1250 ClientRunBeforeJob =
1252 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1256 For Win32, please note that there are certain limitations:
1258 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1260 Lines like the above do not work because there are limitations of
1261 cmd.exe that is used to execute the command.
1262 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1263 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1264 cmd prompt and see what happens. Once the command is correct insert a
1265 backslash (\textbackslash{}) before each double quote ("), and
1266 then put quotes around the whole thing when putting it in
1267 the director's .conf file. You either need to have only one set of quotes
1268 or else use the short name and don't put quotes around the command path.
1270 Below is the output from cmd's help as it relates to the command line
1271 passed to the /c option.
1274 If /C or /K is specified, then the remainder of the command line after
1275 the switch is processed as a command line, where the following logic is
1276 used to process quote (") characters:
1280 If all of the following conditions are met, then quote characters
1281 on the command line are preserved:
1284 \item exactly two quote characters.
1285 \item no special characters between the two quote characters,
1286 where special is one of:
1290 \item there are one or more whitespace characters between the
1291 the two quote characters.
1292 \item the string between the two quote characters is the name
1293 of an executable file.
1296 \item Otherwise, old behavior is to see if the first character is
1297 a quote character and if so, strip the leading character and
1298 remove the last quote character on the command line, preserving
1299 any text after the last quote character.
1304 The following example of the use of the Client Run Before Job directive was
1305 submitted by a user:\\
1306 You could write a shell script to back up a DB2 database to a FIFO. The shell
1316 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1321 The following line in the Job resource in the bacula-dir.conf file:
1324 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1329 When the job is run, you will get messages from the output of the script
1330 stating that the backup has started. Even though the command being run is
1331 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1332 command, thus the backup stalls.
1334 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1339 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1344 It is important to redirect the input and outputs of a backgrounded command to
1345 /dev/null to prevent the script from blocking.
1347 \item [Run Before Job = \lt{}command\gt{}]
1348 \index[dir]{Run Before Job}
1349 \index[dir]{Directive!Run Before Job}
1350 \index[dir]{Directive!Run Before Job}
1351 The specified {\bf command} is run as an external program prior to running the
1352 current Job. This directive is not required, but if it is defined, and if the
1353 exit code of the program run is non-zero, the current Bacula job will be
1357 Run Before Job = "echo test"
1359 it's equivalent to :
1362 Command = "echo test"
1368 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1369 simple way to modify your schedules during a holiday. For example, suppose
1370 that you normally do Full backups on Fridays, but Thursday and Friday are
1371 holidays. To avoid having to change tapes between Thursday and Friday when
1372 no one is in the office, you can create a RunBeforeJob that returns a
1373 non-zero status on Thursday and zero on all other days. That way, the
1374 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1375 before leaving will be used.
1377 \item [Run After Job = \lt{}command\gt{}]
1378 \index[dir]{Run After Job}
1379 \index[dir]{Directive!Run After Job}
1380 The specified {\bf command} is run as an external program if the current
1381 job terminates normally (without error or without being canceled). This
1382 directive is not required. If the exit code of the program run is
1383 non-zero, Bacula will print a warning message. Before submitting the
1384 specified command to the operating system, Bacula performs character
1385 substitution as described above for the {\bf RunScript} directive.
1387 An example of the use of this directive is given in the
1388 \ilink{Tips Chapter}{JobNotification} of this manual.
1390 See the {\bf Run After Failed Job} if you
1391 want to run a script after the job has terminated with any
1394 \item [Run After Failed Job = \lt{}command\gt{}]
1395 \index[dir]{Run After Job}
1396 \index[dir]{Directive!Run After Job}
1397 The specified {\bf command} is run as an external program after the current
1398 job terminates with any error status. This directive is not required. The
1399 command string must be a valid program name or name of a shell script. If
1400 the exit code of the program run is non-zero, Bacula will print a
1401 warning message. Before submitting the specified command to the
1402 operating system, Bacula performs character substitution as described above
1403 for the {\bf RunScript} directive. Note, if you wish that your script
1404 will run regardless of the exit status of the Job, you can use this :
1407 Command = "echo test"
1411 RunsOnSuccess = yes # default, you can drop this line
1415 An example of the use of this directive is given in the
1416 \ilink{Tips Chapter}{JobNotification} of this manual.
1419 \item [Client Run Before Job = \lt{}command\gt{}]
1420 \index[dir]{Client Run Before Job}
1421 \index[dir]{Directive!Client Run Before Job}
1422 This directive is the same as {\bf Run Before Job} except that the
1423 program is run on the client machine. The same restrictions apply to
1424 Unix systems as noted above for the {\bf RunScript}.
1426 \item [Client Run After Job = \lt{}command\gt{}]
1427 \index[dir]{Client Run After Job}
1428 \index[dir]{Directive!Client Run After Job}
1429 The specified {\bf command} is run on the client machine as soon
1430 as data spooling is complete in order to allow restarting applications
1431 on the client as soon as possible. .
1433 Note, please see the notes above in {\bf RunScript}
1434 concerning Windows clients.
1436 \item [Rerun Failed Levels = \lt{}yes|no\gt{}]
1437 \index[dir]{Rerun Failed Levels}
1438 \index[dir]{Directive!Rerun Failed Levels}
1439 If this directive is set to {\bf yes} (default no), and Bacula detects that
1440 a previous job at a higher level (i.e. Full or Differential) has failed,
1441 the current job level will be upgraded to the higher level. This is
1442 particularly useful for Laptops where they may often be unreachable, and if
1443 a prior Full save has failed, you wish the very next backup to be a Full
1444 save rather than whatever level it is started as.
1446 There are several points that must be taken into account when using this
1447 directive: first, a failed job is defined as one that has not terminated
1448 normally, which includes any running job of the same name (you need to
1449 ensure that two jobs of the same name do not run simultaneously);
1450 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1451 when checking for failed levels, which means that any FileSet change will
1454 \item [Spool Data = \lt{}yes|no\gt{}]
1455 \index[dir]{Spool Data}
1456 \index[dir]{Directive!Spool Data}
1458 If this directive is set to {\bf yes} (default no), the Storage daemon will
1459 be requested to spool the data for this Job to disk rather than write it
1460 directly to tape. Once all the data arrives or the spool files' maximum sizes
1461 are reached, the data will be despooled and written to tape. Spooling data
1462 prevents tape shoe-shine (start and stop) during
1463 Incremental saves. If you are writing to a disk file using this option
1464 will probably just slow down the backup jobs.
1466 NOTE: When this directive is set to yes, Spool Attributes is also
1467 automatically set to yes.
1469 \item [Spool Attributes = \lt{}yes|no\gt{}]
1470 \index[dir]{Spool Attributes}
1471 \index[dir]{Directive!Spool Attributes}
1473 \index[general]{slow}
1474 \index[dir]{Backups!slow}
1475 \index[general]{Backups!slow}
1476 The default is set to {\bf no}, which means that the File attributes are
1477 sent by the Storage daemon to the Director as they are stored on tape.
1478 However, if you want to avoid the possibility that database updates will
1479 slow down writing to the tape, you may want to set the value to {\bf
1480 yes}, in which case the Storage daemon will buffer the File attributes
1481 and Storage coordinates to a temporary file in the Working Directory,
1482 then when writing the Job data to the tape is completed, the attributes
1483 and storage coordinates will be sent to the Director.
1485 NOTE: When Spool Data is set to yes, Spool Attributes is also
1486 automatically set to yes.
1488 \item [Where = \lt{}directory\gt{}]
1490 \index[dir]{Directive!Where}
1491 This directive applies only to a Restore job and specifies a prefix to
1492 the directory name of all files being restored. This permits files to
1493 be restored in a different location from which they were saved. If {\bf
1494 Where} is not specified or is set to backslash ({\bf /}), the files will
1495 be restored to their original location. By default, we have set {\bf
1496 Where} in the example configuration files to be {\bf
1497 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1500 \item [Add Prefix = \lt{}directory\gt{}]
1501 \label{confaddprefix}
1502 \index[dir]{AddPrefix}
1503 \index[dir]{Directive!AddPrefix}
1504 This directive applies only to a Restore job and specifies a prefix to the
1505 directory name of all files being restored. This will use \ilink{File
1506 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1508 \item [Add Suffix = \lt{}extention\gt{}]
1509 \index[dir]{AddSuffix}
1510 \index[dir]{Directive!AddSuffix}
1511 This directive applies only to a Restore job and specifies a suffix to all
1512 files being restored. This will use \ilink{File Relocation}{filerelocation}
1513 feature implemented in Bacula 2.1.8 or later.
1515 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1516 \texttt{/etc/passwsd.old}
1518 \item [Strip Prefix = \lt{}directory\gt{}]
1519 \index[dir]{StripPrefix}
1520 \index[dir]{Directive!StripPrefix}
1521 This directive applies only to a Restore job and specifies a prefix to remove
1522 from the directory name of all files being restored. This will use the
1523 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1526 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1529 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1537 \item [RegexWhere = \lt{}expressions\gt{}]
1538 \index[dir]{RegexWhere}
1539 \index[dir]{Directive!RegexWhere}
1540 This directive applies only to a Restore job and specifies a regex filename
1541 manipulation of all files being restored. This will use \ilink{File
1542 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1544 For more informations about how use this option, see
1545 \ilink{this}{useregexwhere}.
1547 \item [Replace = \lt{}replace-option\gt{}]
1548 \index[dir]{Replace}
1549 \index[dir]{Directive!Replace}
1550 This directive applies only to a Restore job and specifies what happens
1551 when Bacula wants to restore a file or directory that already exists.
1552 You have the following options for {\bf replace-option}:
1558 when the file to be restored already exists, it is deleted and then
1559 replaced by the copy that was backed up. This is the default value.
1562 \index[dir]{ifnewer}
1563 if the backed up file (on tape) is newer than the existing file, the
1564 existing file is deleted and replaced by the back up.
1567 \index[dir]{ifolder}
1568 if the backed up file (on tape) is older than the existing file, the
1569 existing file is deleted and replaced by the back up.
1573 if the backed up file already exists, Bacula skips restoring this file.
1576 \item [Prefix Links=\lt{}yes|no\gt{}]
1577 \index[dir]{Prefix Links}
1578 \index[dir]{Directive!Prefix Links}
1579 If a {\bf Where} path prefix is specified for a recovery job, apply it
1580 to absolute links as well. The default is {\bf No}. When set to {\bf
1581 Yes} then while restoring files to an alternate directory, any absolute
1582 soft links will also be modified to point to the new alternate
1583 directory. Normally this is what is desired -- i.e. everything is self
1584 consistent. However, if you wish to later move the files to their
1585 original locations, all files linked with absolute names will be broken.
1587 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1588 \index[dir]{Maximum Concurrent Jobs}
1589 \index[dir]{Directive!Maximum Concurrent Jobs}
1590 where \lt{}number\gt{} is the maximum number of Jobs from the current
1591 Job resource that can run concurrently. Note, this directive limits
1592 only Jobs with the same name as the resource in which it appears. Any
1593 other restrictions on the maximum concurrent jobs such as in the
1594 Director, Client, or Storage resources will also apply in addition to
1595 the limit specified here. The default is set to 1, but you may set it
1596 to a larger number. We strongly recommend that you read the WARNING
1597 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1598 Director's resource.
1600 \item [Reschedule On Error = \lt{}yes|no\gt{}]
1601 \index[dir]{Reschedule On Error}
1602 \index[dir]{Directive!Reschedule On Error}
1603 If this directive is enabled, and the job terminates in error, the job
1604 will be rescheduled as determined by the {\bf Reschedule Interval} and
1605 {\bf Reschedule Times} directives. If you cancel the job, it will not
1606 be rescheduled. The default is {\bf no} (i.e. the job will not be
1609 This specification can be useful for portables, laptops, or other
1610 machines that are not always connected to the network or switched on.
1612 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1613 \index[dir]{Reschedule Interval}
1614 \index[dir]{Directive!Reschedule Interval}
1615 If you have specified {\bf Reschedule On Error = yes} and the job
1616 terminates in error, it will be rescheduled after the interval of time
1617 specified by {\bf time-specification}. See \ilink{the time
1618 specification formats}{Time} in the Configure chapter for details of
1619 time specifications. If no interval is specified, the job will not be
1620 rescheduled on error.
1622 \item [Reschedule Times = \lt{}count\gt{}]
1623 \index[dir]{Reschedule Times}
1624 \index[dir]{Directive!Reschedule Times}
1625 This directive specifies the maximum number of times to reschedule the
1626 job. If it is set to zero (the default) the job will be rescheduled an
1627 indefinite number of times.
1629 \item [Run = \lt{}job-name\gt{}]
1631 \index[dir]{Directive!Run}
1632 \index[dir]{Clone a Job}
1633 The Run directive (not to be confused with the Run option in a
1634 Schedule) allows you to start other jobs or to clone jobs. By using the
1635 cloning keywords (see below), you can backup
1636 the same data (or almost the same data) to two or more drives
1637 at the same time. The {\bf job-name} is normally the same name
1638 as the current Job resource (thus creating a clone). However, it
1639 may be any Job name, so one job may start other related jobs.
1641 The part after the equal sign must be enclosed in double quotes,
1642 and can contain any string or set of options (overrides) that you
1643 can specify when entering the Run command from the console. For
1644 example {\bf storage=DDS-4 ...}. In addition, there are two special
1645 keywords that permit you to clone the current job. They are {\bf level=\%l}
1646 and {\bf since=\%s}. The \%l in the level keyword permits
1647 entering the actual level of the current job and the \%s in the since
1648 keyword permits putting the same time for comparison as used on the
1649 current job. Note, in the case of the since keyword, the \%s must be
1650 enclosed in double quotes, and thus they must be preceded by a backslash
1651 since they are already inside quotes. For example:
1654 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1657 A cloned job will not start additional clones, so it is not
1658 possible to recurse.
1660 Please note that all cloned jobs, as specified in the Run directives are
1661 submitted for running before the original job is run (while it is being
1662 initialized). This means that any clone job will actually start before
1663 the original job, and may even block the original job from starting
1664 until the original job finishes unless you allow multiple simultaneous
1665 jobs. Even if you set a lower priority on the clone job, if no other
1666 jobs are running, it will start before the original job.
1668 If you are trying to prioritize jobs by using the clone feature (Run
1669 directive), you will find it much easier to do using a RunScript
1670 resource, or a RunBeforeJob directive.
1673 \item [Priority = \lt{}number\gt{}]
1674 \index[dir]{Priority}
1675 \index[dir]{Directive!Priority}
1676 This directive permits you to control the order in which your jobs will
1677 be run by specifying a positive non-zero number. The higher the number,
1678 the lower the job priority. Assuming you are not running concurrent jobs,
1679 all queued jobs of priority 1 will run before queued jobs of priority 2
1680 and so on, regardless of the original scheduling order.
1682 The priority only affects waiting jobs that are queued to run, not jobs
1683 that are already running. If one or more jobs of priority 2 are already
1684 running, and a new job is scheduled with priority 1, the currently
1685 running priority 2 jobs must complete before the priority 1 job is
1686 run, unless Allow Mixed Priority is set.
1688 The default priority is 10.
1690 If you want to run concurrent jobs you should
1691 keep these points in mind:
1694 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1697 \item Bacula concurrently runs jobs of only one priority at a time. It
1698 will not simultaneously run a priority 1 and a priority 2 job.
1700 \item If Bacula is running a priority 2 job and a new priority 1 job is
1701 scheduled, it will wait until the running priority 2 job terminates even
1702 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1703 to run simultaneously.
1705 \item Suppose that bacula is running a priority 2 job and a new priority 1
1706 job is scheduled and queued waiting for the running priority 2 job to
1707 terminate. If you then start a second priority 2 job, the waiting
1708 priority 1 job will prevent the new priority 2 job from running
1709 concurrently with the running priority 2 job. That is: as long as there
1710 is a higher priority job waiting to run, no new lower priority jobs will
1711 start even if the Maximum Concurrent Jobs settings would normally allow
1712 them to run. This ensures that higher priority jobs will be run as soon
1716 If you have several jobs of different priority, it may not best to start
1717 them at exactly the same time, because Bacula must examine them one at a
1718 time. If by Bacula starts a lower priority job first, then it will run
1719 before your high priority jobs. If you experience this problem, you may
1720 avoid it by starting any higher priority jobs a few seconds before lower
1721 priority ones. This insures that Bacula will examine the jobs in the
1722 correct order, and that your priority scheme will be respected.
1724 \label{AllowMixedPriority}
1725 \item [Allow Mixed Priority = \lt{}yes|no\gt{}]
1726 \index[dir]{Allow Mixed Priority}
1727 This directive is only implemented in version 2.5 and later. When
1728 set to {\bf yes} (default {\bf no}), this job may run even if lower
1729 priority jobs are already running. This means a high priority job
1730 will not have to wait for other jobs to finish before starting.
1731 The scheduler will only mix priorities when all running jobs have
1734 Note that only higher priority jobs will start early. Suppose the
1735 director will allow two concurrent jobs, and that two jobs with
1736 priority 10 are running, with two more in the queue. If a job with
1737 priority 5 is added to the queue, it will be run as soon as one of
1738 the running jobs finishes. However, new priority 10 jobs will not
1739 be run until the priority 5 job has finished.
1741 \label{WritePartAfterJob}
1742 \item [Write Part After Job = \lt{}yes|no\gt{}]
1743 \index[dir]{Write Part After Job}
1744 \index[dir]{Directive!Write Part After Job}
1745 This directive is only implemented in version 1.37 and later.
1746 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1747 will be created after the job is finished.
1749 It should be set to {\bf yes} when writing to devices that require mount
1750 (for example DVD), so you are sure that the current part, containing
1751 this job's data, is written to the device, and that no data is left in
1752 the temporary file on the hard disk. However, on some media, like DVD+R
1753 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1754 written. So, if you run several jobs each after another, you could set
1755 this directive to {\bf no} for all jobs, except the last one, to avoid
1756 wasting too much space, but to ensure that the data is written to the
1757 medium when all jobs are finished.
1759 This directive is ignored with tape and FIFO devices.
1763 The following is an example of a valid Job resource definition:
1770 Level = Incremental # default
1772 FileSet="Minou Full Set"
1775 Schedule = "MinouWeeklyCycle"
1781 \section{The JobDefs Resource}
1782 \label{JobDefsResource}
1783 \index[general]{JobDefs Resource}
1784 \index[general]{Resource!JobDefs}
1786 The JobDefs resource permits all the same directives that can appear in a Job
1787 resource. However, a JobDefs resource does not create a Job, rather it can be
1788 referenced within a Job to provide defaults for that Job. This permits you to
1789 concisely define several nearly identical Jobs, each one referencing a JobDefs
1790 resource which contains the defaults. Only the changes from the defaults need to
1791 be mentioned in each Job.
1793 \section{The Schedule Resource}
1794 \label{ScheduleResource}
1795 \index[general]{Resource!Schedule}
1796 \index[general]{Schedule Resource}
1798 The Schedule resource provides a means of automatically scheduling a Job as
1799 well as the ability to override the default Level, Pool, Storage and Messages
1800 resources. If a Schedule resource is not referenced in a Job, the Job can only
1801 be run manually. In general, you specify an action to be taken and when.
1806 \index[dir]{Schedule}
1807 \index[dir]{Directive!Schedule}
1808 Start of the Schedule directives. No {\bf Schedule} resource is
1809 required, but you will need at least one if you want Jobs to be
1810 automatically started.
1812 \item [Name = \lt{}name\gt{}]
1814 \index[dir]{Directive!Name}
1815 The name of the schedule being defined. The Name directive is required.
1817 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1819 \index[dir]{Directive!Run}
1820 The Run directive defines when a Job is to be run, and what overrides if
1821 any to apply. You may specify multiple {\bf run} directives within a
1822 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1823 multiple schedules). If you have two {\bf Run} directives that start at
1824 the same time, two Jobs will start at the same time (well, within one
1825 second of each other).
1827 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1828 Messages, and the Pool specifications provided in the Job resource. In
1829 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1830 specifications permit overriding the Pool specification according to
1831 what backup Job Level is in effect.
1833 By the use of overrides, you may customize a particular Job. For
1834 example, you may specify a Messages override for your Incremental
1835 backups that outputs messages to a log file, but for your weekly or
1836 monthly Full backups, you may send the output by email by using a
1837 different Messages override.
1839 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1840 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1841 or IncrementalPool, and the {\bf value} is as defined on the respective
1842 directive formats for the Job resource. You may specify multiple {\bf
1843 Job-overrides} on one {\bf Run} directive by separating them with one or
1844 more spaces or by separating them with a trailing comma. For example:
1850 \index[dir]{Directive!Level}
1851 is all files in the FileSet whether or not they have changed.
1853 \item [Level=Incremental]
1855 \index[dir]{Directive!Level}
1856 is all files that have changed since the last backup.
1860 \index[dir]{Directive!Pool}
1861 specifies to use the Pool named {\bf Weekly}.
1863 \item [Storage=DLT\_Drive]
1864 \index[dir]{Storage}
1865 \index[dir]{Directive!Storage}
1866 specifies to use {\bf DLT\_Drive} for the storage device.
1868 \item [Messages=Verbose]
1869 \index[dir]{Messages}
1870 \index[dir]{Directive!Messages}
1871 specifies to use the {\bf Verbose} message resource for the Job.
1873 \item [FullPool=Full]
1874 \index[dir]{FullPool}
1875 \index[dir]{Directive!FullPool}
1876 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1878 upgraded from another type to a full backup.
1880 \item [DifferentialPool=Differential]
1881 \index[dir]{DifferentialPool}
1882 \index[dir]{Directive!DifferentialPool}
1883 specifies to use the Pool named {\bf Differential} if the job is a
1884 differential backup.
1886 \item [IncrementalPool=Incremental]
1887 \index[dir]{IncrementalPool}
1888 \index[dir]{Directive!IncrementalPool}
1889 specifies to use the Pool named {\bf Incremental} if the job is an
1892 \item [SpoolData=yes|no]
1893 \index[dir]{SpoolData}
1894 \index[dir]{Directive!SpoolData}
1895 tells Bacula to request the Storage daemon to spool data to a disk file
1896 before writing it to the Volume (normally a tape). Thus the data is
1897 written in large blocks to the Volume rather than small blocks. This
1898 directive is particularly useful when running multiple simultaneous
1899 backups to tape. It prevents interleaving of the job data and reduces
1900 or eliminates tape drive stop and start commonly known as "shoe-shine".
1902 \item [SpoolSize={\it bytes}]
1903 \index[dir]{SpoolSize}
1904 \index[dir]{Directive!SpoolSize}
1905 where the bytes specify the maximum spool size for this job.
1906 The default is take from Device Maximum Spool Size limit.
1907 This directive is available only in Bacula version 2.3.5 or
1910 \item [WritePartAfterJob=yes|no]
1911 \index[dir]{WritePartAfterJob}
1912 \index[dir]{Directive!WritePartAfterJob}
1913 tells Bacula to request the Storage daemon to write the current part
1914 file to the device when the job is finished (see \ilink{Write Part After
1915 Job directive in the Job resource}{WritePartAfterJob}). Please note,
1916 this directive is implemented only in version 1.37 and later. The
1917 default is yes. We strongly recommend that you keep this set to yes
1918 otherwise, when the last job has finished one part will remain in the
1919 spool file and restore may or may not work.
1923 {\bf Date-time-specification} determines when the Job is to be run. The
1924 specification is a repetition, and as a default Bacula is set to run a job at
1925 the beginning of the hour of every hour of every day of every week of every
1926 month of every year. This is not normally what you want, so you must specify
1927 or limit when you want the job to run. Any specification given is assumed to
1928 be repetitive in nature and will serve to override or limit the default
1929 repetition. This is done by specifying masks or times for the hour, day of the
1930 month, day of the week, week of the month, week of the year, and month when
1931 you want the job to run. By specifying one or more of the above, you can
1932 define a schedule to repeat at almost any frequency you want.
1934 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1935 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1936 is special in that you may either specify a day of the month such as 1, 2,
1937 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1938 Sunday. Finally, you may also specify a week qualifier to restrict the
1939 schedule to the first, second, third, fourth, or fifth week of the month.
1941 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1942 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1943 month} and {\bf hour} remain set to the defaults of every month and all
1946 Note, by default with no other specification, your job will run at the
1947 beginning of every hour. If you wish your job to run more than once in any
1948 given hour, you will need to specify multiple {\bf run} specifications each
1949 with a different minute.
1951 The date/time to run the Job can be specified in the following way in
1958 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1959 second | third | fourth | fifth
1960 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1961 sunday | monday | tuesday | wednesday |
1962 thursday | friday | saturday
1963 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1964 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1965 aug | sep | oct | nov | dec | january |
1966 february | ... | december
1967 <daily-keyword> = daily
1968 <weekly-keyword> = weekly
1969 <monthly-keyword> = monthly
1970 <hourly-keyword> = hourly
1971 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1972 <number> = <digit> | <digit><number>
1973 <12hour> = 0 | 1 | 2 | ... 12
1974 <hour> = 0 | 1 | 2 | ... 23
1975 <minute> = 0 | 1 | 2 | ... 59
1976 <day> = 1 | 2 | ... 31
1977 <time> = <hour>:<minute> |
1978 <12hour>:<minute>am |
1980 <time-spec> = <at-keyword> <time> |
1982 <date-keyword> = <void-keyword> <weekly-keyword>
1983 <day-range> = <day>-<day>
1984 <month-range> = <month-keyword>-<month-keyword>
1985 <wday-range> = <wday-keyword>-<wday-keyword>
1986 <range> = <day-range> | <month-range> |
1988 <date> = <date-keyword> | <day> | <range>
1989 <date-spec> = <date> | <date-spec>
1990 <day-spec> = <day> | <wday-keyword> |
1991 <day> | <wday-range> |
1992 <week-keyword> <wday-keyword> |
1993 <week-keyword> <wday-range> |
1995 <month-spec> = <month-keyword> | <month-range> |
1997 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2003 Note, the Week of Year specification wnn follows the ISO standard definition
2004 of the week of the year, where Week 1 is the week in which the first Thursday
2005 of the year occurs, or alternatively, the week which contains the 4th of
2006 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2007 precedes the first ISO week (i.e. has the first few days of the year if any
2008 occur before Thursday). w00 is not defined by the ISO specification. A week
2009 starts with Monday and ends with Sunday.
2011 According to the NIST (US National Institute of Standards and Technology),
2012 12am and 12pm are ambiguous and can be defined to anything. However,
2013 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2014 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2015 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2016 am/pm). This is the definition in Bacula version 2.0.3 and later.
2018 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2019 with level full each Sunday at 2:05am and an incremental job Monday through
2020 Saturday at 2:05am is:
2025 Name = "WeeklyCycle"
2026 Run = Level=Full sun at 2:05
2027 Run = Level=Incremental mon-sat at 2:05
2032 An example of a possible monthly cycle is as follows:
2037 Name = "MonthlyCycle"
2038 Run = Level=Full Pool=Monthly 1st sun at 2:05
2039 Run = Level=Differential 2nd-5th sun at 2:05
2040 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2045 The first of every month:
2051 Run = Level=Full on 1 at 2:05
2052 Run = Level=Incremental on 2-31 at 2:05
2063 Run = Level=Full hourly at 0:05
2064 Run = Level=Full hourly at 0:15
2065 Run = Level=Full hourly at 0:25
2066 Run = Level=Full hourly at 0:35
2067 Run = Level=Full hourly at 0:45
2068 Run = Level=Full hourly at 0:55
2073 \section{Technical Notes on Schedules}
2074 \index[general]{Schedules!Technical Notes on}
2075 \index[general]{Technical Notes on Schedules}
2077 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2078 minute field to each schedule. The masks are hour, day of the month (mday),
2079 month, day of the week (wday), week of the month (wom), and week of the year
2080 (woy). The schedule is initialized to have the bits of each of these masks
2081 set, which means that at the beginning of every hour, the job will run. When
2082 you specify a month for the first time, the mask will be cleared and the bit
2083 corresponding to your selected month will be selected. If you specify a second
2084 month, the bit corresponding to it will also be added to the mask. Thus when
2085 Bacula checks the masks to see if the bits are set corresponding to the
2086 current time, your job will run only in the two months you have set. Likewise,
2087 if you set a time (hour), the hour mask will be cleared, and the hour you
2088 specify will be set in the bit mask and the minutes will be stored in the
2091 For any schedule you have defined, you can see how these bits are set by doing
2092 a {\bf show schedules} command in the Console program. Please note that the
2093 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2097 \section{The Client Resource}
2098 \label{ClientResource2}
2099 \index[general]{Resource!Client}
2100 \index[general]{Client Resource}
2102 The Client resource defines the attributes of the Clients that are served by
2103 this Director; that is the machines that are to be backed up. You will need
2104 one Client resource definition for each machine to be backed up.
2108 \item [Client (or FileDaemon)]
2109 \index[dir]{Client (or FileDaemon)}
2110 \index[dir]{Directive!Client (or FileDaemon)}
2111 Start of the Client directives.
2113 \item [Name = \lt{}name\gt{}]
2115 \index[dir]{Directive!Name}
2116 The client name which will be used in the Job resource directive or in the
2117 console run command. This directive is required.
2119 \item [Address = \lt{}address\gt{}]
2120 \index[dir]{Address}
2121 \index[dir]{Directive!FD Address}
2122 \index[dir]{File Daemon Address}
2123 \index[dir]{Client Address}
2124 Where the address is a host name, a fully qualified domain name, or a
2125 network address in dotted quad notation for a Bacula File server daemon.
2126 This directive is required.
2128 \item [FD Port = \lt{}port-number\gt{}]
2129 \index[dir]{FD Port}
2130 \index[dir]{Directive!FD Port}
2131 Where the port is a port number at which the Bacula File server daemon can
2132 be contacted. The default is 9102.
2134 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2135 \index[dir]{Catalog}
2136 \index[dir]{Directive!Catalog}
2137 This specifies the name of the catalog resource to be used for this Client.
2138 This directive is required.
2140 \item [Password = \lt{}password\gt{}]
2141 \index[dir]{Password}
2142 \index[dir]{Directive!Password}
2143 This is the password to be used when establishing a connection with the File
2144 services, so the Client configuration file on the machine to be backed up
2145 must have the same password defined for this Director. This directive is
2146 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2147 Bacula will generate a random password during the configuration process,
2148 otherwise it will be left blank.
2150 The password is plain text. It is not generated through any special
2151 process, but it is preferable for security reasons to make the text
2154 \label{FileRetention}
2155 \item [File Retention = \lt{}time-period-specification\gt{}]
2156 \index[dir]{File Retention}
2157 \index[dir]{Directive!File Retention}
2158 The File Retention directive defines the length of time that Bacula will
2159 keep File records in the Catalog database after the End time of the
2160 Job corresponding to the File records.
2161 When this time period expires, and if
2162 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2163 that are older than the specified File Retention period. Note, this affects
2164 only records in the catalog database. It does not affect your archive
2167 File records may actually be retained for a shorter period than you specify
2168 on this directive if you specify either a shorter {\bf Job Retention} or a
2169 shorter {\bf Volume Retention} period. The shortest retention period of the
2170 three takes precedence. The time may be expressed in seconds, minutes,
2171 hours, days, weeks, months, quarters, or years. See the
2172 \ilink{ Configuration chapter}{Time} of this manual for
2173 additional details of time specification.
2175 The default is 60 days.
2177 \label{JobRetention}
2178 \item [Job Retention = \lt{}time-period-specification\gt{}]
2179 \index[dir]{Job Retention}
2180 \index[dir]{Directive!Job Retention}
2181 The Job Retention directive defines the length of time that Bacula will keep
2182 Job records in the Catalog database after the Job End time. When
2183 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2184 Bacula will prune (remove) Job records that are older than the specified
2185 File Retention period. As with the other retention periods, this
2186 affects only records in the catalog and not data in your archive backup.
2188 If a Job record is selected for pruning, all associated File and JobMedia
2189 records will also be pruned regardless of the File Retention period set.
2190 As a consequence, you normally will set the File retention period to be
2191 less than the Job retention period. The Job retention period can actually
2192 be less than the value you specify here if you set the {\bf Volume
2193 Retention} directive in the Pool resource to a smaller duration. This is
2194 because the Job retention period and the Volume retention period are
2195 independently applied, so the smaller of the two takes precedence.
2197 The Job retention period is specified as seconds, minutes, hours, days,
2198 weeks, months, quarters, or years. See the
2199 \ilink{ Configuration chapter}{Time} of this manual for
2200 additional details of time specification.
2202 The default is 180 days.
2205 \item [AutoPrune = \lt{}yes|no\gt{}]
2206 \index[dir]{AutoPrune}
2207 \index[dir]{Directive!AutoPrune}
2208 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2209 will automatically apply the File retention period and the Job retention
2210 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2211 pruning will not be done, and your Catalog will grow in size each time you
2212 run a Job. Pruning affects only information in the catalog and not data
2213 stored in the backup archives (on Volumes).
2215 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2216 \index[dir]{Maximum Concurrent Jobs}
2217 \index[dir]{Directive!Maximum Concurrent Jobs}
2218 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2219 that can run concurrently. Note, this directive limits only Jobs for Clients
2220 with the same name as the resource in which it appears. Any other
2221 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2222 Storage resources will also apply in addition to any limit specified here.
2223 The default is set to 1, but you may set it to a larger number.
2225 \item [Priority = \lt{}number\gt{}]
2226 \index[dir]{Priority}
2227 \index[dir]{Directive!Priority}
2228 The number specifies the priority of this client relative to other clients
2229 that the Director is processing simultaneously. The priority can range from
2230 1 to 1000. The clients are ordered such that the smaller number priorities
2231 are performed first (not currently implemented).
2234 The following is an example of a valid Client resource definition:
2240 FDAddress = minimatou
2242 Password = very_good
2247 \section{The Storage Resource}
2248 \label{StorageResource2}
2249 \index[general]{Resource!Storage}
2250 \index[general]{Storage Resource}
2252 The Storage resource defines which Storage daemons are available for use by
2258 \index[dir]{Storage}
2259 \index[dir]{Directive!Storage}
2260 Start of the Storage resources. At least one storage resource must be
2263 \item [Name = \lt{}name\gt{}]
2265 \index[dir]{Directive!Name}
2266 The name of the storage resource. This name appears on the Storage directive
2267 specified in the Job resource and is required.
2269 \item [Address = \lt{}address\gt{}]
2270 \index[dir]{Address}
2271 \index[dir]{Directive!SD Address}
2272 \index[dir]{Storage daemon Address}
2273 Where the address is a host name, a {\bf fully qualified domain name}, or an
2274 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2275 will be transmitted to the File daemon who will then use it to contact the
2276 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2277 the name but rather a fully qualified machine name or an IP address. This
2278 directive is required.
2280 \item [SD Port = \lt{}port\gt{}]
2281 \index[dir]{SD Port}
2282 \index[dir]{Directive!SD Port}
2283 Where port is the port to use to contact the storage daemon for information
2284 and to start jobs. This same port number must appear in the Storage resource
2285 of the Storage daemon's configuration file. The default is 9103.
2287 \item [Password = \lt{}password\gt{}]
2288 \index[dir]{Password}
2289 \index[dir]{Directive!Password}
2290 This is the password to be used when establishing a connection with the
2291 Storage services. This same password also must appear in the Director
2292 resource of the Storage daemon's configuration file. This directive is
2293 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2294 Bacula will generate a random password during the configuration process,
2295 otherwise it will be left blank.
2297 The password is plain text. It is not generated through any special
2298 process, but it is preferable for security reasons to use random text.
2300 \item [Device = \lt{}device-name\gt{}]
2302 \index[dir]{Directive!Device}
2303 This directive specifies the Storage daemon's name of the device
2304 resource to be used for the storage. If you are using an Autochanger,
2305 the name specified here should be the name of the Storage daemon's
2306 Autochanger resource rather than the name of an individual device. This
2307 name is not the physical device name, but the logical device name as
2308 defined on the {\bf Name} directive contained in the {\bf Device} or the
2309 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2310 configuration file. You can specify any name you would like (even the
2311 device name if you prefer) up to a maximum of 127 characters in length.
2312 The physical device name associated with this device is specified in the
2313 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2314 Please take care not to define two different Storage resource directives
2315 in the Director that point to the same Device in the Storage daemon.
2316 Doing so may cause the Storage daemon to block (or hang) attempting to
2317 open the same device that is already open. This directive is required.
2320 \item [Media Type = \lt{}MediaType\gt{}]
2321 \index[dir]{Media Type}
2322 \index[dir]{Directive!Media Type}
2323 This directive specifies the Media Type to be used to store the data.
2324 This is an arbitrary string of characters up to 127 maximum that you
2325 define. It can be anything you want. However, it is best to make it
2326 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2327 ...). In addition, it is essential that you make the {\bf Media Type}
2328 specification unique for each storage media type. If you have two DDS-4
2329 drives that have incompatible formats, or if you have a DDS-4 drive and
2330 a DDS-4 autochanger, you almost certainly should specify different {\bf
2331 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2332 associated with the Job, Bacula can decide to use any Storage daemon
2333 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2335 If you are writing to disk Volumes, you must make doubly sure that each
2336 Device resource defined in the Storage daemon (and hence in the
2337 Director's conf file) has a unique media type. Otherwise for Bacula
2338 versions 1.38 and older, your restores may not work because Bacula
2339 will assume that you can mount any Media Type with the same name on
2340 any Device associated with that Media Type. This is possible with
2341 tape drives, but with disk drives, unless you are very clever you
2342 cannot mount a Volume in any directory -- this can be done by creating
2343 an appropriate soft link.
2345 Currently Bacula permits only a single Media Type per Storage
2346 and Device definition. Consequently, if
2347 you have a drive that supports more than one Media Type, you can
2348 give a unique string to Volumes with different intrinsic Media
2349 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2350 those volumes will only be mounted on drives indicated with the
2351 dual type (DDS-3-4).
2353 If you want to tie Bacula to using a single Storage daemon or drive, you
2354 must specify a unique Media Type for that drive. This is an important
2355 point that should be carefully understood. Note, this applies equally
2356 to Disk Volumes. If you define more than one disk Device resource in
2357 your Storage daemon's conf file, the Volumes on those two devices are in
2358 fact incompatible because one can not be mounted on the other device
2359 since they are found in different directories. For this reason, you
2360 probably should use two different Media Types for your two disk Devices
2361 (even though you might think of them as both being File types). You can
2362 find more on this subject in the \ilink{Basic Volume
2363 Management}{DiskChapter} chapter of this manual.
2365 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2366 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2367 resource of the {\bf Storage daemon} configuration file. This directive
2368 is required, and it is used by the Director and the Storage daemon to
2369 ensure that a Volume automatically selected from the Pool corresponds to
2370 the physical device. If a Storage daemon handles multiple devices (e.g.
2371 will write to various file Volumes on different partitions), this
2372 directive allows you to specify exactly which device.
2374 As mentioned above, the value specified in the Director's Storage
2375 resource must agree with the value specified in the Device resource in
2376 the {\bf Storage daemon's} configuration file. It is also an additional
2377 check so that you don't try to write data for a DLT onto an 8mm device.
2379 \label{Autochanger1}
2380 \item [Autochanger = \lt{}yes|no\gt{}]
2381 \index[dir]{Autochanger}
2382 \index[dir]{Directive!Autochanger}
2383 If you specify {\bf yes} for this command (the default is {\bf no}),
2384 when you use the {\bf label} command or the {\bf add} command to create
2385 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2386 number. This simplifies creating database entries for Volumes in an
2387 autochanger. If you forget to specify the Slot, the autochanger will
2388 not be used. However, you may modify the Slot associated with a Volume
2389 at any time by using the {\bf update volume} or {\bf update slots}
2390 command in the console program. When {\bf autochanger} is enabled, the
2391 algorithm used by Bacula to search for available volumes will be
2392 modified to consider only Volumes that are known to be in the
2393 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2394 will attempt recycling, pruning, ..., and if still no volume is found,
2395 Bacula will search for any volume whether or not in the magazine. By
2396 privileging in changer volumes, this procedure minimizes operator
2397 intervention. The default is {\bf no}.
2399 For the autochanger to be used, you must also specify {\bf Autochanger =
2400 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2401 configuration file as well as other important Storage daemon
2402 configuration information. Please consult the \ilink{Using
2403 Autochangers}{AutochangersChapter} manual of this chapter for the
2404 details of using autochangers.
2406 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2407 \index[dir]{Maximum Concurrent Jobs}
2408 \index[dir]{Directive!Maximum Concurrent Jobs}
2409 where \lt{}number\gt{} is the maximum number of Jobs with the current
2410 Storage resource that can run concurrently. Note, this directive limits
2411 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2412 the maximum concurrent jobs such as in the Director, Job, or Client
2413 resources will also apply in addition to any limit specified here. The
2414 default is set to 1, but you may set it to a larger number. However, if
2415 you set the Storage daemon's number of concurrent jobs greater than one,
2416 we recommend that you read the waring documented under \ilink{Maximum
2417 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2418 turn data spooling on as documented in the \ilink{Data
2419 Spooling}{SpoolingChapter} chapter of this manual.
2421 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2422 \index[dir]{Heartbeat Interval}
2423 \index[dir]{Directive!Heartbeat}
2424 This directive is optional and if specified will cause the Director to
2425 set a keepalive interval (heartbeat) in seconds on each of the sockets
2426 it opens for the Storage resource. This value will override any
2427 specified at the Director level. It is implemented only on systems
2428 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2429 The default value is zero, which means no change is made to the socket.
2433 The following is an example of a valid Storage resource definition:
2437 # Definition of tape storage device
2441 Password = storage_password # password for Storage daemon
2442 Device = "HP DLT 80" # same as Device in Storage daemon
2443 Media Type = DLT8000 # same as MediaType in Storage daemon
2448 \section{The Pool Resource}
2449 \label{PoolResource}
2450 \index[general]{Resource!Pool}
2451 \index[general]{Pool Resource}
2453 The Pool resource defines the set of storage Volumes (tapes or files) to be
2454 used by Bacula to write the data. By configuring different Pools, you can
2455 determine which set of Volumes (media) receives the backup data. This permits,
2456 for example, to store all full backup data on one set of Volumes and all
2457 incremental backups on another set of Volumes. Alternatively, you could assign
2458 a different set of Volumes to each machine that you backup. This is most
2459 easily done by defining multiple Pools.
2461 Another important aspect of a Pool is that it contains the default attributes
2462 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2463 Volume when it is created. This avoids the need for you to answer a large
2464 number of questions when labeling a new Volume. Each of these attributes can
2465 later be changed on a Volume by Volume basis using the {\bf update} command in
2466 the console program. Note that you must explicitly specify which Pool Bacula
2467 is to use with each Job. Bacula will not automatically search for the correct
2470 Most often in Bacula installations all backups for all machines (Clients) go
2471 to a single set of Volumes. In this case, you will probably only use the {\bf
2472 Default} Pool. If your backup strategy calls for you to mount a different tape
2473 each day, you will probably want to define a separate Pool for each day. For
2474 more information on this subject, please see the
2475 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2479 To use a Pool, there are three distinct steps. First the Pool must be defined
2480 in the Director's configuration file. Then the Pool must be written to the
2481 Catalog database. This is done automatically by the Director each time that it
2482 starts, or alternatively can be done using the {\bf create} command in the
2483 console program. Finally, if you change the Pool definition in the Director's
2484 configuration file and restart Bacula, the pool will be updated alternatively
2485 you can use the {\bf update pool} console command to refresh the database
2486 image. It is this database image rather than the Director's resource image
2487 that is used for the default Volume attributes. Note, for the pool to be
2488 automatically created or updated, it must be explicitly referenced by a Job
2491 Next the physical media must be labeled. The labeling can either be done with
2492 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2493 program. The preferred method is to use the {\bf label} command in the {\bf
2496 Finally, you must add Volume names (and their attributes) to the Pool. For
2497 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2498 archive device specified for the job (i.e. if you are going to back up to a
2499 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2500 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2501 are backing up to files. When running a Job, you must explicitly specify which
2502 Pool to use. Bacula will then automatically select the next Volume to use from
2503 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2504 from the Pool is identical to that required by the Storage resource you have
2505 specified for the Job.
2507 If you use the {\bf label} command in the console program to label the
2508 Volumes, they will automatically be added to the Pool, so this last step is
2509 not normally required.
2511 It is also possible to add Volumes to the database without explicitly labeling
2512 the physical volume. This is done with the {\bf add} console command.
2514 As previously mentioned, each time Bacula starts, it scans all the Pools
2515 associated with each Catalog, and if the database record does not already
2516 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2517 probably should do an {\bf update pool} if you change the Pool definition, but
2518 currently, you must do this manually using the {\bf update pool} command in
2519 the Console program.
2521 The Pool Resource defined in the Director's configuration file
2522 (bacula-dir.conf) may contain the following directives:
2528 \index[dir]{Directive!Pool}
2529 Start of the Pool resource. There must be at least one Pool resource
2533 \item [Name = \lt{}name\gt{}]
2535 \index[dir]{Directive!Name}
2536 The name of the pool. For most applications, you will use the default
2537 pool name {\bf Default}. This directive is required.
2540 \item [Maximum Volumes = \lt{}number\gt{}]
2541 \index[dir]{Maximum Volumes}
2542 \index[dir]{Directive!Maximum Volumes}
2543 This directive specifies the maximum number of volumes (tapes or files)
2544 contained in the pool. This directive is optional, if omitted or set to
2545 zero, any number of volumes will be permitted. In general, this
2546 directive is useful for Autochangers where there is a fixed number of
2547 Volumes, or for File storage where you wish to ensure that the backups
2548 made to disk files do not become too numerous or consume too much space.
2550 \item [Pool Type = \lt{}type\gt{}]
2551 \index[dir]{Pool Type}
2552 \index[dir]{Directive!Pool Type}
2553 This directive defines the pool type, which corresponds to the type of
2554 Job being run. It is required and may be one of the following:
2564 Note, only Backup is current implemented.
2566 \item [Storage = \lt{}storage-resource-name\gt{}]
2567 \index[dir]{Storage}
2568 \index[dir]{Directive!Storage}
2569 The Storage directive defines the name of the storage services where you
2570 want to backup the FileSet data. For additional details, see the
2571 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2572 The Storage resource may also be specified in the Job resource,
2573 but the value, if any, in the Pool resource overrides any value
2574 in the Job. This Storage resource definition is not required by either
2575 the Job resource or in the Pool, but it must be specified in
2576 one or the other. If not configuration error will result.
2578 \item [Use Volume Once = \lt{}yes|no\gt{}]
2579 \index[dir]{Use Volume Once}
2580 \index[dir]{Directive!Use Volume Once}
2581 This directive if set to {\bf yes} specifies that each volume is to be
2582 used only once. This is most useful when the Media is a file and you
2583 want a new file for each backup that is done. The default is {\bf no}
2584 (i.e. use volume any number of times). This directive will most likely
2585 be phased out (deprecated), so you are recommended to use {\bf Maximum
2586 Volume Jobs = 1} instead.
2588 The value defined by this directive in the bacula-dir.conf file is the
2589 default value used when a Volume is created. Once the volume is
2590 created, changing the value in the bacula-dir.conf file will not change
2591 what is stored for the Volume. To change the value for an existing
2592 Volume you must use the {\bf update} command in the Console.
2594 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2595 using this directive with multiple simultaneous jobs.
2597 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2598 \index[dir]{Maximum Volume Jobs}
2599 \index[dir]{Directive!Maximum Volume Jobs}
2600 This directive specifies the maximum number of Jobs that can be written
2601 to the Volume. If you specify zero (the default), there is no limit.
2602 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2603 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2604 is marked {\bf Used} it can no longer be used for appending Jobs, much
2605 like the {\bf Full} status but it can be recycled if recycling is
2606 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2607 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2609 The value defined by this directive in the bacula-dir.conf
2610 file is the default value used when a Volume is created. Once the volume is
2611 created, changing the value in the bacula-dir.conf file will not change what
2612 is stored for the Volume. To change the value for an existing Volume you
2613 must use the {\bf update} command in the Console.
2615 If you are running multiple simultaneous jobs, this directive may not
2616 work correctly because when a drive is reserved for a job, this
2617 directive is not taken into account, so multiple jobs may try to
2618 start writing to the Volume. At some point, when the Media record is
2619 updated, multiple simultaneous jobs may fail since the Volume can no
2622 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2623 \index[dir]{Maximum Volume Files}
2624 \index[dir]{Directive!Maximum Volume Files}
2625 This directive specifies the maximum number of files that can be written
2626 to the Volume. If you specify zero (the default), there is no limit.
2627 Otherwise, when the number of files written to the Volume equals {\bf
2628 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2629 is marked {\bf Used} it can no longer be used for appending Jobs, much
2630 like the {\bf Full} status but it can be recycled if recycling is
2631 enabled and thus used again. This value is checked and the {\bf Used}
2632 status is set only at the end of a job that writes to the particular
2635 The value defined by this directive in the bacula-dir.conf file is the
2636 default value used when a Volume is created. Once the volume is
2637 created, changing the value in the bacula-dir.conf file will not change
2638 what is stored for the Volume. To change the value for an existing
2639 Volume you must use the {\bf update} command in the Console.
2641 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2642 \index[dir]{Maximum Volume Bytes}
2643 \index[dir]{Directive!Maximum Volume Bytes}
2644 This directive specifies the maximum number of bytes that can be written
2645 to the Volume. If you specify zero (the default), there is no limit
2646 except the physical size of the Volume. Otherwise, when the number of
2647 bytes written to the Volume equals {\bf size} the Volume will be marked
2648 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2649 used for appending Jobs, much like the {\bf Full} status but it can be
2650 recycled if recycling is enabled, and thus the Volume can be re-used
2651 after recycling. This value is checked and the {\bf Used} status set
2652 while the job is writing to the particular volume.
2654 This directive is particularly useful for restricting the size
2655 of disk volumes, and will work correctly even in the case of
2656 multiple simultaneous jobs writing to the volume.
2658 The value defined by this directive in the bacula-dir.conf file is the
2659 default value used when a Volume is created. Once the volume is
2660 created, changing the value in the bacula-dir.conf file will not change
2661 what is stored for the Volume. To change the value for an existing
2662 Volume you must use the {\bf update} command in the Console.
2664 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2665 \index[dir]{Volume Use Duration}
2666 \index[dir]{Directive!Volume Use Duration}
2667 The Volume Use Duration directive defines the time period that the
2668 Volume can be written beginning from the time of first data write to the
2669 Volume. If the time-period specified is zero (the default), the Volume
2670 can be written indefinitely. Otherwise, the next time a job
2671 runs that wants to access this Volume, and the time period from the
2672 first write to the volume (the first Job written) exceeds the
2673 time-period-specification, the Volume will be marked {\bf Used}, which
2674 means that no more Jobs can be appended to the Volume, but it may be
2675 recycled if recycling is enabled. Using the command {\bf
2676 status dir} applies algorithms similar to running jobs, so
2677 during such a command, the Volume status may also be changed.
2679 recycled, it will be available for use again.
2681 You might use this directive, for example, if you have a Volume used for
2682 Incremental backups, and Volumes used for Weekly Full backups. Once the
2683 Full backup is done, you will want to use a different Incremental
2684 Volume. This can be accomplished by setting the Volume Use Duration for
2685 the Incremental Volume to six days. I.e. it will be used for the 6
2686 days following a Full save, then a different Incremental volume will be
2687 used. Be careful about setting the duration to short periods such as 23
2688 hours, or you might experience problems of Bacula waiting for a tape
2689 over the weekend only to complete the backups Monday morning when an
2690 operator mounts a new tape.
2692 The use duration is checked and the {\bf Used} status is set only at the
2693 end of a job that writes to the particular volume, which means that even
2694 though the use duration may have expired, the catalog entry will not be
2695 updated until the next job that uses this volume is run. This
2696 directive is not intended to be used to limit volume sizes
2697 and will not work correctly (i.e. will fail jobs) if the use
2698 duration expires while multiple simultaneous jobs are writing
2701 Please note that the value defined by this directive in the bacula-dir.conf
2702 file is the default value used when a Volume is created. Once the volume is
2703 created, changing the value in the bacula-dir.conf file will not change what
2704 is stored for the Volume. To change the value for an existing Volume you
2706 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2708 \item [Catalog Files = \lt{}yes|no\gt{}]
2709 \index[dir]{Catalog Files}
2710 \index[dir]{Directive!Catalog Files}
2711 This directive defines whether or not you want the names of the files
2712 that were saved to be put into the catalog. The default is {\bf yes}.
2713 The advantage of specifying {\bf Catalog Files = No} is that you will
2714 have a significantly smaller Catalog database. The disadvantage is that
2715 you will not be able to produce a Catalog listing of the files backed up
2716 for each Job (this is often called Browsing). Also, without the File
2717 entries in the catalog, you will not be able to use the Console {\bf
2718 restore} command nor any other command that references File entries.
2720 \label{PoolAutoPrune}
2721 \item [AutoPrune = \lt{}yes|no\gt{}]
2722 \index[dir]{AutoPrune}
2723 \index[dir]{Directive!AutoPrune}
2724 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2725 greater) will automatically apply the Volume Retention period when new
2726 Volume is needed and no appendable Volumes exist in the Pool. Volume
2727 pruning causes expired Jobs (older than the {\bf Volume Retention}
2728 period) to be deleted from the Catalog and permits possible recycling of
2731 \label{VolRetention}
2732 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2733 \index[dir]{Volume Retention}
2734 \index[dir]{Directive!Volume Retention}
2735 The Volume Retention directive defines the length of time that {\bf
2736 Bacula} will keep records associated with the Volume in
2737 the Catalog database after the End time of each Job written to the
2738 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2739 {\bf yes} Bacula may prune (remove) Job records that are older than the
2740 specified Volume Retention period if it is necessary to free up a
2741 Volume. Recycling will not occur until it is absolutely necessary to
2742 free up a volume (i.e. no other writable volume exists).
2743 All File records associated with pruned Jobs are also
2744 pruned. The time may be specified as seconds, minutes, hours, days,
2745 weeks, months, quarters, or years. The {\bf Volume Retention} is
2746 applied independently of the {\bf Job Retention} and the {\bf File
2747 Retention} periods defined in the Client resource. This means that all
2748 the retentions periods are applied in turn and that the shorter period
2749 is the one that effectively takes precedence. Note, that when the {\bf
2750 Volume Retention} period has been reached, and it is necessary to obtain
2751 a new volume, Bacula will prune both the Job and the File records. This
2752 pruning could also occur during a {\bf status dir} command because it
2753 uses similar algorithms for finding the next available Volume.
2755 It is important to know that when the Volume Retention period expires,
2756 Bacula does not automatically recycle a Volume. It attempts to keep the
2757 Volume data intact as long as possible before over writing the Volume.
2760 By defining multiple Pools with different Volume Retention periods, you
2761 may effectively have a set of tapes that is recycled weekly, another
2762 Pool of tapes that is recycled monthly and so on. However, one must
2763 keep in mind that if your {\bf Volume Retention} period is too short, it
2764 may prune the last valid Full backup, and hence until the next Full
2765 backup is done, you will not have a complete backup of your system, and
2766 in addition, the next Incremental or Differential backup will be
2767 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2768 Retention} period should be at twice the interval of your Full backups.
2769 This means that if you do a Full backup once a month, the minimum Volume
2770 retention period should be two months.
2772 The default Volume retention period is 365 days, and either the default
2773 or the value defined by this directive in the bacula-dir.conf file is
2774 the default value used when a Volume is created. Once the volume is
2775 created, changing the value in the bacula-dir.conf file will not change
2776 what is stored for the Volume. To change the value for an existing
2777 Volume you must use the {\bf update} command in the Console.
2779 \label{PoolScratchPool}
2780 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
2781 \index[dir]{ScrachPool}
2782 \index[dir]{Directive!ScrachPool}
2783 This directive permits to specify a dedicate \textsl{Scratch} for the
2784 current pool. This pool will replace the special pool named \textsl{Scrach}
2785 for volume selection. For more information about \textsl{Scratch} see
2786 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
2787 when using multiple storage sharing the same mediatype or when you want to
2788 dedicate volumes to a particular set of pool.
2790 \label{PoolRecyclePool}
2791 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2792 \index[dir]{RecyclePool}
2793 \index[dir]{Directive!RecyclePool}
2794 This directive defines to which pool
2795 the Volume will be placed (moved) when it is recycled. Without
2796 this directive, a Volume will remain in the same pool when it is
2797 recycled. With this directive, it can be moved automatically to any
2798 existing pool during a recycle. This directive is probably most
2799 useful when defined in the Scratch pool, so that volumes will
2800 be recycled back into the Scratch pool. For more on the see the
2801 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2803 Although this directive is called RecyclePool, the Volume in
2804 question is actually moved from its current pool to the one
2805 you specify on this directive when Bacula prunes the Volume and
2806 discovers that there are no records left in the catalog and hence
2807 marks it as {\bf Purged}.
2811 \item [Recycle = \lt{}yes|no\gt{}]
2812 \index[dir]{Recycle}
2813 \index[dir]{Directive!Recycle}
2814 This directive specifies whether or not Purged Volumes may be recycled.
2815 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2816 none that are appendable, it will search for and recycle (reuse) Purged
2817 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2818 deleted from the Catalog). If the Volume is recycled, all previous data
2819 written to that Volume will be overwritten. If Recycle is set to {\bf
2820 no}, the Volume will not be recycled, and hence, the data will remain
2821 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2822 is no (0 in the catalog), you may manually set the recycle flag (update
2823 command) for a Volume to be reused.
2825 Please note that the value defined by this directive in the
2826 bacula-dir.conf file is the default value used when a Volume is created.
2827 Once the volume is created, changing the value in the bacula-dir.conf
2828 file will not change what is stored for the Volume. To change the value
2829 for an existing Volume you must use the {\bf update} command in the
2832 When all Job and File records have been pruned or purged from the
2833 catalog for a particular Volume, if that Volume is marked as
2834 Append, Full, Used, or Error, it will then be marked as Purged. Only
2835 Volumes marked as Purged will be considered to be converted to the
2836 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
2839 \label{RecycleOldest}
2840 \item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
2841 \index[dir]{Recycle Oldest Volume}
2842 \index[dir]{Directive!Recycle Oldest Volume}
2843 This directive instructs the Director to search for the oldest used
2844 Volume in the Pool when another Volume is requested by the Storage
2845 daemon and none are available. The catalog is then {\bf pruned}
2846 respecting the retention periods of all Files and Jobs written to this
2847 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2848 Volume is recycled and will be used as the next Volume to be written.
2849 This directive respects any Job, File, or Volume retention periods that
2850 you may have specified, and as such it is {\bf much} better to use this
2851 directive than the Purge Oldest Volume.
2853 This directive can be useful if you have a fixed number of Volumes in the
2854 Pool and you want to cycle through them and you have specified the correct
2857 However, if you use this directive and have only one
2858 Volume in the Pool, you will immediately recycle your Volume if you fill
2859 it and Bacula needs another one. Thus your backup will be totally invalid.
2860 Please use this directive with care. The default is {\bf no}.
2862 \label{RecycleCurrent}
2864 \item [Recycle Current Volume = \lt{}yes|no\gt{}]
2865 \index[dir]{Recycle Current Volume}
2866 \index[dir]{Directive!Recycle Current Volume}
2867 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2868 the volume respecting the Job and File retention periods. If all Jobs
2869 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2870 will be used as the next Volume to be written. This directive respects
2871 any Job, File, or Volume retention periods that you may have specified,
2872 and thus it is {\bf much} better to use it rather than the Purge Oldest
2875 This directive can be useful if you have: a fixed number of Volumes in
2876 the Pool, you want to cycle through them, and you have specified
2877 retention periods that prune Volumes before you have cycled through the
2880 However, if you use this directive and have only one Volume in the Pool,
2881 you will immediately recycle your Volume if you fill it and Bacula needs
2882 another one. Thus your backup will be totally invalid. Please use this
2883 directive with care. The default is {\bf no}.
2887 \item [Purge Oldest Volume = \lt{}yes|no\gt{}]
2888 \index[dir]{Purge Oldest Volume}
2889 \index[dir]{Directive!Purge Oldest Volume}
2890 This directive instructs the Director to search for the oldest used
2891 Volume in the Pool when another Volume is requested by the Storage
2892 daemon and none are available. The catalog is then {\bf purged}
2893 irrespective of retention periods of all Files and Jobs written to this
2894 Volume. The Volume is then recycled and will be used as the next Volume
2895 to be written. This directive overrides any Job, File, or Volume
2896 retention periods that you may have specified.
2898 This directive can be useful if you have a fixed number of Volumes in
2899 the Pool and you want to cycle through them and reusing the oldest one
2900 when all Volumes are full, but you don't want to worry about setting
2901 proper retention periods. However, by using this option you risk losing
2904 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2905 periods. If you have only a single Volume defined and you turn this
2906 variable on, that Volume will always be immediately overwritten when it
2907 fills! So at a minimum, ensure that you have a decent number of Volumes
2908 in your Pool before running any jobs. If you want retention periods to
2909 apply do not use this directive. To specify a retention period, use the
2910 {\bf Volume Retention} directive (see above).
2912 We {\bf highly} recommend against using this directive, because it is
2913 sure that some day, Bacula will recycle a Volume that contains current
2914 data. The default is {\bf no}.
2916 \item [Cleaning Prefix = \lt{}string\gt{}]
2917 \index[dir]{Cleaning Prefix}
2918 \index[dir]{Directive!Cleaning Prefix}
2919 This directive defines a prefix string, which if it matches the
2920 beginning of a Volume name during labeling of a Volume, the Volume will
2921 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2922 never attempt to use this tape. This is primarily for use with
2923 autochangers that accept barcodes where the convention is that barcodes
2924 beginning with {\bf CLN} are treated as cleaning tapes.
2927 \item [Label Format = \lt{}format\gt{}]
2928 \index[dir]{Label Format}
2929 \index[dir]{Directive!Label Format}
2930 This directive specifies the format of the labels contained in this
2931 pool. The format directive is used as a sort of template to create new
2932 Volume names during automatic Volume labeling.
2934 The {\bf format} should be specified in double quotes, and consists of
2935 letters, numbers and the special characters hyphen ({\bf -}), underscore
2936 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2937 characters for a Volume name. The {\bf format} should be enclosed in
2940 In addition, the format may contain a number of variable expansion
2941 characters which will be expanded by a complex algorithm allowing you to
2942 create Volume names of many different formats. In all cases, the
2943 expansion process must resolve to the set of characters noted above that
2944 are legal Volume names. Generally, these variable expansion characters
2945 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2946 specify variable expansion characters, you should always enclose the
2947 format with double quote characters ({\bf "}). For more details on
2948 variable expansion, please see the \ilink{Variable
2949 Expansion}{VarsChapter} Chapter of this manual.
2951 If no variable expansion characters are found in the string, the Volume
2952 name will be formed from the {\bf format} string appended with the
2953 a unique number that increases. If you do not remove volumes from the
2954 pool, this number should be the number of volumes plus one, but this
2955 is not guaranteed. The unique number will be edited as four
2956 digits with leading zeros. For example, with a {\bf Label Format =
2957 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
2960 With the exception of Job specific variables, you can test your {\bf
2961 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
2964 In almost all cases, you should enclose the format specification (part
2965 after the equal sign) in double quotes. Please note that this directive
2966 is deprecated and is replaced in version 1.37 and greater with a Python
2967 script for creating volume names.
2971 In order for a Pool to be used during a Backup Job, the Pool must have at
2972 least one Volume associated with it. Volumes are created for a Pool using
2973 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
2974 program. In addition to adding Volumes to the Pool (i.e. putting the
2975 Volume names in the Catalog database), the physical Volume must be labeled
2976 with a valid Bacula software volume label before {\bf Bacula} will accept
2977 the Volume. This will be automatically done if you use the {\bf label}
2978 command. Bacula can automatically label Volumes if instructed to do so,
2979 but this feature is not yet fully implemented.
2981 The following is an example of a valid Pool resource definition:
2993 \subsection{The Scratch Pool}
2994 \label{TheScratchPool}
2995 \index[general]{Scratch Pool}
2996 In general, you can give your Pools any name you wish, but there is one
2997 important restriction: the Pool named {\bf Scratch}, if it exists behaves
2998 like a scratch pool of Volumes in that when Bacula needs a new Volume for
2999 writing and it cannot find one, it will look in the Scratch pool, and if
3000 it finds an available Volume, it will move it out of the Scratch pool into
3001 the Pool currently being used by the job.
3004 \section{The Catalog Resource}
3005 \label{CatalogResource}
3006 \index[general]{Resource!Catalog}
3007 \index[general]{Catalog Resource}
3009 The Catalog Resource defines what catalog to use for the current job.
3010 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3011 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3012 may be as many Catalogs (databases) defined as you wish. For example, you
3013 may want each Client to have its own Catalog database, or you may want
3014 backup jobs to use one database and verify or restore jobs to use another
3017 Since SQLite is compiled in, it always runs on the same machine
3018 as the Director and the database must be directly accessible (mounted) from
3019 the Director. However, since both MySQL and PostgreSQL are networked
3020 databases, they may reside either on the same machine as the Director
3021 or on a different machine on the network. See below for more details.
3026 \index[dir]{Catalog}
3027 \index[dir]{Directive!Catalog}
3028 Start of the Catalog resource. At least one Catalog resource must be
3032 \item [Name = \lt{}name\gt{}]
3034 \index[dir]{Directive!Name}
3035 The name of the Catalog. No necessary relation to the database server
3036 name. This name will be specified in the Client resource directive
3037 indicating that all catalog data for that Client is maintained in this
3038 Catalog. This directive is required.
3040 \item [password = \lt{}password\gt{}]
3041 \index[dir]{password}
3042 \index[dir]{Directive!password}
3043 This specifies the password to use when logging into the database. This
3044 directive is required.
3046 \item [DB Name = \lt{}name\gt{}]
3047 \index[dir]{DB Name}
3048 \index[dir]{Directive!DB Name}
3049 This specifies the name of the database. If you use multiple catalogs
3050 (databases), you specify which one here. If you are using an external
3051 database server rather than the internal one, you must specify a name
3052 that is known to the server (i.e. you explicitly created the Bacula
3053 tables using this name. This directive is required.
3055 \item [user = \lt{}user\gt{}]
3057 \index[dir]{Directive!user}
3058 This specifies what user name to use to log into the database. This
3059 directive is required.
3061 \item [DB Socket = \lt{}socket-name\gt{}]
3062 \index[dir]{DB Socket}
3063 \index[dir]{Directive!DB Socket}
3064 This is the name of a socket to use on the local host to connect to the
3065 database. This directive is used only by MySQL and is ignored by SQLite.
3066 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3067 will use the default socket. If the DB Socket is specified, the
3068 MySQL server must reside on the same machine as the Director.
3070 \item [DB Address = \lt{}address\gt{}]
3071 \index[dir]{DB Address}
3072 \index[dir]{Directive!DB Address}
3073 This is the host address of the database server. Normally, you would specify
3074 this instead of {\bf DB Socket} if the database server is on another machine.
3075 In that case, you will also specify {\bf DB Port}. This directive is used
3076 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3077 This directive is optional.
3079 \item [DB Port = \lt{}port\gt{}]
3080 \index[dir]{DB Port}
3081 \index[dir]{Directive!DB Port}
3082 This defines the port to be used in conjunction with {\bf DB Address} to
3083 access the database if it is on another machine. This directive is used only
3084 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3085 directive is optional.
3087 %% \item [Multiple Connections = \lt{}yes|no\gt{}]
3088 %% \index[dir]{Multiple Connections}
3089 %% \index[dir]{Directive!Multiple Connections}
3090 %% By default, this directive is set to no. In that case, each job that uses
3092 %% same Catalog will use a single connection to the catalog. It will be shared,
3093 %% and Bacula will allow only one Job at a time to communicate. If you set this
3094 %% directive to yes, Bacula will permit multiple connections to the database,
3095 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3096 %% this is no problem. For MySQL, you must be *very* careful to have the
3097 %% multi-thread version of the client library loaded on your system. When this
3098 %% directive is set yes, each Job will have a separate connection to the
3099 %% database, and the database will control the interaction between the
3101 %% Jobs. This can significantly speed up the database operations if you are
3102 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3103 %% Bacula will automatically enable transactions. This can significantly speed
3104 %% up insertion of attributes in the database either for a single Job or
3105 %% multiple simultaneous Jobs.
3107 %% This directive has not been tested. Please test carefully before running it
3108 %% in production and report back your results.
3112 The following is an example of a valid Catalog resource definition:
3121 password = "" # no password = no security
3126 or for a Catalog on another machine:
3136 DB Address = remote.acme.com
3142 \section{The Messages Resource}
3143 \label{MessagesResource2}
3144 \index[general]{Resource!Messages}
3145 \index[general]{Messages Resource}
3147 For the details of the Messages Resource, please see the
3148 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3151 \section{The Console Resource}
3152 \label{ConsoleResource1}
3153 \index[general]{Console Resource}
3154 \index[general]{Resource!Console}
3156 As of Bacula version 1.33 and higher, there are three different kinds of
3157 consoles, which the administrator or user can use to interact with the
3158 Director. These three kinds of consoles comprise three different security
3162 \item The first console type is an {\bf anonymous} or {\bf default} console,
3163 which has full privileges. There is no console resource necessary for
3164 this type since the password is specified in the Director's resource and
3165 consequently such consoles do not have a name as defined on a {\bf Name
3166 =} directive. This is the kind of console that was initially
3167 implemented in versions prior to 1.33 and remains valid. Typically you
3168 would use it only for administrators.
3170 \item The second type of console, and new to version 1.33 and higher is a
3171 "named" console defined within a Console resource in both the Director's
3172 configuration file and in the Console's configuration file. Both the
3173 names and the passwords in these two entries must match much as is the
3174 case for Client programs.
3176 This second type of console begins with absolutely no privileges except
3177 those explicitly specified in the Director's Console resource. Thus you
3178 can have multiple Consoles with different names and passwords, sort of
3179 like multiple users, each with different privileges. As a default,
3180 these consoles can do absolutely nothing -- no commands whatsoever. You
3181 give them privileges or rather access to commands and resources by
3182 specifying access control lists in the Director's Console resource. The
3183 ACLs are specified by a directive followed by a list of access names.
3184 Examples of this are shown below.
3186 \item The third type of console is similar to the above mentioned one in that
3187 it requires a Console resource definition in both the Director and the
3188 Console. In addition, if the console name, provided on the {\bf Name =}
3189 directive, is the same as a Client name, that console is permitted to
3190 use the {\bf SetIP} command to change the Address directive in the
3191 Director's client resource to the IP address of the Console. This
3192 permits portables or other machines using DHCP (non-fixed IP addresses)
3193 to "notify" the Director of their current IP address.
3196 The Console resource is optional and need not be specified. The following
3197 directives are permitted within the Director's configuration resource:
3201 \item [Name = \lt{}name\gt{}]
3203 \index[dir]{Directive!Name}
3204 The name of the console. This name must match the name specified in the
3205 Console's configuration resource (much as is the case with Client
3208 \item [Password = \lt{}password\gt{}]
3209 \index[dir]{Password}
3210 \index[dir]{Directive!Password}
3211 Specifies the password that must be supplied for a named Bacula Console
3212 to be authorized. The same password must appear in the {\bf Console}
3213 resource of the Console configuration file. For added security, the
3214 password is never actually passed across the network but rather a
3215 challenge response hash code created with the password. This directive
3216 is required. If you have either {\bf /dev/random} {\bf bc} on your
3217 machine, Bacula will generate a random password during the configuration
3218 process, otherwise it will be left blank.
3220 The password is plain text. It is not generated through any special
3221 process. However, it is preferable for security reasons to choose
3224 \item [JobACL = \lt{}name-list\gt{}]
3226 \index[dir]{Directive!JobACL}
3227 This directive is used to specify a list of Job resource names that can
3228 be accessed by the console. Without this directive, the console cannot
3229 access any of the Director's Job resources. Multiple Job resource names
3230 may be specified by separating them with commas, and/or by specifying
3231 multiple JobACL directives. For example, the directive may be specified
3236 JobACL = kernsave, "Backup client 1", "Backup client 2"
3237 JobACL = "RestoreFiles"
3242 With the above specification, the console can access the Director's resources
3243 for the four jobs named on the JobACL directives, but for no others.
3245 \item [ClientACL = \lt{}name-list\gt{}]
3246 \index[dir]{ClientACL}
3247 \index[dir]{Directive!ClientACL}
3248 This directive is used to specify a list of Client resource names that can
3250 accessed by the console.
3252 \item [StorageACL = \lt{}name-list\gt{}]
3253 \index[dir]{StorageACL}
3254 \index[dir]{Directive!StorageACL}
3255 This directive is used to specify a list of Storage resource names that can
3256 be accessed by the console.
3258 \item [ScheduleACL = \lt{}name-list\gt{}]
3259 \index[dir]{ScheduleACL}
3260 \index[dir]{Directive!ScheduleACL}
3261 This directive is used to specify a list of Schedule resource names that can
3262 be accessed by the console.
3264 \item [PoolACL = \lt{}name-list\gt{}]
3265 \index[dir]{PoolACL}
3266 \index[dir]{Directive!PoolACL}
3267 This directive is used to specify a list of Pool resource names that can be
3268 accessed by the console.
3270 \item [FileSetACL = \lt{}name-list\gt{}]
3271 \index[dir]{FileSetACL}
3272 \index[dir]{Directive!FileSetACL}
3273 This directive is used to specify a list of FileSet resource names that
3274 can be accessed by the console.
3276 \item [CatalogACL = \lt{}name-list\gt{}]
3277 \index[dir]{CatalogACL}
3278 \index[dir]{Directive!CatalogACL}
3279 This directive is used to specify a list of Catalog resource names that
3280 can be accessed by the console.
3282 \item [CommandACL = \lt{}name-list\gt{}]
3283 \index[dir]{CommandACL}
3284 \index[dir]{Directive!CommandACL}
3285 This directive is used to specify a list of of console commands that can
3286 be executed by the console.
3288 \item [WhereACL = \lt{}string\gt{}]
3289 \index[dir]{WhereACL}
3290 \index[dir]{Directive!WhereACL}
3291 This directive permits you to specify where a restricted console
3292 can restore files. If this directive is not specified, only the
3293 default restore location is permitted (normally {\bf
3294 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3295 user enters will be accepted (not very secure), any other
3296 value specified (there may be multiple WhereACL directives) will
3297 restrict the user to use that path. For example, on a Unix system,
3298 if you specify "/", the file will be restored to the original
3299 location. This directive is untested.
3303 Aside from Director resource names and console command names, the special
3304 keyword {\bf *all*} can be specified in any of the above access control lists.
3305 When this keyword is present, any resource or command name (which ever is
3306 appropriate) will be accepted. For an example configuration file, please see
3308 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3311 \section{The Counter Resource}
3312 \label{CounterResource}
3313 \index[general]{Resource!Counter}
3314 \index[general]{Counter Resource}
3316 The Counter Resource defines a counter variable that can be accessed by
3317 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3319 \ilink{LabelFormat}{Label} directive in this chapter for more
3325 \index[dir]{Counter}
3326 \index[dir]{Directive!Counter}
3327 Start of the Counter resource. Counter directives are optional.
3329 \item [Name = \lt{}name\gt{}]
3331 \index[dir]{Directive!Name}
3332 The name of the Counter. This is the name you will use in the variable
3333 expansion to reference the counter value.
3335 \item [Minimum = \lt{}integer\gt{}]
3336 \index[dir]{Minimum}
3337 \index[dir]{Directive!Minimum}
3338 This specifies the minimum value that the counter can have. It also becomes
3339 the default. If not supplied, zero is assumed.
3341 \item [Maximum = \lt{}integer\gt{}]
3342 \index[dir]{Maximum}
3343 \index[dir]{Directive!Maximum}
3344 \index[dir]{Directive!Maximum}
3345 This is the maximum value value that the counter can have. If not specified
3346 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3347 the 31 power). When the counter is incremented past this value, it is reset
3350 \item [*WrapCounter = \lt{}counter-name\gt{}]
3351 \index[dir]{*WrapCounter}
3352 \index[dir]{Directive!*WrapCounter}
3353 If this value is specified, when the counter is incremented past the
3355 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3356 is incremented. (This is not currently implemented).
3358 \item [Catalog = \lt{}catalog-name\gt{}]
3359 \index[dir]{Catalog}
3360 \index[dir]{Directive!Catalog}
3361 If this directive is specified, the counter and its values will be saved in
3362 the specified catalog. If this directive is not present, the counter will be
3363 redefined each time that Bacula is started.
3366 \section{Example Director Configuration File}
3367 \label{SampleDirectorConfiguration}
3368 \index[general]{File!Example Director Configuration}
3369 \index[general]{Example Director Configuration File}
3371 An example Director configuration file might be the following:
3376 # Default Bacula Director Configuration file
3378 # The only thing that MUST be changed is to add one or more
3379 # file or directory names in the Include directive of the
3382 # For Bacula release 1.15 (5 March 2002) -- redhat
3384 # You might also want to change the default email address
3385 # from root to your address. See the "mail" and "operator"
3386 # directives in the Messages resource.
3388 Director { # define myself
3390 QueryFile = "/home/kern/bacula/bin/query.sql"
3391 WorkingDirectory = "/home/kern/bacula/bin/working"
3392 PidDirectory = "/home/kern/bacula/bin/working"
3393 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3395 # Define the backup Job
3397 Name = "NightlySave"
3399 Level = Incremental # default
3402 Schedule = "WeeklyCycle"
3412 Where = /tmp/bacula-restores
3418 # List of files to be backed up
3422 Options { signature=SHA1}
3424 # Put your list of files here, one per line or include an
3425 # external list with:
3429 # Note: / backs up everything
3434 # When to do the backups
3436 Name = "WeeklyCycle"
3437 Run = level=Full sun at 2:05
3438 Run = level=Incremental mon-sat at 2:05
3440 # Client (File Services) to backup
3445 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3446 File Retention = 60d # sixty day file retention
3447 Job Retention = 1y # 1 year Job retention
3448 AutoPrune = yes # Auto apply retention periods
3450 # Definition of DLT tape storage device
3454 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3455 Device = "HP DLT 80" # same as Device in Storage daemon
3456 Media Type = DLT8000 # same as MediaType in Storage daemon
3458 # Definition for a DLT autochanger device
3462 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3463 Device = "Autochanger" # same as Device in Storage daemon
3464 Media Type = DLT-8000 # Different from DLTDrive
3467 # Definition of DDS tape storage device
3471 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3472 Device = SDT-10000 # same as Device in Storage daemon
3473 Media Type = DDS-4 # same as MediaType in Storage daemon
3475 # Definition of 8mm tape storage device
3479 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3480 Device = "Exabyte 8mm"
3483 # Definition of file storage device
3487 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3488 Device = FileStorage
3491 # Generic catalog service
3494 dbname = bacula; user = bacula; password = ""
3496 # Reasonable message delivery -- send most everything to
3497 # the email address and to the console
3500 mail = root@localhost = all, !skipped, !terminate
3501 operator = root@localhost = mount
3502 console = all, !skipped, !saved
3505 # Default pool definition
3513 # Restricted console used by tray-monitor to get the status of the director
3517 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3518 CommandACL = status, .status