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 [DirSourceAddress = \lt{}IP-Address\gt{}]
308 \index[fd]{DirSourceAddress}
309 \index[fd]{Directive!DirSourceAddress}
310 This record is optional, and if it is specified, it will cause the Director
311 server (when initiating connections to a storage or file daemon) to source
312 its connections from the specified address. Only a single IP address may be
313 specified. If this record is not specified, the Director server will source
314 its outgoing connections according to the system routing table (the default).
316 \item[Statistics Retention = \lt{}time\gt{}]
317 \index[dir]{StatisticsRetention}
318 \index[dir]{Directive!StatisticsRetention}
319 \label{PruneStatistics}
321 The \texttt{Statistics Retention} directive defines the length of time that
322 Bacula will keep statistics job records in the Catalog database after the
323 Job End time. (In \texttt{JobHistory} table) When this time period expires,
324 and if user runs \texttt{prune stats} command, Bacula will prune (remove)
325 Job records that are older than the specified period.
327 Theses statistics records aren't use for restore purpose, but mainly for
328 capacity planning, billings, etc. See \ilink{Statistics chapter} for
329 additional information.
331 See the \ilink{ Configuration chapter}{Time} of this manual for additional
332 details of time specification.
334 The default is 5 years.
336 \item[VerId = \lt{}string\gt{}]
337 \index[dir]{Directive!VerId}
338 where \lt{}string\gt{} is an identifier which can be used for support purpose.
339 This string is displayed using the \texttt{version} command.
341 \item[MaximumConsoleConnections = \lt{}number\gt{}]
342 \index[dir]{MaximumConsoleConnections}
343 \index[dir]{Directive!MaximumConsoleConnections}
345 where \lt{}number\gt{} is the maximum number of Console Connections that
346 could run concurrently. The default is set to 20, but you may set it to a
351 The following is an example of a valid Director resource definition:
357 WorkingDirectory = "$HOME/bacula/bin/working"
358 Password = UA_password
359 PidDirectory = "$HOME/bacula/bin/working"
360 QueryFile = "$HOME/bacula/bin/query.sql"
366 \section{The Job Resource}
368 \index[general]{Resource!Job}
369 \index[general]{Job Resource}
371 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
372 perform. Each Job resource definition contains the name of a Client and
373 a FileSet to backup, the Schedule for the Job, where the data
374 are to be stored, and what media Pool can be used. In effect, each Job
375 resource must specify What, Where, How, and When or FileSet, Storage,
376 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
377 be specified for a restore job for historical reasons, but it is no longer used.
379 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
380 job. If you want to backup multiple FileSets on the same Client or multiple
381 Clients, you must define a Job for each one.
383 Note, you define only a single Job to do the Full, Differential, and
384 Incremental backups since the different backup levels are tied together by
385 a unique Job name. Normally, you will have only one Job per Client, but
386 if a client has a really huge number of files (more than several million),
387 you might want to split it into to Jobs each with a different FileSet
388 covering only part of the total files.
390 Multiple Storage daemons are not currently supported for Jobs, so if
391 you do want to use multiple storage daemons, you will need to create
392 a different Job and ensure that for each Job that the combination of
393 Client and FileSet are unique. The Client and FileSet are what Bacula
394 uses to restore a client, so if there are multiple Jobs with the same
395 Client and FileSet or multiple Storage daemons that are used, the
396 restore will not work. This problem can be resolved by defining multiple
397 FileSet definitions (the names must be different, but the contents of
398 the FileSets may be the same).
405 \index[dir]{Directive!Job}
406 Start of the Job resource. At least one Job resource is required.
408 \item [Name = \lt{}name\gt{}]
410 \index[dir]{Directive!Name}
411 The Job name. This name can be specified on the {\bf Run} command in the
412 console program to start a job. If the name contains spaces, it must be
413 specified between quotes. It is generally a good idea to give your job the
414 same name as the Client that it will backup. This permits easy
415 identification of jobs.
417 When the job actually runs, the unique Job Name will consist of the name you
418 specify here followed by the date and time the job was scheduled for
419 execution. This directive is required.
421 \item [Enabled = \lt{}yes\vb{}no\gt{}]
423 \index[dir]{Directive!Enable}
424 This directive allows you to enable or disable automatic execution
425 via the scheduler of a Job.
427 \item [Type = \lt{}job-type\gt{}]
429 \index[dir]{Directive!Type}
430 The {\bf Type} directive specifies the Job type, which may be one of the
431 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
432 directive is required. Within a particular Job Type, there are also Levels
433 as discussed in the next item.
439 Run a backup Job. Normally you will have at least one Backup job for each
440 client you want to save. Normally, unless you turn off cataloging, most all
441 the important statistics and data concerning files backed up will be placed
446 Run a restore Job. Normally, you will specify only one Restore job
447 which acts as a sort of prototype that you will modify using the console
448 program in order to perform restores. Although certain basic
449 information from a Restore job is saved in the catalog, it is very
450 minimal compared to the information stored for a Backup job -- for
451 example, no File database entries are generated since no Files are
454 {\bf Restore} jobs cannot be
455 automatically started by the scheduler as is the case for Backup, Verify
456 and Admin jobs. To restore files, you must use the {\bf restore} command
462 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
463 contents of the catalog to the file system, or to what was backed up. In
464 addition, to verifying that a tape that was written can be read, you can
465 also use {\bf verify} as a sort of tripwire intrusion detection.
469 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
470 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
471 Although an Admin job is recorded in the catalog, very little data is saved.
476 \item [Level = \lt{}job-level\gt{}]
478 \index[dir]{Directive!Level}
479 The Level directive specifies the default Job level to be run. Each
480 different Job Type (Backup, Restore, ...) has a different set of Levels
481 that can be specified. The Level is normally overridden by a different
482 value that is specified in the {\bf Schedule} resource. This directive
483 is not required, but must be specified either by a {\bf Level} directive
484 or as an override specified in the {\bf Schedule} resource.
486 For a {\bf Backup} Job, the Level may be one of the following:
492 When the Level is set to Full all files in the FileSet whether or not
493 they have changed will be backed up.
496 \index[dir]{Incremental}
497 When the Level is set to Incremental all files specified in the FileSet
498 that have changed since the last successful backup of the the same Job
499 using the same FileSet and Client, will be backed up. If the Director
500 cannot find a previous valid Full backup then the job will be upgraded
501 into a Full backup. When the Director looks for a valid backup record
502 in the catalog database, it looks for a previous Job with:
505 \item The same Job name.
506 \item The same Client name.
507 \item The same FileSet (any change to the definition of the FileSet such as
508 adding or deleting a file in the Include or Exclude sections constitutes a
510 \item The Job was a Full, Differential, or Incremental backup.
511 \item The Job terminated normally (i.e. did not fail or was not canceled).
512 \item The Job started no longer ago than {\bf Max Full Interval}.
515 If all the above conditions do not hold, the Director will upgrade the
516 Incremental to a Full save. Otherwise, the Incremental backup will be
517 performed as requested.
519 The File daemon (Client) decides which files to backup for an
520 Incremental backup by comparing start time of the prior Job (Full,
521 Differential, or Incremental) against the time each file was last
522 "modified" (st\_mtime) and the time its attributes were last
523 "changed"(st\_ctime). If the file was modified or its attributes
524 changed on or after this start time, it will then be backed up.
526 Some virus scanning software may change st\_ctime while
527 doing the scan. For example, if the virus scanning program attempts to
528 reset the access time (st\_atime), which Bacula does not use, it will
529 cause st\_ctime to change and hence Bacula will backup the file during
530 an Incremental or Differential backup. In the case of Sophos virus
531 scanning, you can prevent it from resetting the access time (st\_atime)
532 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
533 option. For other software, please see their manual.
535 When Bacula does an Incremental backup, all modified files that are
536 still on the system are backed up. However, any file that has been
537 deleted since the last Full backup remains in the Bacula catalog,
538 which means that if between a Full save and the time you do a
539 restore, some files are deleted, those deleted files will also be
540 restored. The deleted files will no longer appear in the catalog
541 after doing another Full save.
543 In addition, if you move a directory rather than copy it, the files in
544 it do not have their modification time (st\_mtime) or their attribute
545 change time (st\_ctime) changed. As a consequence, those files will
546 probably not be backed up by an Incremental or Differential backup which
547 depend solely on these time stamps. If you move a directory, and wish
548 it to be properly backed up, it is generally preferable to copy it, then
551 However, to manage deleted files or directories changes in the
552 catalog during an Incremental backup you can use \texttt{accurate}
553 mode. This is quite memory consuming process. See \ilink{Accurate
554 mode}{accuratemode} for more details.
557 \index[dir]{Differential}
558 When the Level is set to Differential
559 all files specified in the FileSet that have changed since the last
560 successful Full backup of the same Job will be backed up.
561 If the Director cannot find a
562 valid previous Full backup for the same Job, FileSet, and Client,
563 backup, then the Differential job will be upgraded into a Full backup.
564 When the Director looks for a valid Full backup record in the catalog
565 database, it looks for a previous Job with:
568 \item The same Job name.
569 \item The same Client name.
570 \item The same FileSet (any change to the definition of the FileSet such as
571 adding or deleting a file in the Include or Exclude sections constitutes a
573 \item The Job was a FULL backup.
574 \item The Job terminated normally (i.e. did not fail or was not canceled).
575 \item The Job started no longer ago than {\bf Max Full Interval}.
578 If all the above conditions do not hold, the Director will upgrade the
579 Differential to a Full save. Otherwise, the Differential backup will be
580 performed as requested.
582 The File daemon (Client) decides which files to backup for a
583 differential backup by comparing the start time of the prior Full backup
584 Job against the time each file was last "modified" (st\_mtime) and the
585 time its attributes were last "changed" (st\_ctime). If the file was
586 modified or its attributes were changed on or after this start time, it
587 will then be backed up. The start time used is displayed after the {\bf
588 Since} on the Job report. In rare cases, using the start time of the
589 prior backup may cause some files to be backed up twice, but it ensures
590 that no change is missed. As with the Incremental option, you should
591 ensure that the clocks on your server and client are synchronized or as
592 close as possible to avoid the possibility of a file being skipped.
593 Note, on versions 1.33 or greater Bacula automatically makes the
594 necessary adjustments to the time between the server and the client so
595 that the times Bacula uses are synchronized.
597 When Bacula does a Differential backup, all modified files that are
598 still on the system are backed up. However, any file that has been
599 deleted since the last Full backup remains in the Bacula catalog, which
600 means that if between a Full save and the time you do a restore, some
601 files are deleted, those deleted files will also be restored. The
602 deleted files will no longer appear in the catalog after doing another
603 Full save. However, to remove deleted files from the catalog during a
604 Differential backup is quite a time consuming process and not currently
605 implemented in Bacula. It is, however, a planned future feature.
607 As noted above, if you move a directory rather than copy it, the
608 files in it do not have their modification time (st\_mtime) or
609 their attribute change time (st\_ctime) changed. As a
610 consequence, those files will probably not be backed up by an
611 Incremental or Differential backup which depend solely on these
612 time stamps. If you move a directory, and wish it to be
613 properly backed up, it is generally preferable to copy it, then
614 delete the original. Alternatively, you can move the directory, then
615 use the {\bf touch} program to update the timestamps.
617 %% TODO: merge this with incremental
618 However, to manage deleted files or directories changes in the
619 catalog during an Differential backup you can use \texttt{accurate}
620 mode. This is quite memory consuming process. See \ilink{Accurate
621 mode}{accuratemode} for more details.
623 Every once and a while, someone asks why we need Differential
624 backups as long as Incremental backups pickup all changed files.
625 There are possibly many answers to this question, but the one
626 that is the most important for me is that a Differential backup
628 all the Incremental and Differential backups since the last Full backup
629 into a single Differential backup. This has two effects: 1. It gives
630 some redundancy since the old backups could be used if the merged backup
631 cannot be read. 2. More importantly, it reduces the number of Volumes
632 that are needed to do a restore effectively eliminating the need to read
633 all the volumes on which the preceding Incremental and Differential
634 backups since the last Full are done.
638 For a {\bf Restore} Job, no level needs to be specified.
640 For a {\bf Verify} Job, the Level may be one of the following:
645 \index[dir]{InitCatalog}
646 does a scan of the specified {\bf FileSet} and stores the file
647 attributes in the Catalog database. Since no file data is saved, you
648 might ask why you would want to do this. It turns out to be a very
649 simple and easy way to have a {\bf Tripwire} like feature using {\bf
650 Bacula}. In other words, it allows you to save the state of a set of
651 files defined by the {\bf FileSet} and later check to see if those files
652 have been modified or deleted and if any new files have been added.
653 This can be used to detect system intrusion. Typically you would
654 specify a {\bf FileSet} that contains the set of system files that
655 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
656 run the {\bf InitCatalog} level verify one time when your system is
657 first setup, and then once again after each modification (upgrade) to
658 your system. Thereafter, when your want to check the state of your
659 system files, you use a {\bf Verify} {\bf level = Catalog}. This
660 compares the results of your {\bf InitCatalog} with the current state of
665 Compares the current state of the files against the state previously
666 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
667 items reported are determined by the {\bf verify} options specified on
668 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
669 FileSet} resource below for more details). Typically this command will
670 be run once a day (or night) to check for any changes to your system
673 Please note! If you run two Verify Catalog jobs on the same client at
674 the same time, the results will certainly be incorrect. This is because
675 Verify Catalog modifies the Catalog database while running in order to
678 \item [VolumeToCatalog]
679 \index[dir]{VolumeToCatalog}
680 This level causes Bacula to read the file attribute data written to the
681 Volume from the last Job. The file attribute data are compared to the
682 values saved in the Catalog database and any differences are reported.
683 This is similar to the {\bf Catalog} level except that instead of
684 comparing the disk file attributes to the catalog database, the
685 attribute data written to the Volume is read and compared to the catalog
686 database. Although the attribute data including the signatures (MD5 or
687 SHA1) are compared, the actual file data is not compared (it is not in
690 Please note! If you run two Verify VolumeToCatalog jobs on the same
691 client at the same time, the results will certainly be incorrect. This
692 is because the Verify VolumeToCatalog modifies the Catalog database
695 \item [DiskToCatalog]
696 \index[dir]{DiskToCatalog}
697 This level causes Bacula to read the files as they currently are on
698 disk, and to compare the current file attributes with the attributes
699 saved in the catalog from the last backup for the job specified on the
700 {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
701 level described above by the fact that it doesn't compare against a
702 previous Verify job but against a previous backup. When you run this
703 level, you must supply the verify options on your Include statements.
704 Those options determine what attribute fields are compared.
706 This command can be very useful if you have disk problems because it
707 will compare the current state of your disk against the last successful
708 backup, which may be several jobs.
710 Note, the current implementation (1.32c) does not identify files that
714 \item [Accurate = \lt{}yes\vb{}no\gt{}]
715 \index[dir]{Accurate}
716 In accurate mode, the File daemon knowns exactly which files were present
717 after the last backup. So it is able to handle deleted or renamed files.
719 When restoring a FileSet for a specified date (including "most
720 recent"), Bacula is able to restore exactly the files and
721 directories that existed at the time of the last backup prior to
722 that date including ensuring that deleted files are actually deleted,
723 and renamed directories are restored properly.
725 In this mode, the File daemon must keep data concerning all files in
726 memory. So you do not have sufficient memory, the restore may
727 either be terribly slow or fail.
729 %% $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
731 For 500.000 files (a typical desktop linux system), it will require
732 approximately 64 Megabytes of RAM on your File daemon to hold the
733 required information.
735 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
736 \index[dir]{Verify Job}
737 \index[dir]{Directive!Verify Job}
738 If you run a verify job without this directive, the last job run will be
739 compared with the catalog, which means that you must immediately follow
740 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
741 will find the last job with that name that ran. This permits you to run
742 all your backups, then run Verify jobs on those that you wish to be
743 verified (most often a {\bf VolumeToCatalog}) so that the tape just
746 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
748 \index[dir]{Directive!JobDefs}
749 If a JobDefs-Resource-Name is specified, all the values contained in the
750 named JobDefs resource will be used as the defaults for the current Job.
751 Any value that you explicitly define in the current Job resource, will
752 override any defaults specified in the JobDefs resource. The use of
753 this directive permits writing much more compact Job resources where the
754 bulk of the directives are defined in one or more JobDefs. This is
755 particularly useful if you have many similar Jobs but with minor
756 variations such as different Clients. A simple example of the use of
757 JobDefs is provided in the default bacula-dir.conf file.
759 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
760 \index[dir]{Bootstrap}
761 \index[dir]{Directive!Bootstrap}
762 The Bootstrap directive specifies a bootstrap file that, if provided,
763 will be used during {\bf Restore} Jobs and is ignored in other Job
764 types. The {\bf bootstrap} file contains the list of tapes to be used
765 in a restore Job as well as which files are to be restored.
766 Specification of this directive is optional, and if specified, it is
767 used only for a restore job. In addition, when running a Restore job
768 from the console, this value can be changed.
770 If you use the {\bf Restore} command in the Console program, to start a
771 restore job, the {\bf bootstrap} file will be created automatically from
772 the files you select to be restored.
774 For additional details of the {\bf bootstrap} file, please see
775 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
778 \label{writebootstrap}
779 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
780 \index[dir]{Write Bootstrap}
781 \index[dir]{Directive!Write Bootstrap}
782 The {\bf writebootstrap} directive specifies a file name where Bacula
783 will write a {\bf bootstrap} file for each Backup job run. This
784 directive applies only to Backup Jobs. If the Backup job is a Full
785 save, Bacula will erase any current contents of the specified file
786 before writing the bootstrap records. If the Job is an Incremental
788 save, Bacula will append the current bootstrap record to the end of the
791 Using this feature, permits you to constantly have a bootstrap file that
792 can recover the current state of your system. Normally, the file
793 specified should be a mounted drive on another machine, so that if your
794 hard disk is lost, you will immediately have a bootstrap record
795 available. Alternatively, you should copy the bootstrap file to another
796 machine after it is updated. Note, it is a good idea to write a separate
797 bootstrap file for each Job backed up including the job that backs up
798 your catalog database.
800 If the {\bf bootstrap-file-specification} begins with a vertical bar
801 (\verb+|+), Bacula will use the specification as the name of a program to which
802 it will pipe the bootstrap record. It could for example be a shell
803 script that emails you the bootstrap record.
805 On versions 1.39.22 or greater, before opening the file or executing the
806 specified command, Bacula performs
807 \ilink{character substitution}{character substitution} like in RunScript
808 directive. To automatically manage your bootstrap files, you can use
809 this in your {\bf JobDefs} resources:
812 Write Bootstrap = "%c_%n.bsr"
817 For more details on using this file, please see the chapter entitled
818 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
820 \item [Client = \lt{}client-resource-name\gt{}]
822 \index[dir]{Directive!Client}
823 The Client directive specifies the Client (File daemon) that will be used in
824 the current Job. Only a single Client may be specified in any one Job. The
825 Client runs on the machine to be backed up, and sends the requested files to
826 the Storage daemon for backup, or receives them when restoring. For
827 additional details, see the
828 \ilink{Client Resource section}{ClientResource2} of this chapter.
829 This directive is required.
831 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
834 The FileSet directive specifies the FileSet that will be used in the
835 current Job. The FileSet specifies which directories (or files) are to
836 be backed up, and what options to use (e.g. compression, ...). Only a
837 single FileSet resource may be specified in any one Job. For additional
838 details, see the \ilink{FileSet Resource section}{FileSetResource} of
839 this chapter. This directive is required.
841 \item [Messages = \lt{}messages-resource-name\gt{}]
842 \index[dir]{Messages}
843 \index[dir]{Directive!Messages}
844 The Messages directive defines what Messages resource should be used for
845 this job, and thus how and where the various messages are to be
846 delivered. For example, you can direct some messages to a log file, and
847 others can be sent by email. For additional details, see the
848 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
849 directive is required.
851 \item [Pool = \lt{}pool-resource-name\gt{}]
853 \index[dir]{Directive!Pool}
854 The Pool directive defines the pool of Volumes where your data can be
855 backed up. Many Bacula installations will use only the {\bf Default}
856 pool. However, if you want to specify a different set of Volumes for
857 different Clients or different Jobs, you will probably want to use
858 Pools. For additional details, see the \ilink{Pool Resource
859 section}{PoolResource} of this chapter. This directive is required.
861 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
862 \index[dir]{Full Backup Pool}
863 \index[dir]{Directive!Full Backup Pool}
864 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
865 It will override any Pool specification during a Full backup. This
866 directive is optional.
868 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
869 \index[dir]{Differential Backup Pool}
870 \index[dir]{Directive!Differential Backup Pool}
871 The {\it Differential Backup Pool} specifies a Pool to be used for
872 Differential backups. It will override any Pool specification during a
873 Differential backup. This directive is optional.
875 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
876 \index[dir]{Incremental Backup Pool}
877 \index[dir]{Directive!Incremental Backup Pool}
878 The {\it Incremental Backup Pool} specifies a Pool to be used for
879 Incremental backups. It will override any Pool specification during an
880 Incremental backup. This directive is optional.
882 \item [Schedule = \lt{}schedule-name\gt{}]
883 \index[dir]{Schedule}
884 \index[dir]{Directive!Schedule}
885 The Schedule directive defines what schedule is to be used for the Job.
886 The schedule in turn determines when the Job will be automatically
887 started and what Job level (i.e. Full, Incremental, ...) is to be run.
888 This directive is optional, and if left out, the Job can only be started
889 manually using the Console program. Although you may specify only a
890 single Schedule resource for any one job, the Schedule resource may
891 contain multiple {\bf Run} directives, which allow you to run the Job at
892 many different times, and each {\bf run} directive permits overriding
893 the default Job Level Pool, Storage, and Messages resources. This gives
894 considerable flexibility in what can be done with a single Job. For
895 additional details, see the \ilink{Schedule Resource
896 Chapter}{ScheduleResource} of this manual.
899 \item [Storage = \lt{}storage-resource-name\gt{}]
901 \index[dir]{Directive!Storage}
902 The Storage directive defines the name of the storage services where you
903 want to backup the FileSet data. For additional details, see the
904 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
905 The Storage resource may also be specified in the Job's Pool resource,
906 in which case the value in the Pool resource overrides any value
907 in the Job. This Storage resource definition is not required by either
908 the Job resource or in the Pool, but it must be specified in
909 one or the other, if not an error will result.
911 \item [Max Start Delay = \lt{}time\gt{}]
912 \index[dir]{Max Start Delay}
913 \index[dir]{Directive!Max Start Delay}
914 The time specifies the maximum delay between the scheduled time and the
915 actual start time for the Job. For example, a job can be scheduled to
916 run at 1:00am, but because other jobs are running, it may wait to run.
917 If the delay is set to 3600 (one hour) and the job has not begun to run
918 by 2:00am, the job will be canceled. This can be useful, for example,
919 to prevent jobs from running during day time hours. The default is 0
920 which indicates no limit.
922 \item [Max Run Time = \lt{}time\gt{}]
923 \index[dir]{Max Run Time}
924 \index[dir]{Directive!Max Run Time}
925 The time specifies the maximum allowed time that a job may run, counted
926 from when the job starts, ({\bf not} necessarily the same as when the
929 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
930 \index[dir]{Incremental Wait Run Time}
931 \index[dir]{Differential Wait Run Time}
932 \index[dir]{Directive!Differential Max Wait Time}
933 Theses directives have been deprecated in favor of
934 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
936 \item [Incremental Max Run Time = \lt{}time\gt{}]
937 \index[dir]{Incremental Max Run Time}
938 \index[dir]{Directive!Incremental Max Run Time}
939 The time specifies the maximum allowed time that an Incremental backup job may
940 run, counted from when the job starts, ({\bf not} necessarily the same as when
941 the job was scheduled).
943 \item [Differential Max Wait Time = \lt{}time\gt{}]
944 \index[dir]{Differential Max Run Time}
945 \index[dir]{Directive!Differential Max Run Time}
946 The time specifies the maximum allowed time that a Differential backup job may
947 run, counted from when the job starts, ({\bf not} necessarily the same as when
948 the job was scheduled).
950 \item [Max Run Sched Time = \lt{}time\gt{}]
951 \index[dir]{Max Run Sched Time}
952 \index[dir]{Directive!Max Run Sched Time}
954 The time specifies the maximum allowed time that a job may run, counted from
955 when the job was scheduled. This can be useful to prevent jobs from running
956 during working hours. We can see it like \texttt{Max Start Delay + Max Run
959 \item [Max Wait Time = \lt{}time\gt{}]
960 \index[dir]{Max Wait Time}
961 \index[dir]{Directive!Max Wait Time}
962 The time specifies the maximum allowed time that a job may block waiting
963 for a resource (such as waiting for a tape to be mounted, or waiting for
964 the storage or file daemons to perform their duties), counted from the
965 when the job starts, ({\bf not} necessarily the same as when the job was
966 scheduled). This directive works as expected since bacula 2.3.18.
970 \includegraphics[width=13cm]{\idir different_time.eps}
971 \caption{Job time control directives}
972 \label{fig:differenttime}
975 \item [Maximum Bandwidth = \lt{}speed\gt{}]
976 \index[dir]{Maximum Bandwidth}
977 \index[dir]{Directive!Maximum Bandwidth}
979 The speed parameter specifies the maximum allowed bandwidth that a job may
980 use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
982 \item [Max Full Interval = \lt{}time\gt{}]
983 \index[dir]{Max Full Interval}
984 \index[dir]{Directive!Max Full Interval}
985 The time specifies the maximum allowed age (counting from start time) of
986 the most recent successful Full backup that is required in order to run
987 Incremental or Differential backup jobs. If the most recent Full backup
988 is older than this interval, Incremental and Differential backups will be
989 upgraded to Full backups automatically. If this directive is not present,
990 or specified as 0, then the age of the previous Full backup is not
993 \label{PreferMountedVolumes}
994 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
995 \index[dir]{Prefer Mounted Volumes}
996 \index[dir]{Directive!Prefer Mounted Volumes}
997 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
998 yes), the Storage daemon is requested to select either an Autochanger or
999 a drive with a valid Volume already mounted in preference to a drive
1000 that is not ready. This means that all jobs will attempt to append
1001 to the same Volume (providing the Volume is appropriate -- right Pool,
1002 ... for that job), unless you are using multiple pools.
1003 If no drive with a suitable Volume is available, it
1004 will select the first available drive. Note, any Volume that has
1005 been requested to be mounted, will be considered valid as a mounted
1006 volume by another job. This if multiple jobs start at the same time
1007 and they all prefer mounted volumes, the first job will request the
1008 mount, and the other jobs will use the same volume.
1010 If the directive is set to {\bf no}, the Storage daemon will prefer
1011 finding an unused drive, otherwise, each job started will append to the
1012 same Volume (assuming the Pool is the same for all jobs). Setting
1013 Prefer Mounted Volumes to no can be useful for those sites
1014 with multiple drive autochangers that prefer to maximize backup
1015 throughput at the expense of using additional drives and Volumes.
1016 This means that the job will prefer to use an unused drive rather
1017 than use a drive that is already in use.
1019 Despite the above, we recommend against setting this directive to
1021 it tends to add a lot of swapping of Volumes between the different
1022 drives and can easily lead to deadlock situations in the Storage
1023 daemon. We will accept bug reports against it, but we cannot guarantee
1024 that we will be able to fix the problem in a reasonable time.
1026 A better alternative for using multiple drives is to use multiple
1027 pools so that Bacula will be forced to mount Volumes from those Pools
1028 on different drives.
1030 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1031 \index[dir]{Prune Jobs}
1032 \index[dir]{Directive!Prune Jobs}
1033 Normally, pruning of Jobs from the Catalog is specified on a Pool by
1034 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1035 If this directive is specified (not normally) and the value is {\bf
1036 yes}, it will override the value specified in the Pool resource. The
1037 default is {\bf no}.
1040 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1041 \index[dir]{Prune Files}
1042 \index[dir]{Directive!Prune Files}
1043 Normally, pruning of Files from the Catalog is specified on a Pool by
1044 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1045 If this directive is specified (not normally) and the value is {\bf
1046 yes}, it will override the value specified in the Pool resource. The
1047 default is {\bf no}.
1049 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1050 \index[dir]{Prune Volumes}
1051 \index[dir]{Directive!Prune Volumes}
1052 Normally, pruning of Volumes from the Catalog is specified on a Pool
1053 by Pool basis in the Pool resource with the {\bf AutoPrune}
1054 directive. If this directive is specified (not normally) and the value
1055 is {\bf yes}, it will override the value specified in the Pool
1056 resource. The default is {\bf no}.
1058 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1059 \index[dir]{RunScript}
1060 \index[dir]{Directive!Run Script}
1062 The RunScript directive behaves like a resource in that it
1063 requires opening and closing braces around a number of directives
1064 that make up the body of the runscript.
1066 The specified {\bf Command} (see below for details) is run as an external
1067 program prior or after the current Job. This is optional. By default, the
1068 program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1070 \textbf{Console} options are special commands that are sent to the director instead
1071 of the OS. At this time, console command ouputs are redirected to log with
1074 You can use following console command : \texttt{delete}, \texttt{disable},
1075 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1076 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1077 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1078 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1079 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1080 more information. You need to specify needed information on command line, nothing
1081 will be prompted. Example :
1084 Console = "prune files client=%c"
1085 Console = "update stats age=3"
1088 You can specify more than one Command/Console option per RunScript.
1090 You can use following options may be specified in the body
1093 \begin{tabular}{|c|c|c|l}
1094 Options & Value & Default & Information \\
1097 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
1099 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
1101 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
1103 Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
1105 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
1106 something different from 0 \\
1108 Command & & & Path to your script\\
1110 Console & & & Console command\\
1115 Any output sent by the command to standard output will be included in the
1116 Bacula job report. The command string must be a valid program name or name
1119 In addition, the command string is parsed then fed to the OS,
1120 which means that the path will be searched to execute your specified
1121 command, but there is no shell interpretation, as a consequence, if you
1122 invoke complicated commands or want any shell features such as redirection
1123 or piping, you must call a shell script and do it inside that script.
1125 Before submitting the specified command to the operating system, Bacula
1126 performs character substitution of the following characters:
1128 \label{character substitution}
1133 %d = Director's name
1134 %e = Job Exit Status
1140 %t = Job type (Backup, ...)
1141 %v = Volume name (Only on director side)
1146 The Job Exit Status code \%e edits the following values:
1148 \index[dir]{Exit Status}
1155 \item Unknown term code
1158 Thus if you edit it on a command line, you will need to enclose
1159 it within some sort of quotes.
1162 You can use these following shortcuts:\\
1164 \begin{tabular}{|c|c|c|c|c|c}
1165 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1167 Run Before Job & & & Yes & No & Before \\
1169 Run After Job & Yes & No & & No & After \\
1171 Run After Failed Job & No & Yes & & No & After \\
1173 Client Run Before Job & & & Yes & Yes & Before \\
1175 Client Run After Job & Yes & No & & Yes & After \\
1183 Command = "/etc/init.d/apache stop"
1189 Command = "/etc/init.d/apache start"
1193 {\bf Notes about ClientRunBeforeJob}
1195 For compatibility reasons, with this shortcut, the command is executed
1196 directly when the client recieve it. And if the command is in error, other
1197 remote runscripts will be discarded. To be sure that all commands will be
1198 sent and executed, you have to use RunScript syntax.
1200 {\bf Special Windows Considerations}
1202 You can run scripts just after snapshots initializations with
1203 \textsl{AfterVSS} keyword.
1205 In addition, for a Windows client on version 1.33 and above, please take
1206 note that you must ensure a correct path to your script. The script or
1207 program can be a .com, .exe or a .bat file. If you just put the program
1208 name in then Bacula will search using the same rules that cmd.exe uses
1209 (current directory, Bacula bin directory, and PATH). It will even try the
1210 different extensions in the same order as cmd.exe.
1211 The command can be anything that cmd.exe or command.com will recognize
1212 as an executable file.
1214 However, if you have slashes in the program name then Bacula figures you
1215 are fully specifying the name, so you must also explicitly add the three
1216 character extension.
1218 The command is run in a Win32 environment, so Unix like commands will not
1219 work unless you have installed and properly configured Cygwin in addition
1220 to and separately from Bacula.
1222 The System \%Path\% will be searched for the command. (under the
1223 environment variable dialog you have have both System Environment and
1224 User Environment, we believe that only the System environment will be
1225 available to bacula-fd, if it is running as a service.)
1227 System environment variables can be referenced with \%var\% and
1228 used as either part of the command name or arguments.
1230 So if you have a script in the Bacula\\bin directory then the following lines
1235 Client Run Before Job = systemstate
1237 Client Run Before Job = systemstate.bat
1239 Client Run Before Job = "systemstate"
1241 Client Run Before Job = "systemstate.bat"
1243 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1247 The outer set of quotes is removed when the configuration file is parsed.
1248 You need to escape the inner quotes so that they are there when the code
1249 that parses the command line for execution runs so it can tell what the
1255 ClientRunBeforeJob = "\"C:/Program Files/Software
1256 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1260 The special characters
1264 will need to be quoted,
1265 if they are part of a filename or argument.
1267 If someone is logged in, a blank "command" window running the commands
1268 will be present during the execution of the command.
1270 Some Suggestions from Phil Stracchino for running on Win32 machines with
1271 the native Win32 File daemon:
1274 \item You might want the ClientRunBeforeJob directive to specify a .bat
1275 file which runs the actual client-side commands, rather than trying
1276 to run (for example) regedit /e directly.
1277 \item The batch file should explicitly 'exit 0' on successful completion.
1278 \item The path to the batch file should be specified in Unix form:
1280 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1282 rather than DOS/Windows form:
1284 ClientRunBeforeJob =
1286 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1290 For Win32, please note that there are certain limitations:
1292 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1294 Lines like the above do not work because there are limitations of
1295 cmd.exe that is used to execute the command.
1296 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1297 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1298 cmd prompt and see what happens. Once the command is correct insert a
1299 backslash (\textbackslash{}) before each double quote ("), and
1300 then put quotes around the whole thing when putting it in
1301 the director's .conf file. You either need to have only one set of quotes
1302 or else use the short name and don't put quotes around the command path.
1304 Below is the output from cmd's help as it relates to the command line
1305 passed to the /c option.
1308 If /C or /K is specified, then the remainder of the command line after
1309 the switch is processed as a command line, where the following logic is
1310 used to process quote (") characters:
1314 If all of the following conditions are met, then quote characters
1315 on the command line are preserved:
1318 \item exactly two quote characters.
1319 \item no special characters between the two quote characters,
1320 where special is one of:
1324 \item there are one or more whitespace characters between the
1325 the two quote characters.
1326 \item the string between the two quote characters is the name
1327 of an executable file.
1330 \item Otherwise, old behavior is to see if the first character is
1331 a quote character and if so, strip the leading character and
1332 remove the last quote character on the command line, preserving
1333 any text after the last quote character.
1338 The following example of the use of the Client Run Before Job directive was
1339 submitted by a user:\\
1340 You could write a shell script to back up a DB2 database to a FIFO. The shell
1350 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1355 The following line in the Job resource in the bacula-dir.conf file:
1358 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1363 When the job is run, you will get messages from the output of the script
1364 stating that the backup has started. Even though the command being run is
1365 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1366 command, thus the backup stalls.
1368 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1373 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1378 It is important to redirect the input and outputs of a backgrounded command to
1379 /dev/null to prevent the script from blocking.
1381 \item [Run Before Job = \lt{}command\gt{}]
1382 \index[dir]{Run Before Job}
1383 \index[dir]{Directive!Run Before Job}
1384 \index[dir]{Directive!Run Before Job}
1385 The specified {\bf command} is run as an external program prior to running the
1386 current Job. This directive is not required, but if it is defined, and if the
1387 exit code of the program run is non-zero, the current Bacula job will be
1391 Run Before Job = "echo test"
1393 it's equivalent to :
1396 Command = "echo test"
1402 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1403 simple way to modify your schedules during a holiday. For example, suppose
1404 that you normally do Full backups on Fridays, but Thursday and Friday are
1405 holidays. To avoid having to change tapes between Thursday and Friday when
1406 no one is in the office, you can create a RunBeforeJob that returns a
1407 non-zero status on Thursday and zero on all other days. That way, the
1408 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1409 before leaving will be used.
1411 \item [Run After Job = \lt{}command\gt{}]
1412 \index[dir]{Run After Job}
1413 \index[dir]{Directive!Run After Job}
1414 The specified {\bf command} is run as an external program if the current
1415 job terminates normally (without error or without being canceled). This
1416 directive is not required. If the exit code of the program run is
1417 non-zero, Bacula will print a warning message. Before submitting the
1418 specified command to the operating system, Bacula performs character
1419 substitution as described above for the {\bf RunScript} directive.
1421 An example of the use of this directive is given in the
1422 \ilink{Tips Chapter}{JobNotification} of this manual.
1424 See the {\bf Run After Failed Job} if you
1425 want to run a script after the job has terminated with any
1428 \item [Run After Failed Job = \lt{}command\gt{}]
1429 \index[dir]{Run After Job}
1430 \index[dir]{Directive!Run After Job}
1431 The specified {\bf command} is run as an external program after the current
1432 job terminates with any error status. This directive is not required. The
1433 command string must be a valid program name or name of a shell script. If
1434 the exit code of the program run is non-zero, Bacula will print a
1435 warning message. Before submitting the specified command to the
1436 operating system, Bacula performs character substitution as described above
1437 for the {\bf RunScript} directive. Note, if you wish that your script
1438 will run regardless of the exit status of the Job, you can use this :
1441 Command = "echo test"
1445 RunsOnSuccess = yes # default, you can drop this line
1449 An example of the use of this directive is given in the
1450 \ilink{Tips Chapter}{JobNotification} of this manual.
1453 \item [Client Run Before Job = \lt{}command\gt{}]
1454 \index[dir]{Client Run Before Job}
1455 \index[dir]{Directive!Client Run Before Job}
1456 This directive is the same as {\bf Run Before Job} except that the
1457 program is run on the client machine. The same restrictions apply to
1458 Unix systems as noted above for the {\bf RunScript}.
1460 \item [Client Run After Job = \lt{}command\gt{}]
1461 \index[dir]{Client Run After Job}
1462 \index[dir]{Directive!Client Run After Job}
1463 The specified {\bf command} is run on the client machine as soon
1464 as data spooling is complete in order to allow restarting applications
1465 on the client as soon as possible. .
1467 Note, please see the notes above in {\bf RunScript}
1468 concerning Windows clients.
1470 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1471 \index[dir]{Rerun Failed Levels}
1472 \index[dir]{Directive!Rerun Failed Levels}
1473 If this directive is set to {\bf yes} (default no), and Bacula detects that
1474 a previous job at a higher level (i.e. Full or Differential) has failed,
1475 the current job level will be upgraded to the higher level. This is
1476 particularly useful for Laptops where they may often be unreachable, and if
1477 a prior Full save has failed, you wish the very next backup to be a Full
1478 save rather than whatever level it is started as.
1480 There are several points that must be taken into account when using this
1481 directive: first, a failed job is defined as one that has not terminated
1482 normally, which includes any running job of the same name (you need to
1483 ensure that two jobs of the same name do not run simultaneously);
1484 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1485 when checking for failed levels, which means that any FileSet change will
1488 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1489 \index[dir]{Spool Data}
1490 \index[dir]{Directive!Spool Data}
1492 If this directive is set to {\bf yes} (default no), the Storage daemon will
1493 be requested to spool the data for this Job to disk rather than write it
1494 directly to tape. Once all the data arrives or the spool files' maximum sizes
1495 are reached, the data will be despooled and written to tape. Spooling data
1496 prevents tape shoe-shine (start and stop) during
1497 Incremental saves. If you are writing to a disk file using this option
1498 will probably just slow down the backup jobs.
1500 NOTE: When this directive is set to yes, Spool Attributes is also
1501 automatically set to yes.
1503 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1504 \index[dir]{Spool Attributes}
1505 \index[dir]{Directive!Spool Attributes}
1507 \index[general]{slow}
1508 \index[dir]{Backups!slow}
1509 \index[general]{Backups!slow}
1510 The default is set to {\bf no}, which means that the File attributes are
1511 sent by the Storage daemon to the Director as they are stored on tape.
1512 However, if you want to avoid the possibility that database updates will
1513 slow down writing to the tape, you may want to set the value to {\bf
1514 yes}, in which case the Storage daemon will buffer the File attributes
1515 and Storage coordinates to a temporary file in the Working Directory,
1516 then when writing the Job data to the tape is completed, the attributes
1517 and storage coordinates will be sent to the Director.
1519 NOTE: When Spool Data is set to yes, Spool Attributes is also
1520 automatically set to yes.
1522 \item [Where = \lt{}directory\gt{}]
1524 \index[dir]{Directive!Where}
1525 This directive applies only to a Restore job and specifies a prefix to
1526 the directory name of all files being restored. This permits files to
1527 be restored in a different location from which they were saved. If {\bf
1528 Where} is not specified or is set to backslash ({\bf /}), the files will
1529 be restored to their original location. By default, we have set {\bf
1530 Where} in the example configuration files to be {\bf
1531 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1534 \item [Add Prefix = \lt{}directory\gt{}]
1535 \label{confaddprefix}
1536 \index[dir]{AddPrefix}
1537 \index[dir]{Directive!AddPrefix}
1538 This directive applies only to a Restore job and specifies a prefix to the
1539 directory name of all files being restored. This will use \ilink{File
1540 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1542 \item [Add Suffix = \lt{}extention\gt{}]
1543 \index[dir]{AddSuffix}
1544 \index[dir]{Directive!AddSuffix}
1545 This directive applies only to a Restore job and specifies a suffix to all
1546 files being restored. This will use \ilink{File Relocation}{filerelocation}
1547 feature implemented in Bacula 2.1.8 or later.
1549 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1550 \texttt{/etc/passwsd.old}
1552 \item [Strip Prefix = \lt{}directory\gt{}]
1553 \index[dir]{StripPrefix}
1554 \index[dir]{Directive!StripPrefix}
1555 This directive applies only to a Restore job and specifies a prefix to remove
1556 from the directory name of all files being restored. This will use the
1557 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1560 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1563 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1571 \item [RegexWhere = \lt{}expressions\gt{}]
1572 \index[dir]{RegexWhere}
1573 \index[dir]{Directive!RegexWhere}
1574 This directive applies only to a Restore job and specifies a regex filename
1575 manipulation of all files being restored. This will use \ilink{File
1576 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1578 For more informations about how use this option, see
1579 \ilink{this}{useregexwhere}.
1581 \item [Replace = \lt{}replace-option\gt{}]
1582 \index[dir]{Replace}
1583 \index[dir]{Directive!Replace}
1584 This directive applies only to a Restore job and specifies what happens
1585 when Bacula wants to restore a file or directory that already exists.
1586 You have the following options for {\bf replace-option}:
1592 when the file to be restored already exists, it is deleted and then
1593 replaced by the copy that was backed up. This is the default value.
1596 \index[dir]{ifnewer}
1597 if the backed up file (on tape) is newer than the existing file, the
1598 existing file is deleted and replaced by the back up.
1601 \index[dir]{ifolder}
1602 if the backed up file (on tape) is older than the existing file, the
1603 existing file is deleted and replaced by the back up.
1607 if the backed up file already exists, Bacula skips restoring this file.
1610 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1611 \index[dir]{Prefix Links}
1612 \index[dir]{Directive!Prefix Links}
1613 If a {\bf Where} path prefix is specified for a recovery job, apply it
1614 to absolute links as well. The default is {\bf No}. When set to {\bf
1615 Yes} then while restoring files to an alternate directory, any absolute
1616 soft links will also be modified to point to the new alternate
1617 directory. Normally this is what is desired -- i.e. everything is self
1618 consistent. However, if you wish to later move the files to their
1619 original locations, all files linked with absolute names will be broken.
1621 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1622 \index[dir]{Maximum Concurrent Jobs}
1623 \index[dir]{Directive!Maximum Concurrent Jobs}
1624 where \lt{}number\gt{} is the maximum number of Jobs from the current
1625 Job resource that can run concurrently. Note, this directive limits
1626 only Jobs with the same name as the resource in which it appears. Any
1627 other restrictions on the maximum concurrent jobs such as in the
1628 Director, Client, or Storage resources will also apply in addition to
1629 the limit specified here. The default is set to 1, but you may set it
1630 to a larger number. We strongly recommend that you read the WARNING
1631 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1632 Director's resource.
1634 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1635 \index[dir]{Reschedule On Error}
1636 \index[dir]{Directive!Reschedule On Error}
1637 If this directive is enabled, and the job terminates in error, the job
1638 will be rescheduled as determined by the {\bf Reschedule Interval} and
1639 {\bf Reschedule Times} directives. If you cancel the job, it will not
1640 be rescheduled. The default is {\bf no} (i.e. the job will not be
1643 This specification can be useful for portables, laptops, or other
1644 machines that are not always connected to the network or switched on.
1646 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1647 \index[dir]{Reschedule Interval}
1648 \index[dir]{Directive!Reschedule Interval}
1649 If you have specified {\bf Reschedule On Error = yes} and the job
1650 terminates in error, it will be rescheduled after the interval of time
1651 specified by {\bf time-specification}. See \ilink{the time
1652 specification formats}{Time} in the Configure chapter for details of
1653 time specifications. If no interval is specified, the job will not be
1654 rescheduled on error.
1656 \item [Reschedule Times = \lt{}count\gt{}]
1657 \index[dir]{Reschedule Times}
1658 \index[dir]{Directive!Reschedule Times}
1659 This directive specifies the maximum number of times to reschedule the
1660 job. If it is set to zero (the default) the job will be rescheduled an
1661 indefinite number of times.
1663 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1664 \index[general]{Allow Duplicate Jobs}
1666 \begin{figure}[htbp]
1668 \includegraphics[width=13cm]{\idir duplicate-real.eps}
1669 \caption{Allow Duplicate Jobs usage}
1670 \label{fig:allowduplicatejobs}
1673 A duplicate job in the sense we use it here means a second or subsequent job
1674 with the same name starts. This happens most frequently when the first job
1675 runs longer than expected because no tapes are available.
1677 If this directive is enabled duplicate jobs will be run. If
1678 the directive is set to {\bf no} (default) then only one job of a given name
1679 may run at one time, and the action that Bacula takes to ensure only
1680 one job runs is determined by the other directives (see below).
1682 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1683 are present and none of the three directives given below permit
1684 cancelling a job, then the current job (the second one started)
1687 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1688 \index[general]{Allow Higher Duplicates}
1689 This directive was implemented in version 5.0.0, but does not work
1690 as expected. If used, it should always be set to no. In later versions
1691 of Bacula the directive is disabled (disregarded).
1694 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1695 \index[general]{Cancel Lower Level Duplicates}
1696 If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
1697 directive is set to \textbf{yes}, Bacula will choose between duplicated
1698 jobs the one with the highest level. For example, it will cancel a
1699 previous Incremental to run a Full backup. It works only for Backup
1700 jobs. The default is \texttt{no}. If the levels of the duplicated
1701 jobs are the same, nothing is done and the other
1702 Cancel XXX Duplicate directives will be examined.
1704 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1705 \index[general]{Cancel Queued Duplicates}
1706 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1707 if this directive is set to {\bf yes} any job that is
1708 already queued to run but not yet running will be canceled.
1709 The default is {\bf no}.
1711 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1712 \index[general]{Cancel Running Duplicates}
1713 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1714 if this directive is set to {\bf yes} any job that is already running
1715 will be canceled. The default is {\bf no}.
1718 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1719 %%\index[general]{Duplicate Job Proximity}
1720 %% This directive permits to determine if two jobs are really duplicated.
1721 %% If the first one is running for long time, this is probably not a good
1722 %% idea to cancel it.
1724 \item [Run = \lt{}job-name\gt{}]
1726 \index[dir]{Directive!Run}
1727 \index[dir]{Clone a Job}
1728 The Run directive (not to be confused with the Run option in a
1729 Schedule) allows you to start other jobs or to clone jobs. By using the
1730 cloning keywords (see below), you can backup
1731 the same data (or almost the same data) to two or more drives
1732 at the same time. The {\bf job-name} is normally the same name
1733 as the current Job resource (thus creating a clone). However, it
1734 may be any Job name, so one job may start other related jobs.
1736 The part after the equal sign must be enclosed in double quotes,
1737 and can contain any string or set of options (overrides) that you
1738 can specify when entering the Run command from the console. For
1739 example {\bf storage=DDS-4 ...}. In addition, there are two special
1740 keywords that permit you to clone the current job. They are {\bf level=\%l}
1741 and {\bf since=\%s}. The \%l in the level keyword permits
1742 entering the actual level of the current job and the \%s in the since
1743 keyword permits putting the same time for comparison as used on the
1744 current job. Note, in the case of the since keyword, the \%s must be
1745 enclosed in double quotes, and thus they must be preceded by a backslash
1746 since they are already inside quotes. For example:
1749 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1752 A cloned job will not start additional clones, so it is not
1753 possible to recurse.
1755 Please note that all cloned jobs, as specified in the Run directives are
1756 submitted for running before the original job is run (while it is being
1757 initialized). This means that any clone job will actually start before
1758 the original job, and may even block the original job from starting
1759 until the original job finishes unless you allow multiple simultaneous
1760 jobs. Even if you set a lower priority on the clone job, if no other
1761 jobs are running, it will start before the original job.
1763 If you are trying to prioritize jobs by using the clone feature (Run
1764 directive), you will find it much easier to do using a RunScript
1765 resource, or a RunBeforeJob directive.
1768 \item [Priority = \lt{}number\gt{}]
1769 \index[dir]{Priority}
1770 \index[dir]{Directive!Priority}
1771 This directive permits you to control the order in which your jobs will
1772 be run by specifying a positive non-zero number. The higher the number,
1773 the lower the job priority. Assuming you are not running concurrent jobs,
1774 all queued jobs of priority 1 will run before queued jobs of priority 2
1775 and so on, regardless of the original scheduling order.
1777 The priority only affects waiting jobs that are queued to run, not jobs
1778 that are already running. If one or more jobs of priority 2 are already
1779 running, and a new job is scheduled with priority 1, the currently
1780 running priority 2 jobs must complete before the priority 1 job is
1781 run, unless Allow Mixed Priority is set.
1783 The default priority is 10.
1785 If you want to run concurrent jobs you should
1786 keep these points in mind:
1789 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1792 \item Bacula concurrently runs jobs of only one priority at a time. It
1793 will not simultaneously run a priority 1 and a priority 2 job.
1795 \item If Bacula is running a priority 2 job and a new priority 1 job is
1796 scheduled, it will wait until the running priority 2 job terminates even
1797 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1798 to run simultaneously.
1800 \item Suppose that bacula is running a priority 2 job and a new priority 1
1801 job is scheduled and queued waiting for the running priority 2 job to
1802 terminate. If you then start a second priority 2 job, the waiting
1803 priority 1 job will prevent the new priority 2 job from running
1804 concurrently with the running priority 2 job. That is: as long as there
1805 is a higher priority job waiting to run, no new lower priority jobs will
1806 start even if the Maximum Concurrent Jobs settings would normally allow
1807 them to run. This ensures that higher priority jobs will be run as soon
1811 If you have several jobs of different priority, it may not best to start
1812 them at exactly the same time, because Bacula must examine them one at a
1813 time. If by Bacula starts a lower priority job first, then it will run
1814 before your high priority jobs. If you experience this problem, you may
1815 avoid it by starting any higher priority jobs a few seconds before lower
1816 priority ones. This insures that Bacula will examine the jobs in the
1817 correct order, and that your priority scheme will be respected.
1819 \label{AllowMixedPriority}
1820 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1821 \index[dir]{Allow Mixed Priority}
1822 This directive is only implemented in version 2.5 and later. When
1823 set to {\bf yes} (default {\bf no}), this job may run even if lower
1824 priority jobs are already running. This means a high priority job
1825 will not have to wait for other jobs to finish before starting.
1826 The scheduler will only mix priorities when all running jobs have
1829 Note that only higher priority jobs will start early. Suppose the
1830 director will allow two concurrent jobs, and that two jobs with
1831 priority 10 are running, with two more in the queue. If a job with
1832 priority 5 is added to the queue, it will be run as soon as one of
1833 the running jobs finishes. However, new priority 10 jobs will not
1834 be run until the priority 5 job has finished.
1836 \label{WritePartAfterJob}
1837 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1838 \index[dir]{Write Part After Job}
1839 \index[dir]{Directive!Write Part After Job}
1840 This directive is only implemented in version 1.37 and later.
1841 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1842 will be created after the job is finished.
1844 It should be set to {\bf yes} when writing to devices that require mount
1845 (for example DVD), so you are sure that the current part, containing
1846 this job's data, is written to the device, and that no data is left in
1847 the temporary file on the hard disk. However, on some media, like DVD+R
1848 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1849 written. So, if you run several jobs each after another, you could set
1850 this directive to {\bf no} for all jobs, except the last one, to avoid
1851 wasting too much space, but to ensure that the data is written to the
1852 medium when all jobs are finished.
1854 This directive is ignored with tape and FIFO devices.
1858 The following is an example of a valid Job resource definition:
1865 Level = Incremental # default
1867 FileSet="Minou Full Set"
1870 Schedule = "MinouWeeklyCycle"
1876 \section{The JobDefs Resource}
1877 \label{JobDefsResource}
1878 \index[general]{JobDefs Resource}
1879 \index[general]{Resource!JobDefs}
1881 The JobDefs resource permits all the same directives that can appear in a Job
1882 resource. However, a JobDefs resource does not create a Job, rather it can be
1883 referenced within a Job to provide defaults for that Job. This permits you to
1884 concisely define several nearly identical Jobs, each one referencing a JobDefs
1885 resource which contains the defaults. Only the changes from the defaults need to
1886 be mentioned in each Job.
1888 \section{The Schedule Resource}
1889 \label{ScheduleResource}
1890 \index[general]{Resource!Schedule}
1891 \index[general]{Schedule Resource}
1893 The Schedule resource provides a means of automatically scheduling a Job as
1894 well as the ability to override the default Level, Pool, Storage and Messages
1895 resources. If a Schedule resource is not referenced in a Job, the Job can only
1896 be run manually. In general, you specify an action to be taken and when.
1901 \index[dir]{Schedule}
1902 \index[dir]{Directive!Schedule}
1903 Start of the Schedule directives. No {\bf Schedule} resource is
1904 required, but you will need at least one if you want Jobs to be
1905 automatically started.
1907 \item [Name = \lt{}name\gt{}]
1909 \index[dir]{Directive!Name}
1910 The name of the schedule being defined. The Name directive is required.
1912 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1914 \index[dir]{Directive!Run}
1915 The Run directive defines when a Job is to be run, and what overrides if
1916 any to apply. You may specify multiple {\bf run} directives within a
1917 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1918 multiple schedules). If you have two {\bf Run} directives that start at
1919 the same time, two Jobs will start at the same time (well, within one
1920 second of each other).
1922 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1923 Messages, and the Pool specifications provided in the Job resource. In
1924 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1925 specifications permit overriding the Pool specification according to
1926 what backup Job Level is in effect.
1928 By the use of overrides, you may customize a particular Job. For
1929 example, you may specify a Messages override for your Incremental
1930 backups that outputs messages to a log file, but for your weekly or
1931 monthly Full backups, you may send the output by email by using a
1932 different Messages override.
1934 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1935 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1936 or IncrementalPool, and the {\bf value} is as defined on the respective
1937 directive formats for the Job resource. You may specify multiple {\bf
1938 Job-overrides} on one {\bf Run} directive by separating them with one or
1939 more spaces or by separating them with a trailing comma. For example:
1945 \index[dir]{Directive!Level}
1946 is all files in the FileSet whether or not they have changed.
1948 \item [Level=Incremental]
1950 \index[dir]{Directive!Level}
1951 is all files that have changed since the last backup.
1955 \index[dir]{Directive!Pool}
1956 specifies to use the Pool named {\bf Weekly}.
1958 \item [Storage=DLT\_Drive]
1959 \index[dir]{Storage}
1960 \index[dir]{Directive!Storage}
1961 specifies to use {\bf DLT\_Drive} for the storage device.
1963 \item [Messages=Verbose]
1964 \index[dir]{Messages}
1965 \index[dir]{Directive!Messages}
1966 specifies to use the {\bf Verbose} message resource for the Job.
1968 \item [FullPool=Full]
1969 \index[dir]{FullPool}
1970 \index[dir]{Directive!FullPool}
1971 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1973 upgraded from another type to a full backup.
1975 \item [DifferentialPool=Differential]
1976 \index[dir]{DifferentialPool}
1977 \index[dir]{Directive!DifferentialPool}
1978 specifies to use the Pool named {\bf Differential} if the job is a
1979 differential backup.
1981 \item [IncrementalPool=Incremental]
1982 \index[dir]{IncrementalPool}
1983 \index[dir]{Directive!IncrementalPool}
1984 specifies to use the Pool named {\bf Incremental} if the job is an
1987 \item [SpoolData=yes\vb{}no]
1988 \index[dir]{SpoolData}
1989 \index[dir]{Directive!SpoolData}
1990 tells Bacula to request the Storage daemon to spool data to a disk file
1991 before writing it to the Volume (normally a tape). Thus the data is
1992 written in large blocks to the Volume rather than small blocks. This
1993 directive is particularly useful when running multiple simultaneous
1994 backups to tape. It prevents interleaving of the job data and reduces
1995 or eliminates tape drive stop and start commonly known as "shoe-shine".
1997 \item [SpoolSize={\it bytes}]
1998 \index[dir]{SpoolSize}
1999 \index[dir]{Directive!SpoolSize}
2000 where the bytes specify the maximum spool size for this job.
2001 The default is take from Device Maximum Spool Size limit.
2002 This directive is available only in Bacula version 2.3.5 or
2005 \item [WritePartAfterJob=yes\vb{}no]
2006 \index[dir]{WritePartAfterJob}
2007 \index[dir]{Directive!WritePartAfterJob}
2008 tells Bacula to request the Storage daemon to write the current part
2009 file to the device when the job is finished (see \ilink{Write Part After
2010 Job directive in the Job resource}{WritePartAfterJob}). Please note,
2011 this directive is implemented only in version 1.37 and later. The
2012 default is yes. We strongly recommend that you keep this set to yes
2013 otherwise, when the last job has finished one part will remain in the
2014 spool file and restore may or may not work.
2018 {\bf Date-time-specification} determines when the Job is to be run. The
2019 specification is a repetition, and as a default Bacula is set to run a job at
2020 the beginning of the hour of every hour of every day of every week of every
2021 month of every year. This is not normally what you want, so you must specify
2022 or limit when you want the job to run. Any specification given is assumed to
2023 be repetitive in nature and will serve to override or limit the default
2024 repetition. This is done by specifying masks or times for the hour, day of the
2025 month, day of the week, week of the month, week of the year, and month when
2026 you want the job to run. By specifying one or more of the above, you can
2027 define a schedule to repeat at almost any frequency you want.
2029 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
2030 minute} the Job is to be run. Of these four items to be specified, {\bf day}
2031 is special in that you may either specify a day of the month such as 1, 2,
2032 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
2033 Sunday. Finally, you may also specify a week qualifier to restrict the
2034 schedule to the first, second, third, fourth, or fifth week of the month.
2036 For example, if you specify only a day of the week, such as {\bf Tuesday} the
2037 Job will be run every hour of every Tuesday of every Month. That is the {\bf
2038 month} and {\bf hour} remain set to the defaults of every month and all
2041 Note, by default with no other specification, your job will run at the
2042 beginning of every hour. If you wish your job to run more than once in any
2043 given hour, you will need to specify multiple {\bf run} specifications each
2044 with a different minute.
2046 The date/time to run the Job can be specified in the following way in
2053 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
2054 second | third | fourth | fifth
2055 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
2056 sunday | monday | tuesday | wednesday |
2057 thursday | friday | saturday
2058 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2059 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
2060 aug | sep | oct | nov | dec | january |
2061 february | ... | december
2062 <daily-keyword> = daily
2063 <weekly-keyword> = weekly
2064 <monthly-keyword> = monthly
2065 <hourly-keyword> = hourly
2066 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2067 <number> = <digit> | <digit><number>
2068 <12hour> = 0 | 1 | 2 | ... 12
2069 <hour> = 0 | 1 | 2 | ... 23
2070 <minute> = 0 | 1 | 2 | ... 59
2071 <day> = 1 | 2 | ... 31
2072 <time> = <hour>:<minute> |
2073 <12hour>:<minute>am |
2075 <time-spec> = <at-keyword> <time> |
2077 <date-keyword> = <void-keyword> <weekly-keyword>
2078 <day-range> = <day>-<day>
2079 <month-range> = <month-keyword>-<month-keyword>
2080 <wday-range> = <wday-keyword>-<wday-keyword>
2081 <range> = <day-range> | <month-range> |
2083 <date> = <date-keyword> | <day> | <range>
2084 <date-spec> = <date> | <date-spec>
2085 <day-spec> = <day> | <wday-keyword> |
2086 <day> | <wday-range> |
2087 <week-keyword> <wday-keyword> |
2088 <week-keyword> <wday-range> |
2090 <month-spec> = <month-keyword> | <month-range> |
2092 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2098 Note, the Week of Year specification wnn follows the ISO standard definition
2099 of the week of the year, where Week 1 is the week in which the first Thursday
2100 of the year occurs, or alternatively, the week which contains the 4th of
2101 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2102 precedes the first ISO week (i.e. has the first few days of the year if any
2103 occur before Thursday). w00 is not defined by the ISO specification. A week
2104 starts with Monday and ends with Sunday.
2106 According to the NIST (US National Institute of Standards and Technology),
2107 12am and 12pm are ambiguous and can be defined to anything. However,
2108 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2109 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2110 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2111 am/pm). This is the definition in Bacula version 2.0.3 and later.
2113 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2114 with level full each Sunday at 2:05am and an incremental job Monday through
2115 Saturday at 2:05am is:
2120 Name = "WeeklyCycle"
2121 Run = Level=Full sun at 2:05
2122 Run = Level=Incremental mon-sat at 2:05
2127 An example of a possible monthly cycle is as follows:
2132 Name = "MonthlyCycle"
2133 Run = Level=Full Pool=Monthly 1st sun at 2:05
2134 Run = Level=Differential 2nd-5th sun at 2:05
2135 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2140 The first of every month:
2146 Run = Level=Full on 1 at 2:05
2147 Run = Level=Incremental on 2-31 at 2:05
2158 Run = Level=Full hourly at 0:05
2159 Run = Level=Full hourly at 0:15
2160 Run = Level=Full hourly at 0:25
2161 Run = Level=Full hourly at 0:35
2162 Run = Level=Full hourly at 0:45
2163 Run = Level=Full hourly at 0:55
2168 \section{Technical Notes on Schedules}
2169 \index[general]{Schedules!Technical Notes on}
2170 \index[general]{Technical Notes on Schedules}
2172 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2173 minute field to each schedule. The masks are hour, day of the month (mday),
2174 month, day of the week (wday), week of the month (wom), and week of the year
2175 (woy). The schedule is initialized to have the bits of each of these masks
2176 set, which means that at the beginning of every hour, the job will run. When
2177 you specify a month for the first time, the mask will be cleared and the bit
2178 corresponding to your selected month will be selected. If you specify a second
2179 month, the bit corresponding to it will also be added to the mask. Thus when
2180 Bacula checks the masks to see if the bits are set corresponding to the
2181 current time, your job will run only in the two months you have set. Likewise,
2182 if you set a time (hour), the hour mask will be cleared, and the hour you
2183 specify will be set in the bit mask and the minutes will be stored in the
2186 For any schedule you have defined, you can see how these bits are set by doing
2187 a {\bf show schedules} command in the Console program. Please note that the
2188 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2192 \section{The Client Resource}
2193 \label{ClientResource2}
2194 \index[general]{Resource!Client}
2195 \index[general]{Client Resource}
2197 The Client resource defines the attributes of the Clients that are served by
2198 this Director; that is the machines that are to be backed up. You will need
2199 one Client resource definition for each machine to be backed up.
2203 \item [Client (or FileDaemon)]
2204 \index[dir]{Client (or FileDaemon)}
2205 \index[dir]{Directive!Client (or FileDaemon)}
2206 Start of the Client directives.
2208 \item [Name = \lt{}name\gt{}]
2210 \index[dir]{Directive!Name}
2211 The client name which will be used in the Job resource directive or in the
2212 console run command. This directive is required.
2214 \item [Address = \lt{}address\gt{}]
2215 \index[dir]{Address}
2216 \index[dir]{Directive!FD Address}
2217 \index[dir]{File Daemon Address}
2218 \index[dir]{Client Address}
2219 Where the address is a host name, a fully qualified domain name, or a
2220 network address in dotted quad notation for a Bacula File server daemon.
2221 This directive is required.
2223 \item [FD Port = \lt{}port-number\gt{}]
2224 \index[dir]{FD Port}
2225 \index[dir]{Directive!FD Port}
2226 Where the port is a port number at which the Bacula File server daemon can
2227 be contacted. The default is 9102.
2229 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2230 \index[dir]{Catalog}
2231 \index[dir]{Directive!Catalog}
2232 This specifies the name of the catalog resource to be used for this Client.
2233 This directive is required.
2235 \item [Password = \lt{}password\gt{}]
2236 \index[dir]{Password}
2237 \index[dir]{Directive!Password}
2238 This is the password to be used when establishing a connection with the File
2239 services, so the Client configuration file on the machine to be backed up
2240 must have the same password defined for this Director. This directive is
2241 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2242 Bacula will generate a random password during the configuration process,
2243 otherwise it will be left blank.
2245 The password is plain text. It is not generated through any special
2246 process, but it is preferable for security reasons to make the text
2249 \label{FileRetention}
2250 \item [File Retention = \lt{}time-period-specification\gt{}]
2251 \label{FileRetention}
2252 \index[dir]{File Retention}
2253 \index[dir]{Directive!File Retention}
2254 The File Retention directive defines the length of time that Bacula will
2255 keep File records in the Catalog database after the End time of the
2256 Job corresponding to the File records.
2257 When this time period expires, and if
2258 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2259 that are older than the specified File Retention period. Note, this affects
2260 only records in the catalog database. It does not affect your archive
2263 File records may actually be retained for a shorter period than you specify
2264 on this directive if you specify either a shorter {\bf Job Retention} or a
2265 shorter {\bf Volume Retention} period. The shortest retention period of the
2266 three takes precedence. The time may be expressed in seconds, minutes,
2267 hours, days, weeks, months, quarters, or years. See the
2268 \ilink{ Configuration chapter}{Time} of this manual for
2269 additional details of time specification.
2271 The default is 60 days.
2273 \label{JobRetention}
2274 \item [Job Retention = \lt{}time-period-specification\gt{}]
2275 \label{JobRetention}
2276 \index[dir]{Job Retention}
2277 \index[dir]{Directive!Job Retention}
2278 The Job Retention directive defines the length of time that Bacula will keep
2279 Job records in the Catalog database after the Job End time. When
2280 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2281 Bacula will prune (remove) Job records that are older than the specified
2282 File Retention period. As with the other retention periods, this
2283 affects only records in the catalog and not data in your archive backup.
2285 If a Job record is selected for pruning, all associated File and JobMedia
2286 records will also be pruned regardless of the File Retention period set.
2287 As a consequence, you normally will set the File retention period to be
2288 less than the Job retention period. The Job retention period can actually
2289 be less than the value you specify here if you set the {\bf Volume
2290 Retention} directive in the Pool resource to a smaller duration. This is
2291 because the Job retention period and the Volume retention period are
2292 independently applied, so the smaller of the two takes precedence.
2294 The Job retention period is specified as seconds, minutes, hours, days,
2295 weeks, months, quarters, or years. See the
2296 \ilink{ Configuration chapter}{Time} of this manual for
2297 additional details of time specification.
2299 The default is 180 days.
2302 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2303 \index[dir]{AutoPrune}
2304 \index[dir]{Directive!AutoPrune}
2305 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2306 will automatically apply the File retention period and the Job retention
2307 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2308 pruning will not be done, and your Catalog will grow in size each time you
2309 run a Job. Pruning affects only information in the catalog and not data
2310 stored in the backup archives (on Volumes).
2312 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2313 \index[dir]{Maximum Concurrent Jobs}
2314 \index[dir]{Directive!Maximum Concurrent Jobs}
2315 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2316 that can run concurrently. Note, this directive limits only Jobs for Clients
2317 with the same name as the resource in which it appears. Any other
2318 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2319 Storage resources will also apply in addition to any limit specified here.
2320 The default is set to 1, but you may set it to a larger number.
2322 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2323 \index[dir]{Maximum Bandwidth Per Job}
2324 \index[dir]{Directive!Maximum Bandwidth Per Job}
2326 The speed parameter specifies the maximum allowed bandwidth that a job may use
2327 when started for this Client. The speed parameter should be specified in
2328 k/s, kb/s, m/s or mb/s.
2330 \item [Priority = \lt{}number\gt{}]
2331 \index[dir]{Priority}
2332 \index[dir]{Directive!Priority}
2333 The number specifies the priority of this client relative to other clients
2334 that the Director is processing simultaneously. The priority can range from
2335 1 to 1000. The clients are ordered such that the smaller number priorities
2336 are performed first (not currently implemented).
2339 The following is an example of a valid Client resource definition:
2345 FDAddress = minimatou
2347 Password = very_good
2352 \section{The Storage Resource}
2353 \label{StorageResource2}
2354 \index[general]{Resource!Storage}
2355 \index[general]{Storage Resource}
2357 The Storage resource defines which Storage daemons are available for use by
2363 \index[dir]{Storage}
2364 \index[dir]{Directive!Storage}
2365 Start of the Storage resources. At least one storage resource must be
2368 \item [Name = \lt{}name\gt{}]
2370 \index[dir]{Directive!Name}
2371 The name of the storage resource. This name appears on the Storage directive
2372 specified in the Job resource and is required.
2374 \item [Address = \lt{}address\gt{}]
2375 \index[dir]{Address}
2376 \index[dir]{Directive!SD Address}
2377 \index[dir]{Storage daemon Address}
2378 Where the address is a host name, a {\bf fully qualified domain name}, or an
2379 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2380 will be transmitted to the File daemon who will then use it to contact the
2381 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2382 the name but rather a fully qualified machine name or an IP address. This
2383 directive is required.
2385 \item [SD Port = \lt{}port\gt{}]
2386 \index[dir]{SD Port}
2387 \index[dir]{Directive!SD Port}
2388 Where port is the port to use to contact the storage daemon for information
2389 and to start jobs. This same port number must appear in the Storage resource
2390 of the Storage daemon's configuration file. The default is 9103.
2392 \item [Password = \lt{}password\gt{}]
2393 \index[dir]{Password}
2394 \index[dir]{Directive!Password}
2395 This is the password to be used when establishing a connection with the
2396 Storage services. This same password also must appear in the Director
2397 resource of the Storage daemon's configuration file. This directive is
2398 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2399 Bacula will generate a random password during the configuration process,
2400 otherwise it will be left blank.
2402 The password is plain text. It is not generated through any special
2403 process, but it is preferable for security reasons to use random text.
2405 \item [Device = \lt{}device-name\gt{}]
2407 \index[dir]{Directive!Device}
2408 This directive specifies the Storage daemon's name of the device
2409 resource to be used for the storage. If you are using an Autochanger,
2410 the name specified here should be the name of the Storage daemon's
2411 Autochanger resource rather than the name of an individual device. This
2412 name is not the physical device name, but the logical device name as
2413 defined on the {\bf Name} directive contained in the {\bf Device} or the
2414 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2415 configuration file. You can specify any name you would like (even the
2416 device name if you prefer) up to a maximum of 127 characters in length.
2417 The physical device name associated with this device is specified in the
2418 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2419 Please take care not to define two different Storage resource directives
2420 in the Director that point to the same Device in the Storage daemon.
2421 Doing so may cause the Storage daemon to block (or hang) attempting to
2422 open the same device that is already open. This directive is required.
2425 \item [Media Type = \lt{}MediaType\gt{}]
2426 \index[dir]{Media Type}
2427 \index[dir]{Directive!Media Type}
2428 This directive specifies the Media Type to be used to store the data.
2429 This is an arbitrary string of characters up to 127 maximum that you
2430 define. It can be anything you want. However, it is best to make it
2431 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2432 ...). In addition, it is essential that you make the {\bf Media Type}
2433 specification unique for each storage media type. If you have two DDS-4
2434 drives that have incompatible formats, or if you have a DDS-4 drive and
2435 a DDS-4 autochanger, you almost certainly should specify different {\bf
2436 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2437 associated with the Job, Bacula can decide to use any Storage daemon
2438 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2440 If you are writing to disk Volumes, you must make doubly sure that each
2441 Device resource defined in the Storage daemon (and hence in the
2442 Director's conf file) has a unique media type. Otherwise for Bacula
2443 versions 1.38 and older, your restores may not work because Bacula
2444 will assume that you can mount any Media Type with the same name on
2445 any Device associated with that Media Type. This is possible with
2446 tape drives, but with disk drives, unless you are very clever you
2447 cannot mount a Volume in any directory -- this can be done by creating
2448 an appropriate soft link.
2450 Currently Bacula permits only a single Media Type per Storage
2451 and Device definition. Consequently, if
2452 you have a drive that supports more than one Media Type, you can
2453 give a unique string to Volumes with different intrinsic Media
2454 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2455 those volumes will only be mounted on drives indicated with the
2456 dual type (DDS-3-4).
2458 If you want to tie Bacula to using a single Storage daemon or drive, you
2459 must specify a unique Media Type for that drive. This is an important
2460 point that should be carefully understood. Note, this applies equally
2461 to Disk Volumes. If you define more than one disk Device resource in
2462 your Storage daemon's conf file, the Volumes on those two devices are in
2463 fact incompatible because one can not be mounted on the other device
2464 since they are found in different directories. For this reason, you
2465 probably should use two different Media Types for your two disk Devices
2466 (even though you might think of them as both being File types). You can
2467 find more on this subject in the \ilink{Basic Volume
2468 Management}{DiskChapter} chapter of this manual.
2470 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2471 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2472 resource of the {\bf Storage daemon} configuration file. This directive
2473 is required, and it is used by the Director and the Storage daemon to
2474 ensure that a Volume automatically selected from the Pool corresponds to
2475 the physical device. If a Storage daemon handles multiple devices (e.g.
2476 will write to various file Volumes on different partitions), this
2477 directive allows you to specify exactly which device.
2479 As mentioned above, the value specified in the Director's Storage
2480 resource must agree with the value specified in the Device resource in
2481 the {\bf Storage daemon's} configuration file. It is also an additional
2482 check so that you don't try to write data for a DLT onto an 8mm device.
2484 \label{Autochanger1}
2485 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2486 \index[dir]{Autochanger}
2487 \index[dir]{Directive!Autochanger}
2488 If you specify {\bf yes} for this command (the default is {\bf no}),
2489 when you use the {\bf label} command or the {\bf add} command to create
2490 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2491 number. This simplifies creating database entries for Volumes in an
2492 autochanger. If you forget to specify the Slot, the autochanger will
2493 not be used. However, you may modify the Slot associated with a Volume
2494 at any time by using the {\bf update volume} or {\bf update slots}
2495 command in the console program. When {\bf autochanger} is enabled, the
2496 algorithm used by Bacula to search for available volumes will be
2497 modified to consider only Volumes that are known to be in the
2498 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2499 will attempt recycling, pruning, ..., and if still no volume is found,
2500 Bacula will search for any volume whether or not in the magazine. By
2501 privileging in changer volumes, this procedure minimizes operator
2502 intervention. The default is {\bf no}.
2504 For the autochanger to be used, you must also specify {\bf Autochanger =
2505 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2506 configuration file as well as other important Storage daemon
2507 configuration information. Please consult the \ilink{Using
2508 Autochangers}{AutochangersChapter} manual of this chapter for the
2509 details of using autochangers.
2511 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2512 \index[dir]{Maximum Concurrent Jobs}
2513 \index[dir]{Directive!Maximum Concurrent Jobs}
2514 where \lt{}number\gt{} is the maximum number of Jobs with the current
2515 Storage resource that can run concurrently. Note, this directive limits
2516 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2517 the maximum concurrent jobs such as in the Director, Job, or Client
2518 resources will also apply in addition to any limit specified here. The
2519 default is set to 1, but you may set it to a larger number. However, if
2520 you set the Storage daemon's number of concurrent jobs greater than one,
2521 we recommend that you read the waring documented under \ilink{Maximum
2522 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2523 turn data spooling on as documented in the \ilink{Data
2524 Spooling}{SpoolingChapter} chapter of this manual.
2526 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2527 \label{AllowCompression}
2528 \index[dir]{AllowCompression}
2529 \index[dir]{Directive!AllowCompression}
2531 This directive is optional, and if you specify {\bf No} (the default is {\bf
2532 Yes}), it will cause backups jobs running on this storage resource to run
2533 without client File Daemon compression. This effectively overrides
2534 compression options in FileSets used by jobs which use this storage
2537 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2538 \index[dir]{Heartbeat Interval}
2539 \index[dir]{Directive!Heartbeat}
2540 This directive is optional and if specified will cause the Director to
2541 set a keepalive interval (heartbeat) in seconds on each of the sockets
2542 it opens for the Storage resource. This value will override any
2543 specified at the Director level. It is implemented only on systems
2544 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2545 The default value is zero, which means no change is made to the socket.
2549 The following is an example of a valid Storage resource definition:
2553 # Definition of tape storage device
2557 Password = storage_password # password for Storage daemon
2558 Device = "HP DLT 80" # same as Device in Storage daemon
2559 Media Type = DLT8000 # same as MediaType in Storage daemon
2564 \section{The Pool Resource}
2565 \label{PoolResource}
2566 \index[general]{Resource!Pool}
2567 \index[general]{Pool Resource}
2569 The Pool resource defines the set of storage Volumes (tapes or files) to be
2570 used by Bacula to write the data. By configuring different Pools, you can
2571 determine which set of Volumes (media) receives the backup data. This permits,
2572 for example, to store all full backup data on one set of Volumes and all
2573 incremental backups on another set of Volumes. Alternatively, you could assign
2574 a different set of Volumes to each machine that you backup. This is most
2575 easily done by defining multiple Pools.
2577 Another important aspect of a Pool is that it contains the default attributes
2578 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2579 Volume when it is created. This avoids the need for you to answer a large
2580 number of questions when labeling a new Volume. Each of these attributes can
2581 later be changed on a Volume by Volume basis using the {\bf update} command in
2582 the console program. Note that you must explicitly specify which Pool Bacula
2583 is to use with each Job. Bacula will not automatically search for the correct
2586 Most often in Bacula installations all backups for all machines (Clients) go
2587 to a single set of Volumes. In this case, you will probably only use the {\bf
2588 Default} Pool. If your backup strategy calls for you to mount a different tape
2589 each day, you will probably want to define a separate Pool for each day. For
2590 more information on this subject, please see the
2591 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2595 To use a Pool, there are three distinct steps. First the Pool must be defined
2596 in the Director's configuration file. Then the Pool must be written to the
2597 Catalog database. This is done automatically by the Director each time that it
2598 starts, or alternatively can be done using the {\bf create} command in the
2599 console program. Finally, if you change the Pool definition in the Director's
2600 configuration file and restart Bacula, the pool will be updated alternatively
2601 you can use the {\bf update pool} console command to refresh the database
2602 image. It is this database image rather than the Director's resource image
2603 that is used for the default Volume attributes. Note, for the pool to be
2604 automatically created or updated, it must be explicitly referenced by a Job
2607 Next the physical media must be labeled. The labeling can either be done with
2608 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2609 program. The preferred method is to use the {\bf label} command in the {\bf
2612 Finally, you must add Volume names (and their attributes) to the Pool. For
2613 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2614 archive device specified for the job (i.e. if you are going to back up to a
2615 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2616 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2617 are backing up to files. When running a Job, you must explicitly specify which
2618 Pool to use. Bacula will then automatically select the next Volume to use from
2619 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2620 from the Pool is identical to that required by the Storage resource you have
2621 specified for the Job.
2623 If you use the {\bf label} command in the console program to label the
2624 Volumes, they will automatically be added to the Pool, so this last step is
2625 not normally required.
2627 It is also possible to add Volumes to the database without explicitly labeling
2628 the physical volume. This is done with the {\bf add} console command.
2630 As previously mentioned, each time Bacula starts, it scans all the Pools
2631 associated with each Catalog, and if the database record does not already
2632 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2633 probably should do an {\bf update pool} if you change the Pool definition, but
2634 currently, you must do this manually using the {\bf update pool} command in
2635 the Console program.
2637 The Pool Resource defined in the Director's configuration file
2638 (bacula-dir.conf) may contain the following directives:
2644 \index[dir]{Directive!Pool}
2645 Start of the Pool resource. There must be at least one Pool resource
2649 \item [Name = \lt{}name\gt{}]
2651 \index[dir]{Directive!Name}
2652 The name of the pool. For most applications, you will use the default
2653 pool name {\bf Default}. This directive is required.
2656 \item [Maximum Volumes = \lt{}number\gt{}]
2657 \index[dir]{Maximum Volumes}
2658 \index[dir]{Directive!Maximum Volumes}
2659 This directive specifies the maximum number of volumes (tapes or files)
2660 contained in the pool. This directive is optional, if omitted or set to
2661 zero, any number of volumes will be permitted. In general, this
2662 directive is useful for Autochangers where there is a fixed number of
2663 Volumes, or for File storage where you wish to ensure that the backups
2664 made to disk files do not become too numerous or consume too much space.
2666 \item [Pool Type = \lt{}type\gt{}]
2667 \index[dir]{Pool Type}
2668 \index[dir]{Directive!Pool Type}
2669 This directive defines the pool type, which corresponds to the type of
2670 Job being run. It is required and may be one of the following:
2680 Note, only Backup is current implemented.
2682 \item [Storage = \lt{}storage-resource-name\gt{}]
2683 \index[dir]{Storage}
2684 \index[dir]{Directive!Storage}
2685 The Storage directive defines the name of the storage services where you
2686 want to backup the FileSet data. For additional details, see the
2687 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2688 The Storage resource may also be specified in the Job resource,
2689 but the value, if any, in the Pool resource overrides any value
2690 in the Job. This Storage resource definition is not required by either
2691 the Job resource or in the Pool, but it must be specified in
2692 one or the other. If not configuration error will result.
2694 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2695 \index[dir]{Use Volume Once}
2696 \index[dir]{Directive!Use Volume Once}
2697 This directive if set to {\bf yes} specifies that each volume is to be
2698 used only once. This is most useful when the Media is a file and you
2699 want a new file for each backup that is done. The default is {\bf no}
2700 (i.e. use volume any number of times). This directive will most likely
2701 be phased out (deprecated), so you are recommended to use {\bf Maximum
2702 Volume Jobs = 1} instead.
2704 The value defined by this directive in the bacula-dir.conf file is the
2705 default value used when a Volume is created. Once the volume is
2706 created, changing the value in the bacula-dir.conf file will not change
2707 what is stored for the Volume. To change the value for an existing
2708 Volume you must use the {\bf update} command in the Console.
2710 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2711 using this directive with multiple simultaneous jobs.
2713 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2714 \index[dir]{Maximum Volume Jobs}
2715 \index[dir]{Directive!Maximum Volume Jobs}
2716 This directive specifies the maximum number of Jobs that can be written
2717 to the Volume. If you specify zero (the default), there is no limit.
2718 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2719 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2720 is marked {\bf Used} it can no longer be used for appending Jobs, much
2721 like the {\bf Full} status but it can be recycled if recycling is
2722 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2723 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2725 The value defined by this directive in the bacula-dir.conf
2726 file is the default value used when a Volume is created. Once the volume is
2727 created, changing the value in the bacula-dir.conf file will not change what
2728 is stored for the Volume. To change the value for an existing Volume you
2729 must use the {\bf update} command in the Console.
2731 If you are running multiple simultaneous jobs, this directive may not
2732 work correctly because when a drive is reserved for a job, this
2733 directive is not taken into account, so multiple jobs may try to
2734 start writing to the Volume. At some point, when the Media record is
2735 updated, multiple simultaneous jobs may fail since the Volume can no
2738 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2739 \index[dir]{Maximum Volume Files}
2740 \index[dir]{Directive!Maximum Volume Files}
2741 This directive specifies the maximum number of files that can be written
2742 to the Volume. If you specify zero (the default), there is no limit.
2743 Otherwise, when the number of files written to the Volume equals {\bf
2744 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2745 is marked {\bf Used} it can no longer be used for appending Jobs, much
2746 like the {\bf Full} status but it can be recycled if recycling is
2747 enabled and thus used again. This value is checked and the {\bf Used}
2748 status is set only at the end of a job that writes to the particular
2751 The value defined by this directive in the bacula-dir.conf file is the
2752 default value used when a Volume is created. Once the volume is
2753 created, changing the value in the bacula-dir.conf file will not change
2754 what is stored for the Volume. To change the value for an existing
2755 Volume you must use the {\bf update} command in the Console.
2757 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2758 \index[dir]{Maximum Volume Bytes}
2759 \index[dir]{Directive!Maximum Volume Bytes}
2760 This directive specifies the maximum number of bytes that can be written
2761 to the Volume. If you specify zero (the default), there is no limit
2762 except the physical size of the Volume. Otherwise, when the number of
2763 bytes written to the Volume equals {\bf size} the Volume will be marked
2764 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2765 used for appending Jobs, much like the {\bf Full} status but it can be
2766 recycled if recycling is enabled, and thus the Volume can be re-used
2767 after recycling. This value is checked and the {\bf Used} status set
2768 while the job is writing to the particular volume.
2770 This directive is particularly useful for restricting the size
2771 of disk volumes, and will work correctly even in the case of
2772 multiple simultaneous jobs writing to the volume.
2774 The value defined by this directive in the bacula-dir.conf file is the
2775 default value used when a Volume is created. Once the volume is
2776 created, changing the value in the bacula-dir.conf file will not change
2777 what is stored for the Volume. To change the value for an existing
2778 Volume you must use the {\bf update} command in the Console.
2780 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2781 \index[dir]{Volume Use Duration}
2782 \index[dir]{Directive!Volume Use Duration}
2783 The Volume Use Duration directive defines the time period that the
2784 Volume can be written beginning from the time of first data write to the
2785 Volume. If the time-period specified is zero (the default), the Volume
2786 can be written indefinitely. Otherwise, the next time a job
2787 runs that wants to access this Volume, and the time period from the
2788 first write to the volume (the first Job written) exceeds the
2789 time-period-specification, the Volume will be marked {\bf Used}, which
2790 means that no more Jobs can be appended to the Volume, but it may be
2791 recycled if recycling is enabled. Using the command {\bf
2792 status dir} applies algorithms similar to running jobs, so
2793 during such a command, the Volume status may also be changed.
2795 recycled, it will be available for use again.
2797 You might use this directive, for example, if you have a Volume used for
2798 Incremental backups, and Volumes used for Weekly Full backups. Once the
2799 Full backup is done, you will want to use a different Incremental
2800 Volume. This can be accomplished by setting the Volume Use Duration for
2801 the Incremental Volume to six days. I.e. it will be used for the 6
2802 days following a Full save, then a different Incremental volume will be
2803 used. Be careful about setting the duration to short periods such as 23
2804 hours, or you might experience problems of Bacula waiting for a tape
2805 over the weekend only to complete the backups Monday morning when an
2806 operator mounts a new tape.
2808 The use duration is checked and the {\bf Used} status is set only at the
2809 end of a job that writes to the particular volume, which means that even
2810 though the use duration may have expired, the catalog entry will not be
2811 updated until the next job that uses this volume is run. This
2812 directive is not intended to be used to limit volume sizes
2813 and will not work correctly (i.e. will fail jobs) if the use
2814 duration expires while multiple simultaneous jobs are writing
2817 Please note that the value defined by this directive in the bacula-dir.conf
2818 file is the default value used when a Volume is created. Once the volume is
2819 created, changing the value in the bacula-dir.conf file will not change what
2820 is stored for the Volume. To change the value for an existing Volume you
2822 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2824 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
2825 \index[dir]{Catalog Files}
2826 \index[dir]{Directive!Catalog Files}
2827 This directive defines whether or not you want the names of the files
2828 that were saved to be put into the catalog. The default is {\bf yes}.
2829 The advantage of specifying {\bf Catalog Files = No} is that you will
2830 have a significantly smaller Catalog database. The disadvantage is that
2831 you will not be able to produce a Catalog listing of the files backed up
2832 for each Job (this is often called Browsing). Also, without the File
2833 entries in the catalog, you will not be able to use the Console {\bf
2834 restore} command nor any other command that references File entries.
2836 \label{PoolAutoPrune}
2837 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2838 \index[dir]{AutoPrune}
2839 \index[dir]{Directive!AutoPrune}
2840 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2841 greater) will automatically apply the Volume Retention period when new
2842 Volume is needed and no appendable Volumes exist in the Pool. Volume
2843 pruning causes expired Jobs (older than the {\bf Volume Retention}
2844 period) to be deleted from the Catalog and permits possible recycling of
2847 \label{VolRetention}
2848 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2849 \index[dir]{Volume Retention}
2850 \index[dir]{Directive!Volume Retention}
2851 The Volume Retention directive defines the length of time that {\bf
2852 Bacula} will keep records associated with the Volume in
2853 the Catalog database after the End time of each Job written to the
2854 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2855 {\bf yes} Bacula may prune (remove) Job records that are older than the
2856 specified Volume Retention period if it is necessary to free up a
2857 Volume. Recycling will not occur until it is absolutely necessary to
2858 free up a volume (i.e. no other writable volume exists).
2859 All File records associated with pruned Jobs are also
2860 pruned. The time may be specified as seconds, minutes, hours, days,
2861 weeks, months, quarters, or years. The {\bf Volume Retention} is
2862 applied independently of the {\bf Job Retention} and the {\bf File
2863 Retention} periods defined in the Client resource. This means that all
2864 the retentions periods are applied in turn and that the shorter period
2865 is the one that effectively takes precedence. Note, that when the {\bf
2866 Volume Retention} period has been reached, and it is necessary to obtain
2867 a new volume, Bacula will prune both the Job and the File records. This
2868 pruning could also occur during a {\bf status dir} command because it
2869 uses similar algorithms for finding the next available Volume.
2871 It is important to know that when the Volume Retention period expires,
2872 Bacula does not automatically recycle a Volume. It attempts to keep the
2873 Volume data intact as long as possible before over writing the Volume.
2875 By defining multiple Pools with different Volume Retention periods, you
2876 may effectively have a set of tapes that is recycled weekly, another
2877 Pool of tapes that is recycled monthly and so on. However, one must
2878 keep in mind that if your {\bf Volume Retention} period is too short, it
2879 may prune the last valid Full backup, and hence until the next Full
2880 backup is done, you will not have a complete backup of your system, and
2881 in addition, the next Incremental or Differential backup will be
2882 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2883 Retention} period should be at twice the interval of your Full backups.
2884 This means that if you do a Full backup once a month, the minimum Volume
2885 retention period should be two months.
2887 The default Volume retention period is 365 days, and either the default
2888 or the value defined by this directive in the bacula-dir.conf file is
2889 the default value used when a Volume is created. Once the volume is
2890 created, changing the value in the bacula-dir.conf file will not change
2891 what is stored for the Volume. To change the value for an existing
2892 Volume you must use the {\bf update} command in the Console.
2894 \item [Action On Purge = \lt{Truncate}]
2895 \index[dir]{actiononpurge}
2897 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
2898 volume when it is purged with the \texttt{purge volume action=truncate}
2899 command. It is useful to prevent disk based volumes from consuming too much
2905 Action On Purge = Truncate
2910 You can schedule the truncate operation at the end of your CatalogBackup job
2911 like in this example:
2915 Name = CatalogBackup
2920 Console = "purge volume action=all allpools storage=File"
2925 \label{PoolScratchPool}
2926 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
2927 \index[dir]{ScrachPool}
2928 \index[dir]{Directive!ScrachPool}
2929 This directive permits to specify a dedicate \textsl{Scratch} for the
2930 current pool. This pool will replace the special pool named \textsl{Scrach}
2931 for volume selection. For more information about \textsl{Scratch} see
2932 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
2933 when using multiple storage sharing the same mediatype or when you want to
2934 dedicate volumes to a particular set of pool.
2936 \label{PoolRecyclePool}
2937 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2938 \index[dir]{RecyclePool}
2939 \index[dir]{Directive!RecyclePool}
2940 This directive defines to which pool
2941 the Volume will be placed (moved) when it is recycled. Without
2942 this directive, a Volume will remain in the same pool when it is
2943 recycled. With this directive, it can be moved automatically to any
2944 existing pool during a recycle. This directive is probably most
2945 useful when defined in the Scratch pool, so that volumes will
2946 be recycled back into the Scratch pool. For more on the see the
2947 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2949 Although this directive is called RecyclePool, the Volume in
2950 question is actually moved from its current pool to the one
2951 you specify on this directive when Bacula prunes the Volume and
2952 discovers that there are no records left in the catalog and hence
2953 marks it as {\bf Purged}.
2957 \item [Recycle = \lt{}yes\vb{}no\gt{}]
2958 \index[dir]{Recycle}
2959 \index[dir]{Directive!Recycle}
2960 This directive specifies whether or not Purged Volumes may be recycled.
2961 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2962 none that are appendable, it will search for and recycle (reuse) Purged
2963 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2964 deleted from the Catalog). If the Volume is recycled, all previous data
2965 written to that Volume will be overwritten. If Recycle is set to {\bf
2966 no}, the Volume will not be recycled, and hence, the data will remain
2967 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2968 is no (0 in the catalog), you may manually set the recycle flag (update
2969 command) for a Volume to be reused.
2971 Please note that the value defined by this directive in the
2972 bacula-dir.conf file is the default value used when a Volume is created.
2973 Once the volume is created, changing the value in the bacula-dir.conf
2974 file will not change what is stored for the Volume. To change the value
2975 for an existing Volume you must use the {\bf update} command in the
2978 When all Job and File records have been pruned or purged from the
2979 catalog for a particular Volume, if that Volume is marked as
2980 Append, Full, Used, or Error, it will then be marked as Purged. Only
2981 Volumes marked as Purged will be considered to be converted to the
2982 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
2985 \label{RecycleOldest}
2986 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
2987 \index[dir]{Recycle Oldest Volume}
2988 \index[dir]{Directive!Recycle Oldest Volume}
2989 This directive instructs the Director to search for the oldest used
2990 Volume in the Pool when another Volume is requested by the Storage
2991 daemon and none are available. The catalog is then {\bf pruned}
2992 respecting the retention periods of all Files and Jobs written to this
2993 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2994 Volume is recycled and will be used as the next Volume to be written.
2995 This directive respects any Job, File, or Volume retention periods that
2996 you may have specified, and as such it is {\bf much} better to use this
2997 directive than the Purge Oldest Volume.
2999 This directive can be useful if you have a fixed number of Volumes in the
3000 Pool and you want to cycle through them and you have specified the correct
3003 However, if you use this directive and have only one
3004 Volume in the Pool, you will immediately recycle your Volume if you fill
3005 it and Bacula needs another one. Thus your backup will be totally invalid.
3006 Please use this directive with care. The default is {\bf no}.
3008 \label{RecycleCurrent}
3010 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3011 \index[dir]{Recycle Current Volume}
3012 \index[dir]{Directive!Recycle Current Volume}
3013 If Bacula needs a new Volume, this directive instructs Bacula to Prune
3014 the volume respecting the Job and File retention periods. If all Jobs
3015 are pruned (i.e. the volume is Purged), then the Volume is recycled and
3016 will be used as the next Volume to be written. This directive respects
3017 any Job, File, or Volume retention periods that you may have specified,
3018 and thus it is {\bf much} better to use it rather than the Purge Oldest
3021 This directive can be useful if you have: a fixed number of Volumes in
3022 the Pool, you want to cycle through them, and you have specified
3023 retention periods that prune Volumes before you have cycled through the
3026 However, if you use this directive and have only one Volume in the Pool,
3027 you will immediately recycle your Volume if you fill it and Bacula needs
3028 another one. Thus your backup will be totally invalid. Please use this
3029 directive with care. The default is {\bf no}.
3033 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3034 \index[dir]{Purge Oldest Volume}
3035 \index[dir]{Directive!Purge Oldest Volume}
3036 This directive instructs the Director to search for the oldest used
3037 Volume in the Pool when another Volume is requested by the Storage
3038 daemon and none are available. The catalog is then {\bf purged}
3039 irrespective of retention periods of all Files and Jobs written to this
3040 Volume. The Volume is then recycled and will be used as the next Volume
3041 to be written. This directive overrides any Job, File, or Volume
3042 retention periods that you may have specified.
3044 This directive can be useful if you have a fixed number of Volumes in
3045 the Pool and you want to cycle through them and reusing the oldest one
3046 when all Volumes are full, but you don't want to worry about setting
3047 proper retention periods. However, by using this option you risk losing
3050 Please be aware that {\bf Purge Oldest Volume} disregards all retention
3051 periods. If you have only a single Volume defined and you turn this
3052 variable on, that Volume will always be immediately overwritten when it
3053 fills! So at a minimum, ensure that you have a decent number of Volumes
3054 in your Pool before running any jobs. If you want retention periods to
3055 apply do not use this directive. To specify a retention period, use the
3056 {\bf Volume Retention} directive (see above).
3058 We {\bf highly} recommend against using this directive, because it is
3059 sure that some day, Bacula will recycle a Volume that contains current
3060 data. The default is {\bf no}.
3062 \item [File Retention = \lt{}time-period-specification\gt{}]
3063 \index[dir]{File Retention}
3064 \index[dir]{Directive!File Retention}
3065 The File Retention directive defines the length of time that Bacula will
3066 keep File records in the Catalog database after the End time of the
3067 Job corresponding to the File records.
3069 This directive takes precedence over Client directives of the same name. For
3070 example, you can decide to increase Retention times for Archive or OffSite
3073 Note, this affects only records in the catalog database. It does not affect
3074 your archive backups.
3076 For more information see Client documentation about
3077 \ilink{FileRetention}{FileRetention}
3079 \item [Job Retention = \lt{}time-period-specification\gt{}]
3080 \index[dir]{Job Retention}
3081 \index[dir]{Directive!Job Retention}
3083 The Job Retention directive defines the length of time that Bacula will keep
3084 Job records in the Catalog database after the Job End time. As with the
3085 other retention periods, this affects only records in the catalog and not
3086 data in your archive backup.
3088 This directive takes precedence over Client directives of the same name.
3089 For example, you can decide to increase Retention times for Archive or
3092 For more information see Client side documentation
3093 \ilink{JobRetention}{JobRetention}
3095 \item [Cleaning Prefix = \lt{}string\gt{}]
3096 \index[dir]{Cleaning Prefix}
3097 \index[dir]{Directive!Cleaning Prefix}
3098 This directive defines a prefix string, which if it matches the
3099 beginning of a Volume name during labeling of a Volume, the Volume will
3100 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3101 never attempt to use this tape. This is primarily for use with
3102 autochangers that accept barcodes where the convention is that barcodes
3103 beginning with {\bf CLN} are treated as cleaning tapes.
3106 \item [Label Format = \lt{}format\gt{}]
3107 \index[dir]{Label Format}
3108 \index[dir]{Directive!Label Format}
3109 This directive specifies the format of the labels contained in this
3110 pool. The format directive is used as a sort of template to create new
3111 Volume names during automatic Volume labeling.
3113 The {\bf format} should be specified in double quotes, and consists of
3114 letters, numbers and the special characters hyphen ({\bf -}), underscore
3115 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3116 characters for a Volume name. The {\bf format} should be enclosed in
3119 In addition, the format may contain a number of variable expansion
3120 characters which will be expanded by a complex algorithm allowing you to
3121 create Volume names of many different formats. In all cases, the
3122 expansion process must resolve to the set of characters noted above that
3123 are legal Volume names. Generally, these variable expansion characters
3124 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
3125 specify variable expansion characters, you should always enclose the
3126 format with double quote characters ({\bf "}). For more details on
3127 variable expansion, please see the \ilink{Variable
3128 Expansion}{VarsChapter} Chapter of this manual.
3130 If no variable expansion characters are found in the string, the Volume
3131 name will be formed from the {\bf format} string appended with the
3132 a unique number that increases. If you do not remove volumes from the
3133 pool, this number should be the number of volumes plus one, but this
3134 is not guaranteed. The unique number will be edited as four
3135 digits with leading zeros. For example, with a {\bf Label Format =
3136 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3139 With the exception of Job specific variables, you can test your {\bf
3140 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
3143 In almost all cases, you should enclose the format specification (part
3144 after the equal sign) in double quotes. Please note that this directive
3145 is deprecated and is replaced in version 1.37 and greater with a Python
3146 script for creating volume names.
3150 In order for a Pool to be used during a Backup Job, the Pool must have at
3151 least one Volume associated with it. Volumes are created for a Pool using
3152 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3153 program. In addition to adding Volumes to the Pool (i.e. putting the
3154 Volume names in the Catalog database), the physical Volume must be labeled
3155 with a valid Bacula software volume label before {\bf Bacula} will accept
3156 the Volume. This will be automatically done if you use the {\bf label}
3157 command. Bacula can automatically label Volumes if instructed to do so,
3158 but this feature is not yet fully implemented.
3160 The following is an example of a valid Pool resource definition:
3172 \subsection{The Scratch Pool}
3173 \label{TheScratchPool}
3174 \index[general]{Scratch Pool}
3175 In general, you can give your Pools any name you wish, but there is one
3176 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3177 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3178 writing and it cannot find one, it will look in the Scratch pool, and if
3179 it finds an available Volume, it will move it out of the Scratch pool into
3180 the Pool currently being used by the job.
3183 \section{The Catalog Resource}
3184 \label{CatalogResource}
3185 \index[general]{Resource!Catalog}
3186 \index[general]{Catalog Resource}
3188 The Catalog Resource defines what catalog to use for the current job.
3189 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3190 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3191 may be as many Catalogs (databases) defined as you wish. For example, you
3192 may want each Client to have its own Catalog database, or you may want
3193 backup jobs to use one database and verify or restore jobs to use another
3196 Since SQLite is compiled in, it always runs on the same machine
3197 as the Director and the database must be directly accessible (mounted) from
3198 the Director. However, since both MySQL and PostgreSQL are networked
3199 databases, they may reside either on the same machine as the Director
3200 or on a different machine on the network. See below for more details.
3205 \index[dir]{Catalog}
3206 \index[dir]{Directive!Catalog}
3207 Start of the Catalog resource. At least one Catalog resource must be
3211 \item [Name = \lt{}name\gt{}]
3213 \index[dir]{Directive!Name}
3214 The name of the Catalog. No necessary relation to the database server
3215 name. This name will be specified in the Client resource directive
3216 indicating that all catalog data for that Client is maintained in this
3217 Catalog. This directive is required.
3219 \item [password = \lt{}password\gt{}]
3220 \index[dir]{password}
3221 \index[dir]{Directive!password}
3222 This specifies the password to use when logging into the database. This
3223 directive is required.
3225 \item [DB Name = \lt{}name\gt{}]
3226 \index[dir]{DB Name}
3227 \index[dir]{Directive!DB Name}
3228 This specifies the name of the database. If you use multiple catalogs
3229 (databases), you specify which one here. If you are using an external
3230 database server rather than the internal one, you must specify a name
3231 that is known to the server (i.e. you explicitly created the Bacula
3232 tables using this name. This directive is required.
3234 \item [user = \lt{}user\gt{}]
3236 \index[dir]{Directive!user}
3237 This specifies what user name to use to log into the database. This
3238 directive is required.
3240 \item [DB Socket = \lt{}socket-name\gt{}]
3241 \index[dir]{DB Socket}
3242 \index[dir]{Directive!DB Socket}
3243 This is the name of a socket to use on the local host to connect to the
3244 database. This directive is used only by MySQL and is ignored by SQLite.
3245 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3246 will use the default socket. If the DB Socket is specified, the
3247 MySQL server must reside on the same machine as the Director.
3249 \item [DB Address = \lt{}address\gt{}]
3250 \index[dir]{DB Address}
3251 \index[dir]{Directive!DB Address}
3252 This is the host address of the database server. Normally, you would specify
3253 this instead of {\bf DB Socket} if the database server is on another machine.
3254 In that case, you will also specify {\bf DB Port}. This directive is used
3255 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3256 This directive is optional.
3258 \item [DB Port = \lt{}port\gt{}]
3259 \index[dir]{DB Port}
3260 \index[dir]{Directive!DB Port}
3261 This defines the port to be used in conjunction with {\bf DB Address} to
3262 access the database if it is on another machine. This directive is used only
3263 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3264 directive is optional.
3266 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3267 %% \index[dir]{Multiple Connections}
3268 %% \index[dir]{Directive!Multiple Connections}
3269 %% By default, this directive is set to no. In that case, each job that uses
3271 %% same Catalog will use a single connection to the catalog. It will be shared,
3272 %% and Bacula will allow only one Job at a time to communicate. If you set this
3273 %% directive to yes, Bacula will permit multiple connections to the database,
3274 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3275 %% this is no problem. For MySQL, you must be *very* careful to have the
3276 %% multi-thread version of the client library loaded on your system. When this
3277 %% directive is set yes, each Job will have a separate connection to the
3278 %% database, and the database will control the interaction between the
3280 %% Jobs. This can significantly speed up the database operations if you are
3281 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3282 %% Bacula will automatically enable transactions. This can significantly speed
3283 %% up insertion of attributes in the database either for a single Job or
3284 %% multiple simultaneous Jobs.
3286 %% This directive has not been tested. Please test carefully before running it
3287 %% in production and report back your results.
3291 The following is an example of a valid Catalog resource definition:
3300 password = "" # no password = no security
3305 or for a Catalog on another machine:
3315 DB Address = remote.acme.com
3321 \section{The Messages Resource}
3322 \label{MessagesResource2}
3323 \index[general]{Resource!Messages}
3324 \index[general]{Messages Resource}
3326 For the details of the Messages Resource, please see the
3327 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3330 \section{The Console Resource}
3331 \label{ConsoleResource1}
3332 \index[general]{Console Resource}
3333 \index[general]{Resource!Console}
3335 As of Bacula version 1.33 and higher, there are three different kinds of
3336 consoles, which the administrator or user can use to interact with the
3337 Director. These three kinds of consoles comprise three different security
3341 \item The first console type is an {\bf anonymous} or {\bf default} console,
3342 which has full privileges. There is no console resource necessary for
3343 this type since the password is specified in the Director's resource and
3344 consequently such consoles do not have a name as defined on a {\bf Name
3345 =} directive. This is the kind of console that was initially
3346 implemented in versions prior to 1.33 and remains valid. Typically you
3347 would use it only for administrators.
3349 \item The second type of console, and new to version 1.33 and higher is a
3350 "named" console defined within a Console resource in both the Director's
3351 configuration file and in the Console's configuration file. Both the
3352 names and the passwords in these two entries must match much as is the
3353 case for Client programs.
3355 This second type of console begins with absolutely no privileges except
3356 those explicitly specified in the Director's Console resource. Thus you
3357 can have multiple Consoles with different names and passwords, sort of
3358 like multiple users, each with different privileges. As a default,
3359 these consoles can do absolutely nothing -- no commands whatsoever. You
3360 give them privileges or rather access to commands and resources by
3361 specifying access control lists in the Director's Console resource. The
3362 ACLs are specified by a directive followed by a list of access names.
3363 Examples of this are shown below.
3365 \item The third type of console is similar to the above mentioned one in that
3366 it requires a Console resource definition in both the Director and the
3367 Console. In addition, if the console name, provided on the {\bf Name =}
3368 directive, is the same as a Client name, that console is permitted to
3369 use the {\bf SetIP} command to change the Address directive in the
3370 Director's client resource to the IP address of the Console. This
3371 permits portables or other machines using DHCP (non-fixed IP addresses)
3372 to "notify" the Director of their current IP address.
3375 The Console resource is optional and need not be specified. The following
3376 directives are permitted within the Director's configuration resource:
3380 \item [Name = \lt{}name\gt{}]
3382 \index[dir]{Directive!Name}
3383 The name of the console. This name must match the name specified in the
3384 Console's configuration resource (much as is the case with Client
3387 \item [Password = \lt{}password\gt{}]
3388 \index[dir]{Password}
3389 \index[dir]{Directive!Password}
3390 Specifies the password that must be supplied for a named Bacula Console
3391 to be authorized. The same password must appear in the {\bf Console}
3392 resource of the Console configuration file. For added security, the
3393 password is never actually passed across the network but rather a
3394 challenge response hash code created with the password. This directive
3395 is required. If you have either {\bf /dev/random} {\bf bc} on your
3396 machine, Bacula will generate a random password during the configuration
3397 process, otherwise it will be left blank.
3399 The password is plain text. It is not generated through any special
3400 process. However, it is preferable for security reasons to choose
3403 \item [JobACL = \lt{}name-list\gt{}]
3405 \index[dir]{Directive!JobACL}
3406 This directive is used to specify a list of Job resource names that can
3407 be accessed by the console. Without this directive, the console cannot
3408 access any of the Director's Job resources. Multiple Job resource names
3409 may be specified by separating them with commas, and/or by specifying
3410 multiple JobACL directives. For example, the directive may be specified
3415 JobACL = kernsave, "Backup client 1", "Backup client 2"
3416 JobACL = "RestoreFiles"
3421 With the above specification, the console can access the Director's resources
3422 for the four jobs named on the JobACL directives, but for no others.
3424 \item [ClientACL = \lt{}name-list\gt{}]
3425 \index[dir]{ClientACL}
3426 \index[dir]{Directive!ClientACL}
3427 This directive is used to specify a list of Client resource names that can
3429 accessed by the console.
3431 \item [StorageACL = \lt{}name-list\gt{}]
3432 \index[dir]{StorageACL}
3433 \index[dir]{Directive!StorageACL}
3434 This directive is used to specify a list of Storage resource names that can
3435 be accessed by the console.
3437 \item [ScheduleACL = \lt{}name-list\gt{}]
3438 \index[dir]{ScheduleACL}
3439 \index[dir]{Directive!ScheduleACL}
3440 This directive is used to specify a list of Schedule resource names that can
3441 be accessed by the console.
3443 \item [PoolACL = \lt{}name-list\gt{}]
3444 \index[dir]{PoolACL}
3445 \index[dir]{Directive!PoolACL}
3446 This directive is used to specify a list of Pool resource names that can be
3447 accessed by the console.
3449 \item [FileSetACL = \lt{}name-list\gt{}]
3450 \index[dir]{FileSetACL}
3451 \index[dir]{Directive!FileSetACL}
3452 This directive is used to specify a list of FileSet resource names that
3453 can be accessed by the console.
3455 \item [CatalogACL = \lt{}name-list\gt{}]
3456 \index[dir]{CatalogACL}
3457 \index[dir]{Directive!CatalogACL}
3458 This directive is used to specify a list of Catalog resource names that
3459 can be accessed by the console.
3461 \item [CommandACL = \lt{}name-list\gt{}]
3462 \index[dir]{CommandACL}
3463 \index[dir]{Directive!CommandACL}
3464 This directive is used to specify a list of of console commands that can
3465 be executed by the console.
3467 \item [WhereACL = \lt{}string\gt{}]
3468 \index[dir]{WhereACL}
3469 \index[dir]{Directive!WhereACL}
3470 This directive permits you to specify where a restricted console
3471 can restore files. If this directive is not specified, only the
3472 default restore location is permitted (normally {\bf
3473 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3474 user enters will be accepted (not very secure), any other
3475 value specified (there may be multiple WhereACL directives) will
3476 restrict the user to use that path. For example, on a Unix system,
3477 if you specify "/", the file will be restored to the original
3478 location. This directive is untested.
3482 Aside from Director resource names and console command names, the special
3483 keyword {\bf *all*} can be specified in any of the above access control lists.
3484 When this keyword is present, any resource or command name (which ever is
3485 appropriate) will be accepted. For an example configuration file, please see
3487 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3490 \section{The Counter Resource}
3491 \label{CounterResource}
3492 \index[general]{Resource!Counter}
3493 \index[general]{Counter Resource}
3495 The Counter Resource defines a counter variable that can be accessed by
3496 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3498 \ilink{LabelFormat}{Label} directive in this chapter for more
3504 \index[dir]{Counter}
3505 \index[dir]{Directive!Counter}
3506 Start of the Counter resource. Counter directives are optional.
3508 \item [Name = \lt{}name\gt{}]
3510 \index[dir]{Directive!Name}
3511 The name of the Counter. This is the name you will use in the variable
3512 expansion to reference the counter value.
3514 \item [Minimum = \lt{}integer\gt{}]
3515 \index[dir]{Minimum}
3516 \index[dir]{Directive!Minimum}
3517 This specifies the minimum value that the counter can have. It also becomes
3518 the default. If not supplied, zero is assumed.
3520 \item [Maximum = \lt{}integer\gt{}]
3521 \index[dir]{Maximum}
3522 \index[dir]{Directive!Maximum}
3523 \index[dir]{Directive!Maximum}
3524 This is the maximum value value that the counter can have. If not specified
3525 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3526 the 31 power). When the counter is incremented past this value, it is reset
3529 \item [*WrapCounter = \lt{}counter-name\gt{}]
3530 \index[dir]{*WrapCounter}
3531 \index[dir]{Directive!*WrapCounter}
3532 If this value is specified, when the counter is incremented past the
3534 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3535 is incremented. (This is not currently implemented).
3537 \item [Catalog = \lt{}catalog-name\gt{}]
3538 \index[dir]{Catalog}
3539 \index[dir]{Directive!Catalog}
3540 If this directive is specified, the counter and its values will be saved in
3541 the specified catalog. If this directive is not present, the counter will be
3542 redefined each time that Bacula is started.
3545 \section{Example Director Configuration File}
3546 \label{SampleDirectorConfiguration}
3547 \index[general]{File!Example Director Configuration}
3548 \index[general]{Example Director Configuration File}
3550 An example Director configuration file might be the following:
3555 # Default Bacula Director Configuration file
3557 # The only thing that MUST be changed is to add one or more
3558 # file or directory names in the Include directive of the
3561 # For Bacula release 1.15 (5 March 2002) -- redhat
3563 # You might also want to change the default email address
3564 # from root to your address. See the "mail" and "operator"
3565 # directives in the Messages resource.
3567 Director { # define myself
3569 QueryFile = "/home/kern/bacula/bin/query.sql"
3570 WorkingDirectory = "/home/kern/bacula/bin/working"
3571 PidDirectory = "/home/kern/bacula/bin/working"
3572 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3574 # Define the backup Job
3576 Name = "NightlySave"
3578 Level = Incremental # default
3581 Schedule = "WeeklyCycle"
3591 Where = /tmp/bacula-restores
3597 # List of files to be backed up
3601 Options { signature=SHA1}
3603 # Put your list of files here, one per line or include an
3604 # external list with:
3608 # Note: / backs up everything
3613 # When to do the backups
3615 Name = "WeeklyCycle"
3616 Run = level=Full sun at 2:05
3617 Run = level=Incremental mon-sat at 2:05
3619 # Client (File Services) to backup
3624 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3625 File Retention = 60d # sixty day file retention
3626 Job Retention = 1y # 1 year Job retention
3627 AutoPrune = yes # Auto apply retention periods
3629 # Definition of DLT tape storage device
3633 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3634 Device = "HP DLT 80" # same as Device in Storage daemon
3635 Media Type = DLT8000 # same as MediaType in Storage daemon
3637 # Definition for a DLT autochanger device
3641 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3642 Device = "Autochanger" # same as Device in Storage daemon
3643 Media Type = DLT-8000 # Different from DLTDrive
3646 # Definition of DDS tape storage device
3650 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3651 Device = SDT-10000 # same as Device in Storage daemon
3652 Media Type = DDS-4 # same as MediaType in Storage daemon
3654 # Definition of 8mm tape storage device
3658 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3659 Device = "Exabyte 8mm"
3662 # Definition of file storage device
3666 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3667 Device = FileStorage
3670 # Generic catalog service
3673 dbname = bacula; user = bacula; password = ""
3675 # Reasonable message delivery -- send most everything to
3676 # the email address and to the console
3679 mail = root@localhost = all, !skipped, !terminate
3680 operator = root@localhost = mount
3681 console = all, !skipped, !saved
3684 # Default pool definition
3692 # Restricted console used by tray-monitor to get the status of the director
3696 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3697 CommandACL = status, .status