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 backup Job for the job specified on the {\bf VerifyJob}
682 directive. The file attribute data are compared to the
683 values saved in the Catalog database and any differences are reported.
684 This is similar to the {\bf DiskToCatalog} level except that instead of
685 comparing the disk file attributes to the catalog database, the
686 attribute data written to the Volume is read and compared to the catalog
687 database. Although the attribute data including the signatures (MD5 or
688 SHA1) are compared, the actual file data is not compared (it is not in
691 Please note! If you run two Verify VolumeToCatalog jobs on the same
692 client at the same time, the results will certainly be incorrect. This
693 is because the Verify VolumeToCatalog modifies the Catalog database
696 \item [DiskToCatalog]
697 \index[dir]{DiskToCatalog}
698 This level causes Bacula to read the files as they currently are on
699 disk, and to compare the current file attributes with the attributes
700 saved in the catalog from the last backup for the job specified on the
701 {\bf VerifyJob} directive. This level differs from the {\bf VolumeToCatalog}
702 level described above by the fact that it doesn't compare against a
703 previous Verify job but against a previous backup. When you run this
704 level, you must supply the verify options on your Include statements.
705 Those options determine what attribute fields are compared.
707 This command can be very useful if you have disk problems because it
708 will compare the current state of your disk against the last successful
709 backup, which may be several jobs.
711 Note, the current implementation (1.32c) does not identify files that
715 \item [Accurate = \lt{}yes\vb{}no\gt{}]
716 \index[dir]{Accurate}
717 In accurate mode, the File daemon knowns exactly which files were present
718 after the last backup. So it is able to handle deleted or renamed files.
720 When restoring a FileSet for a specified date (including "most
721 recent"), Bacula is able to restore exactly the files and
722 directories that existed at the time of the last backup prior to
723 that date including ensuring that deleted files are actually deleted,
724 and renamed directories are restored properly.
726 In this mode, the File daemon must keep data concerning all files in
727 memory. So If you do not have sufficient memory, the backup may
728 either be terribly slow or fail.
730 %% $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
732 For 500.000 files (a typical desktop linux system), it will require
733 approximately 64 Megabytes of RAM on your File daemon to hold the
734 required information.
736 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
737 \index[dir]{Verify Job}
738 \index[dir]{Directive!Verify Job}
739 If you run a verify job without this directive, the last job run will be
740 compared with the catalog, which means that you must immediately follow
741 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
742 will find the last job with that name that ran. This permits you to run
743 all your backups, then run Verify jobs on those that you wish to be
744 verified (most often a {\bf VolumeToCatalog}) so that the tape just
747 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
749 \index[dir]{Directive!JobDefs}
750 If a JobDefs-Resource-Name is specified, all the values contained in the
751 named JobDefs resource will be used as the defaults for the current Job.
752 Any value that you explicitly define in the current Job resource, will
753 override any defaults specified in the JobDefs resource. The use of
754 this directive permits writing much more compact Job resources where the
755 bulk of the directives are defined in one or more JobDefs. This is
756 particularly useful if you have many similar Jobs but with minor
757 variations such as different Clients. A simple example of the use of
758 JobDefs is provided in the default bacula-dir.conf file.
760 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
761 \index[dir]{Bootstrap}
762 \index[dir]{Directive!Bootstrap}
763 The Bootstrap directive specifies a bootstrap file that, if provided,
764 will be used during {\bf Restore} Jobs and is ignored in other Job
765 types. The {\bf bootstrap} file contains the list of tapes to be used
766 in a restore Job as well as which files are to be restored.
767 Specification of this directive is optional, and if specified, it is
768 used only for a restore job. In addition, when running a Restore job
769 from the console, this value can be changed.
771 If you use the {\bf Restore} command in the Console program, to start a
772 restore job, the {\bf bootstrap} file will be created automatically from
773 the files you select to be restored.
775 For additional details of the {\bf bootstrap} file, please see
776 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
779 \label{writebootstrap}
780 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
781 \index[dir]{Write Bootstrap}
782 \index[dir]{Directive!Write Bootstrap}
783 The {\bf writebootstrap} directive specifies a file name where Bacula
784 will write a {\bf bootstrap} file for each Backup job run. This
785 directive applies only to Backup Jobs. If the Backup job is a Full
786 save, Bacula will erase any current contents of the specified file
787 before writing the bootstrap records. If the Job is an Incremental
789 save, Bacula will append the current bootstrap record to the end of the
792 Using this feature, permits you to constantly have a bootstrap file that
793 can recover the current state of your system. Normally, the file
794 specified should be a mounted drive on another machine, so that if your
795 hard disk is lost, you will immediately have a bootstrap record
796 available. Alternatively, you should copy the bootstrap file to another
797 machine after it is updated. Note, it is a good idea to write a separate
798 bootstrap file for each Job backed up including the job that backs up
799 your catalog database.
801 If the {\bf bootstrap-file-specification} begins with a vertical bar
802 (\verb+|+), Bacula will use the specification as the name of a program to which
803 it will pipe the bootstrap record. It could for example be a shell
804 script that emails you the bootstrap record.
806 On versions 1.39.22 or greater, before opening the file or executing the
807 specified command, Bacula performs
808 \ilink{character substitution}{character substitution} like in RunScript
809 directive. To automatically manage your bootstrap files, you can use
810 this in your {\bf JobDefs} resources:
813 Write Bootstrap = "%c_%n.bsr"
818 For more details on using this file, please see the chapter entitled
819 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
821 \item [Client = \lt{}client-resource-name\gt{}]
823 \index[dir]{Directive!Client}
824 The Client directive specifies the Client (File daemon) that will be used in
825 the current Job. Only a single Client may be specified in any one Job. The
826 Client runs on the machine to be backed up, and sends the requested files to
827 the Storage daemon for backup, or receives them when restoring. For
828 additional details, see the
829 \ilink{Client Resource section}{ClientResource2} of this chapter.
830 This directive is required.
832 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
834 \index[dir]{Directive!FileSet}
835 The FileSet directive specifies the FileSet that will be used in the
836 current Job. The FileSet specifies which directories (or files) are to
837 be backed up, and what options to use (e.g. compression, ...). Only a
838 single FileSet resource may be specified in any one Job. For additional
839 details, see the \ilink{FileSet Resource section}{FileSetResource} of
840 this chapter. This directive is required.
842 \item [Base = \lt{}job-resource-name, ...\gt{}]
844 \index[dir]{Directive!Base}
845 The Base directive permits to specify the list of jobs that will be used during
846 Full backup as base. This directive is optional. See the \ilink{Base Job
847 chapter}{basejobs} for more information.
849 \item [Messages = \lt{}messages-resource-name\gt{}]
850 \index[dir]{Messages}
851 \index[dir]{Directive!Messages}
852 The Messages directive defines what Messages resource should be used for
853 this job, and thus how and where the various messages are to be
854 delivered. For example, you can direct some messages to a log file, and
855 others can be sent by email. For additional details, see the
856 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
857 directive is required.
859 \item [Pool = \lt{}pool-resource-name\gt{}]
861 \index[dir]{Directive!Pool}
862 The Pool directive defines the pool of Volumes where your data can be
863 backed up. Many Bacula installations will use only the {\bf Default}
864 pool. However, if you want to specify a different set of Volumes for
865 different Clients or different Jobs, you will probably want to use
866 Pools. For additional details, see the \ilink{Pool Resource
867 section}{PoolResource} of this chapter. This directive is required.
869 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
870 \index[dir]{Full Backup Pool}
871 \index[dir]{Directive!Full Backup Pool}
872 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
873 It will override any Pool specification during a Full backup. This
874 directive is optional.
876 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
877 \index[dir]{Differential Backup Pool}
878 \index[dir]{Directive!Differential Backup Pool}
879 The {\it Differential Backup Pool} specifies a Pool to be used for
880 Differential backups. It will override any Pool specification during a
881 Differential backup. This directive is optional.
883 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
884 \index[dir]{Incremental Backup Pool}
885 \index[dir]{Directive!Incremental Backup Pool}
886 The {\it Incremental Backup Pool} specifies a Pool to be used for
887 Incremental backups. It will override any Pool specification during an
888 Incremental backup. This directive is optional.
890 \item [Schedule = \lt{}schedule-name\gt{}]
891 \index[dir]{Schedule}
892 \index[dir]{Directive!Schedule}
893 The Schedule directive defines what schedule is to be used for the Job.
894 The schedule in turn determines when the Job will be automatically
895 started and what Job level (i.e. Full, Incremental, ...) is to be run.
896 This directive is optional, and if left out, the Job can only be started
897 manually using the Console program. Although you may specify only a
898 single Schedule resource for any one job, the Schedule resource may
899 contain multiple {\bf Run} directives, which allow you to run the Job at
900 many different times, and each {\bf run} directive permits overriding
901 the default Job Level Pool, Storage, and Messages resources. This gives
902 considerable flexibility in what can be done with a single Job. For
903 additional details, see the \ilink{Schedule Resource
904 Chapter}{ScheduleResource} of this manual.
907 \item [Storage = \lt{}storage-resource-name\gt{}]
909 \index[dir]{Directive!Storage}
910 The Storage directive defines the name of the storage services where you
911 want to backup the FileSet data. For additional details, see the
912 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
913 The Storage resource may also be specified in the Job's Pool resource,
914 in which case the value in the Pool resource overrides any value
915 in the Job. This Storage resource definition is not required by either
916 the Job resource or in the Pool, but it must be specified in
917 one or the other, if not an error will result.
919 \item [Max Start Delay = \lt{}time\gt{}]
920 \index[dir]{Max Start Delay}
921 \index[dir]{Directive!Max Start Delay}
922 The time specifies the maximum delay between the scheduled time and the
923 actual start time for the Job. For example, a job can be scheduled to
924 run at 1:00am, but because other jobs are running, it may wait to run.
925 If the delay is set to 3600 (one hour) and the job has not begun to run
926 by 2:00am, the job will be canceled. This can be useful, for example,
927 to prevent jobs from running during day time hours. The default is 0
928 which indicates no limit.
930 \item [Max Run Time = \lt{}time\gt{}]
931 \index[dir]{Max Run Time}
932 \index[dir]{Directive!Max Run Time}
933 The time specifies the maximum allowed time that a job may run, counted
934 from when the job starts, ({\bf not} necessarily the same as when the
937 By default, the the watchdog thread will kill any Job that has run more
938 than 6 days. The maximum watchdog timeout is independent of MaxRunTime
939 and cannot be changed.
942 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
943 \index[dir]{Incremental Wait Run Time}
944 \index[dir]{Differential Wait Run Time}
945 \index[dir]{Directive!Differential Max Wait Time}
946 Theses directives have been deprecated in favor of
947 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
949 \item [Incremental Max Run Time = \lt{}time\gt{}]
950 \index[dir]{Incremental Max Run Time}
951 \index[dir]{Directive!Incremental Max Run Time}
952 The time specifies the maximum allowed time that an Incremental backup job may
953 run, counted from when the job starts, ({\bf not} necessarily the same as when
954 the job was scheduled).
956 \item [Differential Max Wait Time = \lt{}time\gt{}]
957 \index[dir]{Differential Max Run Time}
958 \index[dir]{Directive!Differential Max Run Time}
959 The time specifies the maximum allowed time that a Differential backup job may
960 run, counted from when the job starts, ({\bf not} necessarily the same as when
961 the job was scheduled).
963 \item [Max Run Sched Time = \lt{}time\gt{}]
964 \index[dir]{Max Run Sched Time}
965 \index[dir]{Directive!Max Run Sched Time}
967 The time specifies the maximum allowed time that a job may run, counted from
968 when the job was scheduled. This can be useful to prevent jobs from running
969 during working hours. We can see it like \texttt{Max Start Delay + Max Run
972 \item [Max Wait Time = \lt{}time\gt{}]
973 \index[dir]{Max Wait Time}
974 \index[dir]{Directive!Max Wait Time}
975 The time specifies the maximum allowed time that a job may block waiting
976 for a resource (such as waiting for a tape to be mounted, or waiting for
977 the storage or file daemons to perform their duties), counted from the
978 when the job starts, ({\bf not} necessarily the same as when the job was
979 scheduled). This directive works as expected since bacula 2.3.18.
983 \includegraphics[width=13cm]{\idir different_time.eps}
984 \caption{Job time control directives}
985 \label{fig:differenttime}
988 \item [Maximum Bandwidth = \lt{}speed\gt{}]
989 \index[dir]{Maximum Bandwidth}
990 \index[dir]{Directive!Maximum Bandwidth}
992 The speed parameter specifies the maximum allowed bandwidth that a job may
993 use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
995 \item [Max Full Interval = \lt{}time\gt{}]
996 \index[dir]{Max Full Interval}
997 \index[dir]{Directive!Max Full Interval}
998 The time specifies the maximum allowed age (counting from start time) of
999 the most recent successful Full backup that is required in order to run
1000 Incremental or Differential backup jobs. If the most recent Full backup
1001 is older than this interval, Incremental and Differential backups will be
1002 upgraded to Full backups automatically. If this directive is not present,
1003 or specified as 0, then the age of the previous Full backup is not
1006 \label{PreferMountedVolumes}
1007 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
1008 \index[dir]{Prefer Mounted Volumes}
1009 \index[dir]{Directive!Prefer Mounted Volumes}
1010 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
1011 yes), the Storage daemon is requested to select either an Autochanger or
1012 a drive with a valid Volume already mounted in preference to a drive
1013 that is not ready. This means that all jobs will attempt to append
1014 to the same Volume (providing the Volume is appropriate -- right Pool,
1015 ... for that job), unless you are using multiple pools.
1016 If no drive with a suitable Volume is available, it
1017 will select the first available drive. Note, any Volume that has
1018 been requested to be mounted, will be considered valid as a mounted
1019 volume by another job. This if multiple jobs start at the same time
1020 and they all prefer mounted volumes, the first job will request the
1021 mount, and the other jobs will use the same volume.
1023 If the directive is set to {\bf no}, the Storage daemon will prefer
1024 finding an unused drive, otherwise, each job started will append to the
1025 same Volume (assuming the Pool is the same for all jobs). Setting
1026 Prefer Mounted Volumes to no can be useful for those sites
1027 with multiple drive autochangers that prefer to maximize backup
1028 throughput at the expense of using additional drives and Volumes.
1029 This means that the job will prefer to use an unused drive rather
1030 than use a drive that is already in use.
1032 Despite the above, we recommend against setting this directive to
1034 it tends to add a lot of swapping of Volumes between the different
1035 drives and can easily lead to deadlock situations in the Storage
1036 daemon. We will accept bug reports against it, but we cannot guarantee
1037 that we will be able to fix the problem in a reasonable time.
1039 A better alternative for using multiple drives is to use multiple
1040 pools so that Bacula will be forced to mount Volumes from those Pools
1041 on different drives.
1043 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1044 \index[dir]{Prune Jobs}
1045 \index[dir]{Directive!Prune Jobs}
1046 Normally, pruning of Jobs from the Catalog is specified on a Pool by
1047 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1048 If this directive is specified (not normally) and the value is {\bf
1049 yes}, it will override the value specified in the Pool resource. The
1050 default is {\bf no}.
1053 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1054 \index[dir]{Prune Files}
1055 \index[dir]{Directive!Prune Files}
1056 Normally, pruning of Files from the Catalog is specified on a Pool by
1057 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1058 If this directive is specified (not normally) and the value is {\bf
1059 yes}, it will override the value specified in the Pool resource. The
1060 default is {\bf no}.
1062 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1063 \index[dir]{Prune Volumes}
1064 \index[dir]{Directive!Prune Volumes}
1065 Normally, pruning of Volumes from the Catalog is specified on a Pool
1066 by Pool basis in the Pool resource with the {\bf AutoPrune}
1067 directive. If this directive is specified (not normally) and the value
1068 is {\bf yes}, it will override the value specified in the Pool
1069 resource. The default is {\bf no}.
1071 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1072 \index[dir]{RunScript}
1073 \index[dir]{Directive!Run Script}
1075 The RunScript directive behaves like a resource in that it
1076 requires opening and closing braces around a number of directives
1077 that make up the body of the runscript.
1079 The specified {\bf Command} (see below for details) is run as an external
1080 program prior or after the current Job. This is optional. By default, the
1081 program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1083 \textbf{Console} options are special commands that are sent to the director instead
1084 of the OS. At this time, console command ouputs are redirected to log with
1087 You can use following console command : \texttt{delete}, \texttt{disable},
1088 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1089 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1090 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1091 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1092 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1093 more information. You need to specify needed information on command line, nothing
1094 will be prompted. Example :
1097 Console = "prune files client=%c"
1098 Console = "update stats age=3"
1101 You can specify more than one Command/Console option per RunScript.
1103 You can use following options may be specified in the body
1106 \begin{tabular}{|c|c|c|l}
1107 Options & Value & Default & Information \\
1110 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
1112 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
1114 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
1116 Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
1118 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
1119 something different from 0 \\
1121 Command & & & Path to your script\\
1123 Console & & & Console command\\
1128 Any output sent by the command to standard output will be included in the
1129 Bacula job report. The command string must be a valid program name or name
1132 In addition, the command string is parsed then fed to the OS,
1133 which means that the path will be searched to execute your specified
1134 command, but there is no shell interpretation, as a consequence, if you
1135 invoke complicated commands or want any shell features such as redirection
1136 or piping, you must call a shell script and do it inside that script.
1138 Before submitting the specified command to the operating system, Bacula
1139 performs character substitution of the following characters:
1141 \label{character substitution}
1147 %d = Daemon's name (Such as host-dir or host-fd)
1148 %D = Director's name (Also valid on file daemon)
1149 %e = Job Exit Status
1150 %f = Job FileSet (Only on director side)
1157 %p = Pool name (Only on director side)
1159 %t = Job type (Backup, ...)
1160 %v = Volume name (Only on director side)
1161 %w = Storage name (Only on director side)
1162 %x = Spooling enabled? ("yes" or "no")
1167 Some character substitutions are not available in all situations. The Job Exit
1168 Status code \%e edits the following values:
1170 \index[dir]{Exit Status}
1177 \item Unknown term code
1180 Thus if you edit it on a command line, you will need to enclose
1181 it within some sort of quotes.
1184 You can use these following shortcuts:\\
1186 \begin{tabular}{|c|c|c|c|c|c}
1187 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1189 Run Before Job & & & Yes & No & Before \\
1191 Run After Job & Yes & No & & No & After \\
1193 Run After Failed Job & No & Yes & & No & After \\
1195 Client Run Before Job & & & Yes & Yes & Before \\
1197 Client Run After Job & Yes & No & & Yes & After \\
1205 Command = "/etc/init.d/apache stop"
1211 Command = "/etc/init.d/apache start"
1215 {\bf Notes about ClientRunBeforeJob}
1217 For compatibility reasons, with this shortcut, the command is executed
1218 directly when the client recieve it. And if the command is in error, other
1219 remote runscripts will be discarded. To be sure that all commands will be
1220 sent and executed, you have to use RunScript syntax.
1222 {\bf Special Windows Considerations}
1224 You can run scripts just after snapshots initializations with
1225 \textsl{AfterVSS} keyword.
1227 In addition, for a Windows client on version 1.33 and above, please take
1228 note that you must ensure a correct path to your script. The script or
1229 program can be a .com, .exe or a .bat file. If you just put the program
1230 name in then Bacula will search using the same rules that cmd.exe uses
1231 (current directory, Bacula bin directory, and PATH). It will even try the
1232 different extensions in the same order as cmd.exe.
1233 The command can be anything that cmd.exe or command.com will recognize
1234 as an executable file.
1236 However, if you have slashes in the program name then Bacula figures you
1237 are fully specifying the name, so you must also explicitly add the three
1238 character extension.
1240 The command is run in a Win32 environment, so Unix like commands will not
1241 work unless you have installed and properly configured Cygwin in addition
1242 to and separately from Bacula.
1244 The System \%Path\% will be searched for the command. (under the
1245 environment variable dialog you have have both System Environment and
1246 User Environment, we believe that only the System environment will be
1247 available to bacula-fd, if it is running as a service.)
1249 System environment variables can be referenced with \%var\% and
1250 used as either part of the command name or arguments.
1252 So if you have a script in the Bacula\\bin directory then the following lines
1257 Client Run Before Job = systemstate
1259 Client Run Before Job = systemstate.bat
1261 Client Run Before Job = "systemstate"
1263 Client Run Before Job = "systemstate.bat"
1265 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1269 The outer set of quotes is removed when the configuration file is parsed.
1270 You need to escape the inner quotes so that they are there when the code
1271 that parses the command line for execution runs so it can tell what the
1277 ClientRunBeforeJob = "\"C:/Program Files/Software
1278 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1282 The special characters
1286 will need to be quoted,
1287 if they are part of a filename or argument.
1289 If someone is logged in, a blank "command" window running the commands
1290 will be present during the execution of the command.
1292 Some Suggestions from Phil Stracchino for running on Win32 machines with
1293 the native Win32 File daemon:
1296 \item You might want the ClientRunBeforeJob directive to specify a .bat
1297 file which runs the actual client-side commands, rather than trying
1298 to run (for example) regedit /e directly.
1299 \item The batch file should explicitly 'exit 0' on successful completion.
1300 \item The path to the batch file should be specified in Unix form:
1302 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1304 rather than DOS/Windows form:
1306 ClientRunBeforeJob =
1308 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1312 For Win32, please note that there are certain limitations:
1314 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1316 Lines like the above do not work because there are limitations of
1317 cmd.exe that is used to execute the command.
1318 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1319 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1320 cmd prompt and see what happens. Once the command is correct insert a
1321 backslash (\textbackslash{}) before each double quote ("), and
1322 then put quotes around the whole thing when putting it in
1323 the director's .conf file. You either need to have only one set of quotes
1324 or else use the short name and don't put quotes around the command path.
1326 Below is the output from cmd's help as it relates to the command line
1327 passed to the /c option.
1330 If /C or /K is specified, then the remainder of the command line after
1331 the switch is processed as a command line, where the following logic is
1332 used to process quote (") characters:
1336 If all of the following conditions are met, then quote characters
1337 on the command line are preserved:
1340 \item exactly two quote characters.
1341 \item no special characters between the two quote characters,
1342 where special is one of:
1346 \item there are one or more whitespace characters between the
1347 the two quote characters.
1348 \item the string between the two quote characters is the name
1349 of an executable file.
1352 \item Otherwise, old behavior is to see if the first character is
1353 a quote character and if so, strip the leading character and
1354 remove the last quote character on the command line, preserving
1355 any text after the last quote character.
1360 The following example of the use of the Client Run Before Job directive was
1361 submitted by a user:\\
1362 You could write a shell script to back up a DB2 database to a FIFO. The shell
1372 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1377 The following line in the Job resource in the bacula-dir.conf file:
1380 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1385 When the job is run, you will get messages from the output of the script
1386 stating that the backup has started. Even though the command being run is
1387 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1388 command, thus the backup stalls.
1390 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1395 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1400 It is important to redirect the input and outputs of a backgrounded command to
1401 /dev/null to prevent the script from blocking.
1403 \item [Run Before Job = \lt{}command\gt{}]
1404 \index[dir]{Run Before Job}
1405 \index[dir]{Directive!Run Before Job}
1406 \index[dir]{Directive!Run Before Job}
1407 The specified {\bf command} is run as an external program prior to running the
1408 current Job. This directive is not required, but if it is defined, and if the
1409 exit code of the program run is non-zero, the current Bacula job will be
1413 Run Before Job = "echo test"
1415 it's equivalent to :
1418 Command = "echo test"
1424 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1425 simple way to modify your schedules during a holiday. For example, suppose
1426 that you normally do Full backups on Fridays, but Thursday and Friday are
1427 holidays. To avoid having to change tapes between Thursday and Friday when
1428 no one is in the office, you can create a RunBeforeJob that returns a
1429 non-zero status on Thursday and zero on all other days. That way, the
1430 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1431 before leaving will be used.
1433 \item [Run After Job = \lt{}command\gt{}]
1434 \index[dir]{Run After Job}
1435 \index[dir]{Directive!Run After Job}
1436 The specified {\bf command} is run as an external program if the current
1437 job terminates normally (without error or without being canceled). This
1438 directive is not required. If the exit code of the program run is
1439 non-zero, Bacula will print a warning message. Before submitting the
1440 specified command to the operating system, Bacula performs character
1441 substitution as described above for the {\bf RunScript} directive.
1443 An example of the use of this directive is given in the
1444 \ilink{Tips Chapter}{JobNotification} of this manual.
1446 See the {\bf Run After Failed Job} if you
1447 want to run a script after the job has terminated with any
1450 \item [Run After Failed Job = \lt{}command\gt{}]
1451 \index[dir]{Run After Job}
1452 \index[dir]{Directive!Run After Job}
1453 The specified {\bf command} is run as an external program after the current
1454 job terminates with any error status. This directive is not required. The
1455 command string must be a valid program name or name of a shell script. If
1456 the exit code of the program run is non-zero, Bacula will print a
1457 warning message. Before submitting the specified command to the
1458 operating system, Bacula performs character substitution as described above
1459 for the {\bf RunScript} directive. Note, if you wish that your script
1460 will run regardless of the exit status of the Job, you can use this :
1463 Command = "echo test"
1467 RunsOnSuccess = yes # default, you can drop this line
1471 An example of the use of this directive is given in the
1472 \ilink{Tips Chapter}{JobNotification} of this manual.
1475 \item [Client Run Before Job = \lt{}command\gt{}]
1476 \index[dir]{Client Run Before Job}
1477 \index[dir]{Directive!Client Run Before Job}
1478 This directive is the same as {\bf Run Before Job} except that the
1479 program is run on the client machine. The same restrictions apply to
1480 Unix systems as noted above for the {\bf RunScript}.
1482 \item [Client Run After Job = \lt{}command\gt{}]
1483 \index[dir]{Client Run After Job}
1484 \index[dir]{Directive!Client Run After Job}
1485 The specified {\bf command} is run on the client machine as soon
1486 as data spooling is complete in order to allow restarting applications
1487 on the client as soon as possible. .
1489 Note, please see the notes above in {\bf RunScript}
1490 concerning Windows clients.
1492 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1493 \index[dir]{Rerun Failed Levels}
1494 \index[dir]{Directive!Rerun Failed Levels}
1495 If this directive is set to {\bf yes} (default no), and Bacula detects that
1496 a previous job at a higher level (i.e. Full or Differential) has failed,
1497 the current job level will be upgraded to the higher level. This is
1498 particularly useful for Laptops where they may often be unreachable, and if
1499 a prior Full save has failed, you wish the very next backup to be a Full
1500 save rather than whatever level it is started as.
1502 There are several points that must be taken into account when using this
1503 directive: first, a failed job is defined as one that has not terminated
1504 normally, which includes any running job of the same name (you need to
1505 ensure that two jobs of the same name do not run simultaneously);
1506 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1507 when checking for failed levels, which means that any FileSet change will
1510 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1511 \index[dir]{Spool Data}
1512 \index[dir]{Directive!Spool Data}
1514 If this directive is set to {\bf yes} (default no), the Storage daemon will
1515 be requested to spool the data for this Job to disk rather than write it
1516 directly to tape. Once all the data arrives or the spool files' maximum sizes
1517 are reached, the data will be despooled and written to tape. Spooling data
1518 prevents tape shoe-shine (start and stop) during
1519 Incremental saves. If you are writing to a disk file using this option
1520 will probably just slow down the backup jobs.
1522 NOTE: When this directive is set to yes, Spool Attributes is also
1523 automatically set to yes.
1525 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1526 \index[dir]{Spool Attributes}
1527 \index[dir]{Directive!Spool Attributes}
1529 \index[general]{slow}
1530 \index[dir]{Backups!slow}
1531 \index[general]{Backups!slow}
1532 The default is set to {\bf no}, which means that the File attributes are
1533 sent by the Storage daemon to the Director as they are stored on tape.
1534 However, if you want to avoid the possibility that database updates will
1535 slow down writing to the tape, you may want to set the value to {\bf
1536 yes}, in which case the Storage daemon will buffer the File attributes
1537 and Storage coordinates to a temporary file in the Working Directory,
1538 then when writing the Job data to the tape is completed, the attributes
1539 and storage coordinates will be sent to the Director.
1541 NOTE: When Spool Data is set to yes, Spool Attributes is also
1542 automatically set to yes.
1544 \item [Where = \lt{}directory\gt{}]
1546 \index[dir]{Directive!Where}
1547 This directive applies only to a Restore job and specifies a prefix to
1548 the directory name of all files being restored. This permits files to
1549 be restored in a different location from which they were saved. If {\bf
1550 Where} is not specified or is set to backslash ({\bf /}), the files will
1551 be restored to their original location. By default, we have set {\bf
1552 Where} in the example configuration files to be {\bf
1553 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1556 \item [Add Prefix = \lt{}directory\gt{}]
1557 \label{confaddprefix}
1558 \index[dir]{AddPrefix}
1559 \index[dir]{Directive!AddPrefix}
1560 This directive applies only to a Restore job and specifies a prefix to the
1561 directory name of all files being restored. This will use \ilink{File
1562 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1564 \item [Add Suffix = \lt{}extention\gt{}]
1565 \index[dir]{AddSuffix}
1566 \index[dir]{Directive!AddSuffix}
1567 This directive applies only to a Restore job and specifies a suffix to all
1568 files being restored. This will use \ilink{File Relocation}{filerelocation}
1569 feature implemented in Bacula 2.1.8 or later.
1571 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1572 \texttt{/etc/passwsd.old}
1574 \item [Strip Prefix = \lt{}directory\gt{}]
1575 \index[dir]{StripPrefix}
1576 \index[dir]{Directive!StripPrefix}
1577 This directive applies only to a Restore job and specifies a prefix to remove
1578 from the directory name of all files being restored. This will use the
1579 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1582 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1585 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1593 \item [RegexWhere = \lt{}expressions\gt{}]
1594 \index[dir]{RegexWhere}
1595 \index[dir]{Directive!RegexWhere}
1596 This directive applies only to a Restore job and specifies a regex filename
1597 manipulation of all files being restored. This will use \ilink{File
1598 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1600 For more informations about how use this option, see
1601 \ilink{this}{useregexwhere}.
1603 \item [Replace = \lt{}replace-option\gt{}]
1604 \index[dir]{Replace}
1605 \index[dir]{Directive!Replace}
1606 This directive applies only to a Restore job and specifies what happens
1607 when Bacula wants to restore a file or directory that already exists.
1608 You have the following options for {\bf replace-option}:
1614 when the file to be restored already exists, it is deleted and then
1615 replaced by the copy that was backed up. This is the default value.
1618 \index[dir]{ifnewer}
1619 if the backed up file (on tape) is newer than the existing file, the
1620 existing file is deleted and replaced by the back up.
1623 \index[dir]{ifolder}
1624 if the backed up file (on tape) is older than the existing file, the
1625 existing file is deleted and replaced by the back up.
1629 if the backed up file already exists, Bacula skips restoring this file.
1632 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1633 \index[dir]{Prefix Links}
1634 \index[dir]{Directive!Prefix Links}
1635 If a {\bf Where} path prefix is specified for a recovery job, apply it
1636 to absolute links as well. The default is {\bf No}. When set to {\bf
1637 Yes} then while restoring files to an alternate directory, any absolute
1638 soft links will also be modified to point to the new alternate
1639 directory. Normally this is what is desired -- i.e. everything is self
1640 consistent. However, if you wish to later move the files to their
1641 original locations, all files linked with absolute names will be broken.
1643 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1644 \index[dir]{Maximum Concurrent Jobs}
1645 \index[dir]{Directive!Maximum Concurrent Jobs}
1646 where \lt{}number\gt{} is the maximum number of Jobs from the current
1647 Job resource that can run concurrently. Note, this directive limits
1648 only Jobs with the same name as the resource in which it appears. Any
1649 other restrictions on the maximum concurrent jobs such as in the
1650 Director, Client, or Storage resources will also apply in addition to
1651 the limit specified here. The default is set to 1, but you may set it
1652 to a larger number. We strongly recommend that you read the WARNING
1653 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1654 Director's resource.
1656 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1657 \index[dir]{Reschedule On Error}
1658 \index[dir]{Directive!Reschedule On Error}
1659 If this directive is enabled, and the job terminates in error, the job
1660 will be rescheduled as determined by the {\bf Reschedule Interval} and
1661 {\bf Reschedule Times} directives. If you cancel the job, it will not
1662 be rescheduled. The default is {\bf no} (i.e. the job will not be
1665 This specification can be useful for portables, laptops, or other
1666 machines that are not always connected to the network or switched on.
1668 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1669 \index[dir]{Reschedule Interval}
1670 \index[dir]{Directive!Reschedule Interval}
1671 If you have specified {\bf Reschedule On Error = yes} and the job
1672 terminates in error, it will be rescheduled after the interval of time
1673 specified by {\bf time-specification}. See \ilink{the time
1674 specification formats}{Time} in the Configure chapter for details of
1675 time specifications. If no interval is specified, the job will not be
1676 rescheduled on error.
1678 \item [Reschedule Times = \lt{}count\gt{}]
1679 \index[dir]{Reschedule Times}
1680 \index[dir]{Directive!Reschedule Times}
1681 This directive specifies the maximum number of times to reschedule the
1682 job. If it is set to zero (the default) the job will be rescheduled an
1683 indefinite number of times.
1685 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1686 \index[general]{Allow Duplicate Jobs}
1688 \begin{figure}[htbp]
1690 \includegraphics[width=13cm]{\idir duplicate-real.eps}
1691 \caption{Allow Duplicate Jobs usage}
1692 \label{fig:allowduplicatejobs}
1695 A duplicate job in the sense we use it here means a second or subsequent job
1696 with the same name starts. This happens most frequently when the first job
1697 runs longer than expected because no tapes are available.
1699 If this directive is enabled duplicate jobs will be run. If
1700 the directive is set to {\bf no} (default) then only one job of a given name
1701 may run at one time, and the action that Bacula takes to ensure only
1702 one job runs is determined by the other directives (see below).
1704 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1705 are present and none of the three directives given below permit
1706 cancelling a job, then the current job (the second one started)
1709 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1710 \index[general]{Allow Higher Duplicates}
1711 This directive was implemented in version 5.0.0, but does not work
1712 as expected. If used, it should always be set to no. In later versions
1713 of Bacula the directive is disabled (disregarded).
1716 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1717 \index[general]{Cancel Lower Level Duplicates}
1718 If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
1719 directive is set to \textbf{yes}, Bacula will choose between duplicated
1720 jobs the one with the highest level. For example, it will cancel a
1721 previous Incremental to run a Full backup. It works only for Backup
1722 jobs. The default is \texttt{no}. If the levels of the duplicated
1723 jobs are the same, nothing is done and the other
1724 Cancel XXX Duplicate directives will be examined.
1726 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1727 \index[general]{Cancel Queued Duplicates}
1728 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1729 if this directive is set to {\bf yes} any job that is
1730 already queued to run but not yet running will be canceled.
1731 The default is {\bf no}.
1733 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1734 \index[general]{Cancel Running Duplicates}
1735 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1736 if this directive is set to {\bf yes} any job that is already running
1737 will be canceled. The default is {\bf no}.
1740 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1741 %%\index[general]{Duplicate Job Proximity}
1742 %% This directive permits to determine if two jobs are really duplicated.
1743 %% If the first one is running for long time, this is probably not a good
1744 %% idea to cancel it.
1746 \item [Run = \lt{}job-name\gt{}]
1748 \index[dir]{Directive!Run}
1749 \index[dir]{Clone a Job}
1750 The Run directive (not to be confused with the Run option in a
1751 Schedule) allows you to start other jobs or to clone jobs. By using the
1752 cloning keywords (see below), you can backup
1753 the same data (or almost the same data) to two or more drives
1754 at the same time. The {\bf job-name} is normally the same name
1755 as the current Job resource (thus creating a clone). However, it
1756 may be any Job name, so one job may start other related jobs.
1758 The part after the equal sign must be enclosed in double quotes,
1759 and can contain any string or set of options (overrides) that you
1760 can specify when entering the Run command from the console. For
1761 example {\bf storage=DDS-4 ...}. In addition, there are two special
1762 keywords that permit you to clone the current job. They are {\bf level=\%l}
1763 and {\bf since=\%s}. The \%l in the level keyword permits
1764 entering the actual level of the current job and the \%s in the since
1765 keyword permits putting the same time for comparison as used on the
1766 current job. Note, in the case of the since keyword, the \%s must be
1767 enclosed in double quotes, and thus they must be preceded by a backslash
1768 since they are already inside quotes. For example:
1771 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1774 A cloned job will not start additional clones, so it is not
1775 possible to recurse.
1777 Please note that all cloned jobs, as specified in the Run directives are
1778 submitted for running before the original job is run (while it is being
1779 initialized). This means that any clone job will actually start before
1780 the original job, and may even block the original job from starting
1781 until the original job finishes unless you allow multiple simultaneous
1782 jobs. Even if you set a lower priority on the clone job, if no other
1783 jobs are running, it will start before the original job.
1785 If you are trying to prioritize jobs by using the clone feature (Run
1786 directive), you will find it much easier to do using a RunScript
1787 resource, or a RunBeforeJob directive.
1790 \item [Priority = \lt{}number\gt{}]
1791 \index[dir]{Priority}
1792 \index[dir]{Directive!Priority}
1793 This directive permits you to control the order in which your jobs will
1794 be run by specifying a positive non-zero number. The higher the number,
1795 the lower the job priority. Assuming you are not running concurrent jobs,
1796 all queued jobs of priority 1 will run before queued jobs of priority 2
1797 and so on, regardless of the original scheduling order.
1799 The priority only affects waiting jobs that are queued to run, not jobs
1800 that are already running. If one or more jobs of priority 2 are already
1801 running, and a new job is scheduled with priority 1, the currently
1802 running priority 2 jobs must complete before the priority 1 job is
1803 run, unless Allow Mixed Priority is set.
1805 The default priority is 10.
1807 If you want to run concurrent jobs you should
1808 keep these points in mind:
1811 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1814 \item Bacula concurrently runs jobs of only one priority at a time. It
1815 will not simultaneously run a priority 1 and a priority 2 job.
1817 \item If Bacula is running a priority 2 job and a new priority 1 job is
1818 scheduled, it will wait until the running priority 2 job terminates even
1819 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1820 to run simultaneously.
1822 \item Suppose that bacula is running a priority 2 job and a new priority 1
1823 job is scheduled and queued waiting for the running priority 2 job to
1824 terminate. If you then start a second priority 2 job, the waiting
1825 priority 1 job will prevent the new priority 2 job from running
1826 concurrently with the running priority 2 job. That is: as long as there
1827 is a higher priority job waiting to run, no new lower priority jobs will
1828 start even if the Maximum Concurrent Jobs settings would normally allow
1829 them to run. This ensures that higher priority jobs will be run as soon
1833 If you have several jobs of different priority, it may not best to start
1834 them at exactly the same time, because Bacula must examine them one at a
1835 time. If by Bacula starts a lower priority job first, then it will run
1836 before your high priority jobs. If you experience this problem, you may
1837 avoid it by starting any higher priority jobs a few seconds before lower
1838 priority ones. This insures that Bacula will examine the jobs in the
1839 correct order, and that your priority scheme will be respected.
1841 \label{AllowMixedPriority}
1842 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1843 \index[dir]{Allow Mixed Priority}
1844 This directive is only implemented in version 2.5 and later. When
1845 set to {\bf yes} (default {\bf no}), this job may run even if lower
1846 priority jobs are already running. This means a high priority job
1847 will not have to wait for other jobs to finish before starting.
1848 The scheduler will only mix priorities when all running jobs have
1851 Note that only higher priority jobs will start early. Suppose the
1852 director will allow two concurrent jobs, and that two jobs with
1853 priority 10 are running, with two more in the queue. If a job with
1854 priority 5 is added to the queue, it will be run as soon as one of
1855 the running jobs finishes. However, new priority 10 jobs will not
1856 be run until the priority 5 job has finished.
1858 \label{WritePartAfterJob}
1859 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1860 \index[dir]{Write Part After Job}
1861 \index[dir]{Directive!Write Part After Job}
1862 This directive is only implemented in version 1.37 and later.
1863 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1864 will be created after the job is finished.
1866 It should be set to {\bf yes} when writing to devices that require mount
1867 (for example DVD), so you are sure that the current part, containing
1868 this job's data, is written to the device, and that no data is left in
1869 the temporary file on the hard disk. However, on some media, like DVD+R
1870 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1871 written. So, if you run several jobs each after another, you could set
1872 this directive to {\bf no} for all jobs, except the last one, to avoid
1873 wasting too much space, but to ensure that the data is written to the
1874 medium when all jobs are finished.
1876 This directive is ignored with tape and FIFO devices.
1880 The following is an example of a valid Job resource definition:
1887 Level = Incremental # default
1889 FileSet="Minou Full Set"
1892 Schedule = "MinouWeeklyCycle"
1898 \section{The JobDefs Resource}
1899 \label{JobDefsResource}
1900 \index[general]{JobDefs Resource}
1901 \index[general]{Resource!JobDefs}
1903 The JobDefs resource permits all the same directives that can appear in a Job
1904 resource. However, a JobDefs resource does not create a Job, rather it can be
1905 referenced within a Job to provide defaults for that Job. This permits you to
1906 concisely define several nearly identical Jobs, each one referencing a JobDefs
1907 resource which contains the defaults. Only the changes from the defaults need to
1908 be mentioned in each Job.
1910 \section{The Schedule Resource}
1911 \label{ScheduleResource}
1912 \index[general]{Resource!Schedule}
1913 \index[general]{Schedule Resource}
1915 The Schedule resource provides a means of automatically scheduling a Job as
1916 well as the ability to override the default Level, Pool, Storage and Messages
1917 resources. If a Schedule resource is not referenced in a Job, the Job can only
1918 be run manually. In general, you specify an action to be taken and when.
1923 \index[dir]{Schedule}
1924 \index[dir]{Directive!Schedule}
1925 Start of the Schedule directives. No {\bf Schedule} resource is
1926 required, but you will need at least one if you want Jobs to be
1927 automatically started.
1929 \item [Name = \lt{}name\gt{}]
1931 \index[dir]{Directive!Name}
1932 The name of the schedule being defined. The Name directive is required.
1934 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1936 \index[dir]{Directive!Run}
1937 The Run directive defines when a Job is to be run, and what overrides if
1938 any to apply. You may specify multiple {\bf run} directives within a
1939 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1940 multiple schedules). If you have two {\bf Run} directives that start at
1941 the same time, two Jobs will start at the same time (well, within one
1942 second of each other).
1944 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1945 Messages, and the Pool specifications provided in the Job resource. In
1946 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1947 specifications permit overriding the Pool specification according to
1948 what backup Job Level is in effect.
1950 By the use of overrides, you may customize a particular Job. For
1951 example, you may specify a Messages override for your Incremental
1952 backups that outputs messages to a log file, but for your weekly or
1953 monthly Full backups, you may send the output by email by using a
1954 different Messages override.
1956 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1957 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1958 or IncrementalPool, and the {\bf value} is as defined on the respective
1959 directive formats for the Job resource. You may specify multiple {\bf
1960 Job-overrides} on one {\bf Run} directive by separating them with one or
1961 more spaces or by separating them with a trailing comma. For example:
1967 \index[dir]{Directive!Level}
1968 is all files in the FileSet whether or not they have changed.
1970 \item [Level=Incremental]
1972 \index[dir]{Directive!Level}
1973 is all files that have changed since the last backup.
1977 \index[dir]{Directive!Pool}
1978 specifies to use the Pool named {\bf Weekly}.
1980 \item [Storage=DLT\_Drive]
1981 \index[dir]{Storage}
1982 \index[dir]{Directive!Storage}
1983 specifies to use {\bf DLT\_Drive} for the storage device.
1985 \item [Messages=Verbose]
1986 \index[dir]{Messages}
1987 \index[dir]{Directive!Messages}
1988 specifies to use the {\bf Verbose} message resource for the Job.
1990 \item [FullPool=Full]
1991 \index[dir]{FullPool}
1992 \index[dir]{Directive!FullPool}
1993 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1995 upgraded from another type to a full backup.
1997 \item [DifferentialPool=Differential]
1998 \index[dir]{DifferentialPool}
1999 \index[dir]{Directive!DifferentialPool}
2000 specifies to use the Pool named {\bf Differential} if the job is a
2001 differential backup.
2003 \item [IncrementalPool=Incremental]
2004 \index[dir]{IncrementalPool}
2005 \index[dir]{Directive!IncrementalPool}
2006 specifies to use the Pool named {\bf Incremental} if the job is an
2009 \item [SpoolData=yes\vb{}no]
2010 \index[dir]{SpoolData}
2011 \index[dir]{Directive!SpoolData}
2012 tells Bacula to request the Storage daemon to spool data to a disk file
2013 before writing it to the Volume (normally a tape). Thus the data is
2014 written in large blocks to the Volume rather than small blocks. This
2015 directive is particularly useful when running multiple simultaneous
2016 backups to tape. It prevents interleaving of the job data and reduces
2017 or eliminates tape drive stop and start commonly known as "shoe-shine".
2019 \item [SpoolSize={\it bytes}]
2020 \index[dir]{SpoolSize}
2021 \index[dir]{Directive!SpoolSize}
2022 where the bytes specify the maximum spool size for this job.
2023 The default is take from Device Maximum Spool Size limit.
2024 This directive is available only in Bacula version 2.3.5 or
2027 \item [WritePartAfterJob=yes\vb{}no]
2028 \index[dir]{WritePartAfterJob}
2029 \index[dir]{Directive!WritePartAfterJob}
2030 tells Bacula to request the Storage daemon to write the current part
2031 file to the device when the job is finished (see \ilink{Write Part After
2032 Job directive in the Job resource}{WritePartAfterJob}). Please note,
2033 this directive is implemented only in version 1.37 and later. The
2034 default is yes. We strongly recommend that you keep this set to yes
2035 otherwise, when the last job has finished one part will remain in the
2036 spool file and restore may or may not work.
2040 {\bf Date-time-specification} determines when the Job is to be run. The
2041 specification is a repetition, and as a default Bacula is set to run a job at
2042 the beginning of the hour of every hour of every day of every week of every
2043 month of every year. This is not normally what you want, so you must specify
2044 or limit when you want the job to run. Any specification given is assumed to
2045 be repetitive in nature and will serve to override or limit the default
2046 repetition. This is done by specifying masks or times for the hour, day of the
2047 month, day of the week, week of the month, week of the year, and month when
2048 you want the job to run. By specifying one or more of the above, you can
2049 define a schedule to repeat at almost any frequency you want.
2051 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
2052 minute} the Job is to be run. Of these four items to be specified, {\bf day}
2053 is special in that you may either specify a day of the month such as 1, 2,
2054 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
2055 Sunday. Finally, you may also specify a week qualifier to restrict the
2056 schedule to the first, second, third, fourth, or fifth week of the month.
2058 For example, if you specify only a day of the week, such as {\bf Tuesday} the
2059 Job will be run every hour of every Tuesday of every Month. That is the {\bf
2060 month} and {\bf hour} remain set to the defaults of every month and all
2063 Note, by default with no other specification, your job will run at the
2064 beginning of every hour. If you wish your job to run more than once in any
2065 given hour, you will need to specify multiple {\bf run} specifications each
2066 with a different minute.
2068 The date/time to run the Job can be specified in the following way in
2075 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
2076 second | third | fourth | fifth
2077 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
2078 sunday | monday | tuesday | wednesday |
2079 thursday | friday | saturday
2080 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2081 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
2082 aug | sep | oct | nov | dec | january |
2083 february | ... | december
2084 <daily-keyword> = daily
2085 <weekly-keyword> = weekly
2086 <monthly-keyword> = monthly
2087 <hourly-keyword> = hourly
2088 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2089 <number> = <digit> | <digit><number>
2090 <12hour> = 0 | 1 | 2 | ... 12
2091 <hour> = 0 | 1 | 2 | ... 23
2092 <minute> = 0 | 1 | 2 | ... 59
2093 <day> = 1 | 2 | ... 31
2094 <time> = <hour>:<minute> |
2095 <12hour>:<minute>am |
2097 <time-spec> = <at-keyword> <time> |
2099 <date-keyword> = <void-keyword> <weekly-keyword>
2100 <day-range> = <day>-<day>
2101 <month-range> = <month-keyword>-<month-keyword>
2102 <wday-range> = <wday-keyword>-<wday-keyword>
2103 <range> = <day-range> | <month-range> |
2105 <date> = <date-keyword> | <day> | <range>
2106 <date-spec> = <date> | <date-spec>
2107 <day-spec> = <day> | <wday-keyword> |
2108 <day> | <wday-range> |
2109 <week-keyword> <wday-keyword> |
2110 <week-keyword> <wday-range> |
2112 <month-spec> = <month-keyword> | <month-range> |
2114 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2120 Note, the Week of Year specification wnn follows the ISO standard definition
2121 of the week of the year, where Week 1 is the week in which the first Thursday
2122 of the year occurs, or alternatively, the week which contains the 4th of
2123 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2124 precedes the first ISO week (i.e. has the first few days of the year if any
2125 occur before Thursday). w00 is not defined by the ISO specification. A week
2126 starts with Monday and ends with Sunday.
2128 According to the NIST (US National Institute of Standards and Technology),
2129 12am and 12pm are ambiguous and can be defined to anything. However,
2130 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2131 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2132 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2133 am/pm). This is the definition in Bacula version 2.0.3 and later.
2135 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2136 with level full each Sunday at 2:05am and an incremental job Monday through
2137 Saturday at 2:05am is:
2142 Name = "WeeklyCycle"
2143 Run = Level=Full sun at 2:05
2144 Run = Level=Incremental mon-sat at 2:05
2149 An example of a possible monthly cycle is as follows:
2154 Name = "MonthlyCycle"
2155 Run = Level=Full Pool=Monthly 1st sun at 2:05
2156 Run = Level=Differential 2nd-5th sun at 2:05
2157 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2162 The first of every month:
2168 Run = Level=Full on 1 at 2:05
2169 Run = Level=Incremental on 2-31 at 2:05
2180 Run = Level=Full hourly at 0:05
2181 Run = Level=Full hourly at 0:15
2182 Run = Level=Full hourly at 0:25
2183 Run = Level=Full hourly at 0:35
2184 Run = Level=Full hourly at 0:45
2185 Run = Level=Full hourly at 0:55
2190 \section{Technical Notes on Schedules}
2191 \index[general]{Schedules!Technical Notes on}
2192 \index[general]{Technical Notes on Schedules}
2194 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2195 minute field to each schedule. The masks are hour, day of the month (mday),
2196 month, day of the week (wday), week of the month (wom), and week of the year
2197 (woy). The schedule is initialized to have the bits of each of these masks
2198 set, which means that at the beginning of every hour, the job will run. When
2199 you specify a month for the first time, the mask will be cleared and the bit
2200 corresponding to your selected month will be selected. If you specify a second
2201 month, the bit corresponding to it will also be added to the mask. Thus when
2202 Bacula checks the masks to see if the bits are set corresponding to the
2203 current time, your job will run only in the two months you have set. Likewise,
2204 if you set a time (hour), the hour mask will be cleared, and the hour you
2205 specify will be set in the bit mask and the minutes will be stored in the
2208 For any schedule you have defined, you can see how these bits are set by doing
2209 a {\bf show schedules} command in the Console program. Please note that the
2210 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2214 \section{The Client Resource}
2215 \label{ClientResource2}
2216 \index[general]{Resource!Client}
2217 \index[general]{Client Resource}
2219 The Client resource defines the attributes of the Clients that are served by
2220 this Director; that is the machines that are to be backed up. You will need
2221 one Client resource definition for each machine to be backed up.
2225 \item [Client (or FileDaemon)]
2226 \index[dir]{Client (or FileDaemon)}
2227 \index[dir]{Directive!Client (or FileDaemon)}
2228 Start of the Client directives.
2230 \item [Name = \lt{}name\gt{}]
2232 \index[dir]{Directive!Name}
2233 The client name which will be used in the Job resource directive or in the
2234 console run command. This directive is required.
2236 \item [Address = \lt{}address\gt{}]
2237 \index[dir]{Address}
2238 \index[dir]{Directive!FD Address}
2239 \index[dir]{File Daemon Address}
2240 \index[dir]{Client Address}
2241 Where the address is a host name, a fully qualified domain name, or a
2242 network address in dotted quad notation for a Bacula File server daemon.
2243 This directive is required.
2245 \item [FD Port = \lt{}port-number\gt{}]
2246 \index[dir]{FD Port}
2247 \index[dir]{Directive!FD Port}
2248 Where the port is a port number at which the Bacula File server daemon can
2249 be contacted. The default is 9102.
2251 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2252 \index[dir]{Catalog}
2253 \index[dir]{Directive!Catalog}
2254 This specifies the name of the catalog resource to be used for this Client.
2255 This directive is required.
2257 \item [Password = \lt{}password\gt{}]
2258 \index[dir]{Password}
2259 \index[dir]{Directive!Password}
2260 This is the password to be used when establishing a connection with the File
2261 services, so the Client configuration file on the machine to be backed up
2262 must have the same password defined for this Director. This directive is
2263 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2264 Bacula will generate a random password during the configuration process,
2265 otherwise it will be left blank.
2267 The password is plain text. It is not generated through any special
2268 process, but it is preferable for security reasons to make the text
2271 \label{FileRetention}
2272 \item [File Retention = \lt{}time-period-specification\gt{}]
2273 \label{FileRetention}
2274 \index[dir]{File Retention}
2275 \index[dir]{Directive!File Retention}
2276 The File Retention directive defines the length of time that Bacula will
2277 keep File records in the Catalog database after the End time of the
2278 Job corresponding to the File records.
2279 When this time period expires, and if
2280 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2281 that are older than the specified File Retention period. Note, this affects
2282 only records in the catalog database. It does not affect your archive
2285 File records may actually be retained for a shorter period than you specify
2286 on this directive if you specify either a shorter {\bf Job Retention} or a
2287 shorter {\bf Volume Retention} period. The shortest retention period of the
2288 three takes precedence. The time may be expressed in seconds, minutes,
2289 hours, days, weeks, months, quarters, or years. See the
2290 \ilink{ Configuration chapter}{Time} of this manual for
2291 additional details of time specification.
2293 The default is 60 days.
2295 \label{JobRetention}
2296 \item [Job Retention = \lt{}time-period-specification\gt{}]
2297 \label{JobRetention}
2298 \index[dir]{Job Retention}
2299 \index[dir]{Directive!Job Retention}
2300 The Job Retention directive defines the length of time that Bacula will keep
2301 Job records in the Catalog database after the Job End time. When
2302 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2303 Bacula will prune (remove) Job records that are older than the specified
2304 File Retention period. As with the other retention periods, this
2305 affects only records in the catalog and not data in your archive backup.
2307 If a Job record is selected for pruning, all associated File and JobMedia
2308 records will also be pruned regardless of the File Retention period set.
2309 As a consequence, you normally will set the File retention period to be
2310 less than the Job retention period. The Job retention period can actually
2311 be less than the value you specify here if you set the {\bf Volume
2312 Retention} directive in the Pool resource to a smaller duration. This is
2313 because the Job retention period and the Volume retention period are
2314 independently applied, so the smaller of the two takes precedence.
2316 The Job retention period is specified as seconds, minutes, hours, days,
2317 weeks, months, quarters, or years. See the
2318 \ilink{ Configuration chapter}{Time} of this manual for
2319 additional details of time specification.
2321 The default is 180 days.
2324 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2325 \index[dir]{AutoPrune}
2326 \index[dir]{Directive!AutoPrune}
2327 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2328 will automatically apply the File retention period and the Job retention
2329 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2330 pruning will not be done, and your Catalog will grow in size each time you
2331 run a Job. Pruning affects only information in the catalog and not data
2332 stored in the backup archives (on Volumes).
2334 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2335 \index[dir]{Maximum Concurrent Jobs}
2336 \index[dir]{Directive!Maximum Concurrent Jobs}
2337 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2338 that can run concurrently. Note, this directive limits only Jobs for Clients
2339 with the same name as the resource in which it appears. Any other
2340 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2341 Storage resources will also apply in addition to any limit specified here.
2342 The default is set to 1, but you may set it to a larger number.
2344 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2345 \index[dir]{Maximum Bandwidth Per Job}
2346 \index[dir]{Directive!Maximum Bandwidth Per Job}
2348 The speed parameter specifies the maximum allowed bandwidth that a job may use
2349 when started for this Client. The speed parameter should be specified in
2350 k/s, Kb/s, m/s or Mb/s.
2352 \item [Priority = \lt{}number\gt{}]
2353 \index[dir]{Priority}
2354 \index[dir]{Directive!Priority}
2355 The number specifies the priority of this client relative to other clients
2356 that the Director is processing simultaneously. The priority can range from
2357 1 to 1000. The clients are ordered such that the smaller number priorities
2358 are performed first (not currently implemented).
2361 The following is an example of a valid Client resource definition:
2367 FDAddress = minimatou
2369 Password = very_good
2374 \section{The Storage Resource}
2375 \label{StorageResource2}
2376 \index[general]{Resource!Storage}
2377 \index[general]{Storage Resource}
2379 The Storage resource defines which Storage daemons are available for use by
2385 \index[dir]{Storage}
2386 \index[dir]{Directive!Storage}
2387 Start of the Storage resources. At least one storage resource must be
2390 \item [Name = \lt{}name\gt{}]
2392 \index[dir]{Directive!Name}
2393 The name of the storage resource. This name appears on the Storage directive
2394 specified in the Job resource and is required.
2396 \item [Address = \lt{}address\gt{}]
2397 \index[dir]{Address}
2398 \index[dir]{Directive!SD Address}
2399 \index[dir]{Storage daemon Address}
2400 Where the address is a host name, a {\bf fully qualified domain name}, or an
2401 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2402 will be transmitted to the File daemon who will then use it to contact the
2403 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2404 the name but rather a fully qualified machine name or an IP address. This
2405 directive is required.
2407 \item [SD Port = \lt{}port\gt{}]
2408 \index[dir]{SD Port}
2409 \index[dir]{Directive!SD Port}
2410 Where port is the port to use to contact the storage daemon for information
2411 and to start jobs. This same port number must appear in the Storage resource
2412 of the Storage daemon's configuration file. The default is 9103.
2414 \item [Password = \lt{}password\gt{}]
2415 \index[dir]{Password}
2416 \index[dir]{Directive!Password}
2417 This is the password to be used when establishing a connection with the
2418 Storage services. This same password also must appear in the Director
2419 resource of the Storage daemon's configuration file. This directive is
2420 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2421 Bacula will generate a random password during the configuration process,
2422 otherwise it will be left blank.
2424 The password is plain text. It is not generated through any special
2425 process, but it is preferable for security reasons to use random text.
2427 \item [Device = \lt{}device-name\gt{}]
2429 \index[dir]{Directive!Device}
2430 This directive specifies the Storage daemon's name of the device
2431 resource to be used for the storage. If you are using an Autochanger,
2432 the name specified here should be the name of the Storage daemon's
2433 Autochanger resource rather than the name of an individual device. This
2434 name is not the physical device name, but the logical device name as
2435 defined on the {\bf Name} directive contained in the {\bf Device} or the
2436 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2437 configuration file. You can specify any name you would like (even the
2438 device name if you prefer) up to a maximum of 127 characters in length.
2439 The physical device name associated with this device is specified in the
2440 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2441 Please take care not to define two different Storage resource directives
2442 in the Director that point to the same Device in the Storage daemon.
2443 Doing so may cause the Storage daemon to block (or hang) attempting to
2444 open the same device that is already open. This directive is required.
2447 \item [Media Type = \lt{}MediaType\gt{}]
2448 \index[dir]{Media Type}
2449 \index[dir]{Directive!Media Type}
2450 This directive specifies the Media Type to be used to store the data.
2451 This is an arbitrary string of characters up to 127 maximum that you
2452 define. It can be anything you want. However, it is best to make it
2453 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2454 ...). In addition, it is essential that you make the {\bf Media Type}
2455 specification unique for each storage media type. If you have two DDS-4
2456 drives that have incompatible formats, or if you have a DDS-4 drive and
2457 a DDS-4 autochanger, you almost certainly should specify different {\bf
2458 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2459 associated with the Job, Bacula can decide to use any Storage daemon
2460 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2462 If you are writing to disk Volumes, you must make doubly sure that each
2463 Device resource defined in the Storage daemon (and hence in the
2464 Director's conf file) has a unique media type. Otherwise for Bacula
2465 versions 1.38 and older, your restores may not work because Bacula
2466 will assume that you can mount any Media Type with the same name on
2467 any Device associated with that Media Type. This is possible with
2468 tape drives, but with disk drives, unless you are very clever you
2469 cannot mount a Volume in any directory -- this can be done by creating
2470 an appropriate soft link.
2472 Currently Bacula permits only a single Media Type per Storage
2473 and Device definition. Consequently, if
2474 you have a drive that supports more than one Media Type, you can
2475 give a unique string to Volumes with different intrinsic Media
2476 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2477 those volumes will only be mounted on drives indicated with the
2478 dual type (DDS-3-4).
2480 If you want to tie Bacula to using a single Storage daemon or drive, you
2481 must specify a unique Media Type for that drive. This is an important
2482 point that should be carefully understood. Note, this applies equally
2483 to Disk Volumes. If you define more than one disk Device resource in
2484 your Storage daemon's conf file, the Volumes on those two devices are in
2485 fact incompatible because one can not be mounted on the other device
2486 since they are found in different directories. For this reason, you
2487 probably should use two different Media Types for your two disk Devices
2488 (even though you might think of them as both being File types). You can
2489 find more on this subject in the \ilink{Basic Volume
2490 Management}{DiskChapter} chapter of this manual.
2492 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2493 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2494 resource of the {\bf Storage daemon} configuration file. This directive
2495 is required, and it is used by the Director and the Storage daemon to
2496 ensure that a Volume automatically selected from the Pool corresponds to
2497 the physical device. If a Storage daemon handles multiple devices (e.g.
2498 will write to various file Volumes on different partitions), this
2499 directive allows you to specify exactly which device.
2501 As mentioned above, the value specified in the Director's Storage
2502 resource must agree with the value specified in the Device resource in
2503 the {\bf Storage daemon's} configuration file. It is also an additional
2504 check so that you don't try to write data for a DLT onto an 8mm device.
2506 \label{Autochanger1}
2507 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2508 \index[dir]{Autochanger}
2509 \index[dir]{Directive!Autochanger}
2510 If you specify {\bf yes} for this command (the default is {\bf no}),
2511 when you use the {\bf label} command or the {\bf add} command to create
2512 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2513 number. This simplifies creating database entries for Volumes in an
2514 autochanger. If you forget to specify the Slot, the autochanger will
2515 not be used. However, you may modify the Slot associated with a Volume
2516 at any time by using the {\bf update volume} or {\bf update slots}
2517 command in the console program. When {\bf autochanger} is enabled, the
2518 algorithm used by Bacula to search for available volumes will be
2519 modified to consider only Volumes that are known to be in the
2520 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2521 will attempt recycling, pruning, ..., and if still no volume is found,
2522 Bacula will search for any volume whether or not in the magazine. By
2523 privileging in changer volumes, this procedure minimizes operator
2524 intervention. The default is {\bf no}.
2526 For the autochanger to be used, you must also specify {\bf Autochanger =
2527 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2528 configuration file as well as other important Storage daemon
2529 configuration information. Please consult the \ilink{Using
2530 Autochangers}{AutochangersChapter} manual of this chapter for the
2531 details of using autochangers.
2533 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2534 \index[dir]{Maximum Concurrent Jobs}
2535 \index[dir]{Directive!Maximum Concurrent Jobs}
2536 where \lt{}number\gt{} is the maximum number of Jobs with the current
2537 Storage resource that can run concurrently. Note, this directive limits
2538 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2539 the maximum concurrent jobs such as in the Director, Job, or Client
2540 resources will also apply in addition to any limit specified here. The
2541 default is set to 1, but you may set it to a larger number. However, if
2542 you set the Storage daemon's number of concurrent jobs greater than one,
2543 we recommend that you read the waring documented under \ilink{Maximum
2544 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2545 turn data spooling on as documented in the \ilink{Data
2546 Spooling}{SpoolingChapter} chapter of this manual.
2548 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2549 \label{AllowCompression}
2550 \index[dir]{AllowCompression}
2551 \index[dir]{Directive!AllowCompression}
2553 This directive is optional, and if you specify {\bf No} (the default is {\bf
2554 Yes}), it will cause backups jobs running on this storage resource to run
2555 without client File Daemon compression. This effectively overrides
2556 compression options in FileSets used by jobs which use this storage
2559 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2560 \index[dir]{Heartbeat Interval}
2561 \index[dir]{Directive!Heartbeat}
2562 This directive is optional and if specified will cause the Director to
2563 set a keepalive interval (heartbeat) in seconds on each of the sockets
2564 it opens for the Storage resource. This value will override any
2565 specified at the Director level. It is implemented only on systems
2566 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2567 The default value is zero, which means no change is made to the socket.
2571 The following is an example of a valid Storage resource definition:
2575 # Definition of tape storage device
2579 Password = storage_password # password for Storage daemon
2580 Device = "HP DLT 80" # same as Device in Storage daemon
2581 Media Type = DLT8000 # same as MediaType in Storage daemon
2586 \section{The Pool Resource}
2587 \label{PoolResource}
2588 \index[general]{Resource!Pool}
2589 \index[general]{Pool Resource}
2591 The Pool resource defines the set of storage Volumes (tapes or files) to be
2592 used by Bacula to write the data. By configuring different Pools, you can
2593 determine which set of Volumes (media) receives the backup data. This permits,
2594 for example, to store all full backup data on one set of Volumes and all
2595 incremental backups on another set of Volumes. Alternatively, you could assign
2596 a different set of Volumes to each machine that you backup. This is most
2597 easily done by defining multiple Pools.
2599 Another important aspect of a Pool is that it contains the default attributes
2600 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2601 Volume when it is created. This avoids the need for you to answer a large
2602 number of questions when labeling a new Volume. Each of these attributes can
2603 later be changed on a Volume by Volume basis using the {\bf update} command in
2604 the console program. Note that you must explicitly specify which Pool Bacula
2605 is to use with each Job. Bacula will not automatically search for the correct
2608 Most often in Bacula installations all backups for all machines (Clients) go
2609 to a single set of Volumes. In this case, you will probably only use the {\bf
2610 Default} Pool. If your backup strategy calls for you to mount a different tape
2611 each day, you will probably want to define a separate Pool for each day. For
2612 more information on this subject, please see the
2613 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2617 To use a Pool, there are three distinct steps. First the Pool must be defined
2618 in the Director's configuration file. Then the Pool must be written to the
2619 Catalog database. This is done automatically by the Director each time that it
2620 starts, or alternatively can be done using the {\bf create} command in the
2621 console program. Finally, if you change the Pool definition in the Director's
2622 configuration file and restart Bacula, the pool will be updated alternatively
2623 you can use the {\bf update pool} console command to refresh the database
2624 image. It is this database image rather than the Director's resource image
2625 that is used for the default Volume attributes. Note, for the pool to be
2626 automatically created or updated, it must be explicitly referenced by a Job
2629 Next the physical media must be labeled. The labeling can either be done with
2630 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2631 program. The preferred method is to use the {\bf label} command in the {\bf
2634 Finally, you must add Volume names (and their attributes) to the Pool. For
2635 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2636 archive device specified for the job (i.e. if you are going to back up to a
2637 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2638 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2639 are backing up to files. When running a Job, you must explicitly specify which
2640 Pool to use. Bacula will then automatically select the next Volume to use from
2641 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2642 from the Pool is identical to that required by the Storage resource you have
2643 specified for the Job.
2645 If you use the {\bf label} command in the console program to label the
2646 Volumes, they will automatically be added to the Pool, so this last step is
2647 not normally required.
2649 It is also possible to add Volumes to the database without explicitly labeling
2650 the physical volume. This is done with the {\bf add} console command.
2652 As previously mentioned, each time Bacula starts, it scans all the Pools
2653 associated with each Catalog, and if the database record does not already
2654 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2655 probably should do an {\bf update pool} if you change the Pool definition, but
2656 currently, you must do this manually using the {\bf update pool} command in
2657 the Console program.
2659 The Pool Resource defined in the Director's configuration file
2660 (bacula-dir.conf) may contain the following directives:
2666 \index[dir]{Directive!Pool}
2667 Start of the Pool resource. There must be at least one Pool resource
2671 \item [Name = \lt{}name\gt{}]
2673 \index[dir]{Directive!Name}
2674 The name of the pool. For most applications, you will use the default
2675 pool name {\bf Default}. This directive is required.
2678 \item [Maximum Volumes = \lt{}number\gt{}]
2679 \index[dir]{Maximum Volumes}
2680 \index[dir]{Directive!Maximum Volumes}
2681 This directive specifies the maximum number of volumes (tapes or files)
2682 contained in the pool. This directive is optional, if omitted or set to
2683 zero, any number of volumes will be permitted. In general, this
2684 directive is useful for Autochangers where there is a fixed number of
2685 Volumes, or for File storage where you wish to ensure that the backups
2686 made to disk files do not become too numerous or consume too much space.
2688 \item [Pool Type = \lt{}type\gt{}]
2689 \index[dir]{Pool Type}
2690 \index[dir]{Directive!Pool Type}
2691 This directive defines the pool type, which corresponds to the type of
2692 Job being run. It is required and may be one of the following:
2702 Note, only Backup is current implemented.
2704 \item [Storage = \lt{}storage-resource-name\gt{}]
2705 \index[dir]{Storage}
2706 \index[dir]{Directive!Storage}
2707 The Storage directive defines the name of the storage services where you
2708 want to backup the FileSet data. For additional details, see the
2709 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2710 The Storage resource may also be specified in the Job resource,
2711 but the value, if any, in the Pool resource overrides any value
2712 in the Job. This Storage resource definition is not required by either
2713 the Job resource or in the Pool, but it must be specified in
2714 one or the other. If not configuration error will result.
2716 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2717 \index[dir]{Use Volume Once}
2718 \index[dir]{Directive!Use Volume Once}
2719 This directive if set to {\bf yes} specifies that each volume is to be
2720 used only once. This is most useful when the Media is a file and you
2721 want a new file for each backup that is done. The default is {\bf no}
2722 (i.e. use volume any number of times). This directive will most likely
2723 be phased out (deprecated), so you are recommended to use {\bf Maximum
2724 Volume Jobs = 1} instead.
2726 The value defined by this directive in the bacula-dir.conf file is the
2727 default value used when a Volume is created. Once the volume is
2728 created, changing the value in the bacula-dir.conf file will not change
2729 what is stored for the Volume. To change the value for an existing
2730 Volume you must use the {\bf update} command in the Console.
2732 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2733 using this directive with multiple simultaneous jobs.
2735 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2736 \index[dir]{Maximum Volume Jobs}
2737 \index[dir]{Directive!Maximum Volume Jobs}
2738 This directive specifies the maximum number of Jobs that can be written
2739 to the Volume. If you specify zero (the default), there is no limit.
2740 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2741 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2742 is marked {\bf Used} it can no longer be used for appending Jobs, much
2743 like the {\bf Full} status but it can be recycled if recycling is
2744 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2745 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2747 The value defined by this directive in the bacula-dir.conf
2748 file is the default value used when a Volume is created. Once the volume is
2749 created, changing the value in the bacula-dir.conf file will not change what
2750 is stored for the Volume. To change the value for an existing Volume you
2751 must use the {\bf update} command in the Console.
2753 If you are running multiple simultaneous jobs, this directive may not
2754 work correctly because when a drive is reserved for a job, this
2755 directive is not taken into account, so multiple jobs may try to
2756 start writing to the Volume. At some point, when the Media record is
2757 updated, multiple simultaneous jobs may fail since the Volume can no
2760 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2761 \index[dir]{Maximum Volume Files}
2762 \index[dir]{Directive!Maximum Volume Files}
2763 This directive specifies the maximum number of files that can be written
2764 to the Volume. If you specify zero (the default), there is no limit.
2765 Otherwise, when the number of files written to the Volume equals {\bf
2766 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2767 is marked {\bf Used} it can no longer be used for appending Jobs, much
2768 like the {\bf Full} status but it can be recycled if recycling is
2769 enabled and thus used again. This value is checked and the {\bf Used}
2770 status is set only at the end of a job that writes to the particular
2773 The value defined by this directive in the bacula-dir.conf file is the
2774 default value used when a Volume is created. Once the volume is
2775 created, changing the value in the bacula-dir.conf file will not change
2776 what is stored for the Volume. To change the value for an existing
2777 Volume you must use the {\bf update} command in the Console.
2779 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2780 \index[dir]{Maximum Volume Bytes}
2781 \index[dir]{Directive!Maximum Volume Bytes}
2782 This directive specifies the maximum number of bytes that can be written
2783 to the Volume. If you specify zero (the default), there is no limit
2784 except the physical size of the Volume. Otherwise, when the number of
2785 bytes written to the Volume equals {\bf size} the Volume will be marked
2786 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2787 used for appending Jobs, much like the {\bf Full} status but it can be
2788 recycled if recycling is enabled, and thus the Volume can be re-used
2789 after recycling. This value is checked and the {\bf Used} status set
2790 while the job is writing to the particular volume.
2792 This directive is particularly useful for restricting the size
2793 of disk volumes, and will work correctly even in the case of
2794 multiple simultaneous jobs writing to the volume.
2796 The value defined by this directive in the bacula-dir.conf file is the
2797 default value used when a Volume is created. Once the volume is
2798 created, changing the value in the bacula-dir.conf file will not change
2799 what is stored for the Volume. To change the value for an existing
2800 Volume you must use the {\bf update} command in the Console.
2802 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2803 \index[dir]{Volume Use Duration}
2804 \index[dir]{Directive!Volume Use Duration}
2805 The Volume Use Duration directive defines the time period that the
2806 Volume can be written beginning from the time of first data write to the
2807 Volume. If the time-period specified is zero (the default), the Volume
2808 can be written indefinitely. Otherwise, the next time a job
2809 runs that wants to access this Volume, and the time period from the
2810 first write to the volume (the first Job written) exceeds the
2811 time-period-specification, the Volume will be marked {\bf Used}, which
2812 means that no more Jobs can be appended to the Volume, but it may be
2813 recycled if recycling is enabled. Using the command {\bf
2814 status dir} applies algorithms similar to running jobs, so
2815 during such a command, the Volume status may also be changed.
2817 recycled, it will be available for use again.
2819 You might use this directive, for example, if you have a Volume used for
2820 Incremental backups, and Volumes used for Weekly Full backups. Once the
2821 Full backup is done, you will want to use a different Incremental
2822 Volume. This can be accomplished by setting the Volume Use Duration for
2823 the Incremental Volume to six days. I.e. it will be used for the 6
2824 days following a Full save, then a different Incremental volume will be
2825 used. Be careful about setting the duration to short periods such as 23
2826 hours, or you might experience problems of Bacula waiting for a tape
2827 over the weekend only to complete the backups Monday morning when an
2828 operator mounts a new tape.
2830 The use duration is checked and the {\bf Used} status is set only at the
2831 end of a job that writes to the particular volume, which means that even
2832 though the use duration may have expired, the catalog entry will not be
2833 updated until the next job that uses this volume is run. This
2834 directive is not intended to be used to limit volume sizes
2835 and will not work correctly (i.e. will fail jobs) if the use
2836 duration expires while multiple simultaneous jobs are writing
2839 Please note that the value defined by this directive in the bacula-dir.conf
2840 file is the default value used when a Volume is created. Once the volume is
2841 created, changing the value in the bacula-dir.conf file will not change what
2842 is stored for the Volume. To change the value for an existing Volume you
2844 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2846 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
2847 \index[dir]{Catalog Files}
2848 \index[dir]{Directive!Catalog Files}
2849 This directive defines whether or not you want the names of the files
2850 that were saved to be put into the catalog. The default is {\bf yes}.
2851 The advantage of specifying {\bf Catalog Files = No} is that you will
2852 have a significantly smaller Catalog database. The disadvantage is that
2853 you will not be able to produce a Catalog listing of the files backed up
2854 for each Job (this is often called Browsing). Also, without the File
2855 entries in the catalog, you will not be able to use the Console {\bf
2856 restore} command nor any other command that references File entries.
2858 \label{PoolAutoPrune}
2859 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2860 \index[dir]{AutoPrune}
2861 \index[dir]{Directive!AutoPrune}
2862 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2863 greater) will automatically apply the Volume Retention period when new
2864 Volume is needed and no appendable Volumes exist in the Pool. Volume
2865 pruning causes expired Jobs (older than the {\bf Volume Retention}
2866 period) to be deleted from the Catalog and permits possible recycling of
2869 \label{VolRetention}
2870 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2871 \index[dir]{Volume Retention}
2872 \index[dir]{Directive!Volume Retention}
2873 The Volume Retention directive defines the length of time that {\bf
2874 Bacula} will keep records associated with the Volume in
2875 the Catalog database after the End time of each Job written to the
2876 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2877 {\bf yes} Bacula may prune (remove) Job records that are older than the
2878 specified Volume Retention period if it is necessary to free up a
2879 Volume. Recycling will not occur until it is absolutely necessary to
2880 free up a volume (i.e. no other writable volume exists).
2881 All File records associated with pruned Jobs are also
2882 pruned. The time may be specified as seconds, minutes, hours, days,
2883 weeks, months, quarters, or years. The {\bf Volume Retention} is
2884 applied independently of the {\bf Job Retention} and the {\bf File
2885 Retention} periods defined in the Client resource. This means that all
2886 the retentions periods are applied in turn and that the shorter period
2887 is the one that effectively takes precedence. Note, that when the {\bf
2888 Volume Retention} period has been reached, and it is necessary to obtain
2889 a new volume, Bacula will prune both the Job and the File records. This
2890 pruning could also occur during a {\bf status dir} command because it
2891 uses similar algorithms for finding the next available Volume.
2893 It is important to know that when the Volume Retention period expires,
2894 Bacula does not automatically recycle a Volume. It attempts to keep the
2895 Volume data intact as long as possible before over writing the Volume.
2897 By defining multiple Pools with different Volume Retention periods, you
2898 may effectively have a set of tapes that is recycled weekly, another
2899 Pool of tapes that is recycled monthly and so on. However, one must
2900 keep in mind that if your {\bf Volume Retention} period is too short, it
2901 may prune the last valid Full backup, and hence until the next Full
2902 backup is done, you will not have a complete backup of your system, and
2903 in addition, the next Incremental or Differential backup will be
2904 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2905 Retention} period should be at twice the interval of your Full backups.
2906 This means that if you do a Full backup once a month, the minimum Volume
2907 retention period should be two months.
2909 The default Volume retention period is 365 days, and either the default
2910 or the value defined by this directive in the bacula-dir.conf file is
2911 the default value used when a Volume is created. Once the volume is
2912 created, changing the value in the bacula-dir.conf file will not change
2913 what is stored for the Volume. To change the value for an existing
2914 Volume you must use the {\bf update} command in the Console.
2916 \item [Action On Purge = \lt{Truncate}]
2917 \index[dir]{actiononpurge}
2919 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
2920 volume when it is purged with the \texttt{purge volume action=truncate}
2921 command. It is useful to prevent disk based volumes from consuming too much
2927 Action On Purge = Truncate
2932 You can schedule the truncate operation at the end of your CatalogBackup job
2933 like in this example:
2937 Name = CatalogBackup
2942 Console = "purge volume action=all allpools storage=File"
2947 \label{PoolScratchPool}
2948 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
2949 \index[dir]{ScrachPool}
2950 \index[dir]{Directive!ScrachPool}
2951 This directive permits to specify a dedicate \textsl{Scratch} for the
2952 current pool. This pool will replace the special pool named \textsl{Scrach}
2953 for volume selection. For more information about \textsl{Scratch} see
2954 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
2955 when using multiple storage sharing the same mediatype or when you want to
2956 dedicate volumes to a particular set of pool.
2958 \label{PoolRecyclePool}
2959 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2960 \index[dir]{RecyclePool}
2961 \index[dir]{Directive!RecyclePool}
2962 This directive defines to which pool
2963 the Volume will be placed (moved) when it is recycled. Without
2964 this directive, a Volume will remain in the same pool when it is
2965 recycled. With this directive, it can be moved automatically to any
2966 existing pool during a recycle. This directive is probably most
2967 useful when defined in the Scratch pool, so that volumes will
2968 be recycled back into the Scratch pool. For more on the see the
2969 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2971 Although this directive is called RecyclePool, the Volume in
2972 question is actually moved from its current pool to the one
2973 you specify on this directive when Bacula prunes the Volume and
2974 discovers that there are no records left in the catalog and hence
2975 marks it as {\bf Purged}.
2979 \item [Recycle = \lt{}yes\vb{}no\gt{}]
2980 \index[dir]{Recycle}
2981 \index[dir]{Directive!Recycle}
2982 This directive specifies whether or not Purged Volumes may be recycled.
2983 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2984 none that are appendable, it will search for and recycle (reuse) Purged
2985 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2986 deleted from the Catalog). If the Volume is recycled, all previous data
2987 written to that Volume will be overwritten. If Recycle is set to {\bf
2988 no}, the Volume will not be recycled, and hence, the data will remain
2989 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2990 is no (0 in the catalog), you may manually set the recycle flag (update
2991 command) for a Volume to be reused.
2993 Please note that the value defined by this directive in the
2994 bacula-dir.conf file is the default value used when a Volume is created.
2995 Once the volume is created, changing the value in the bacula-dir.conf
2996 file will not change what is stored for the Volume. To change the value
2997 for an existing Volume you must use the {\bf update} command in the
3000 When all Job and File records have been pruned or purged from the
3001 catalog for a particular Volume, if that Volume is marked as
3002 Append, Full, Used, or Error, it will then be marked as Purged. Only
3003 Volumes marked as Purged will be considered to be converted to the
3004 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
3007 \label{RecycleOldest}
3008 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
3009 \index[dir]{Recycle Oldest Volume}
3010 \index[dir]{Directive!Recycle Oldest Volume}
3011 This directive instructs the Director to search for the oldest used
3012 Volume in the Pool when another Volume is requested by the Storage
3013 daemon and none are available. The catalog is then {\bf pruned}
3014 respecting the retention periods of all Files and Jobs written to this
3015 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
3016 Volume is recycled and will be used as the next Volume to be written.
3017 This directive respects any Job, File, or Volume retention periods that
3018 you may have specified, and as such it is {\bf much} better to use this
3019 directive than the Purge Oldest Volume.
3021 This directive can be useful if you have a fixed number of Volumes in the
3022 Pool and you want to cycle through them and you have specified the correct
3025 However, if you use this directive and have only one
3026 Volume in the Pool, you will immediately recycle your Volume if you fill
3027 it and Bacula needs another one. Thus your backup will be totally invalid.
3028 Please use this directive with care. The default is {\bf no}.
3030 \label{RecycleCurrent}
3032 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3033 \index[dir]{Recycle Current Volume}
3034 \index[dir]{Directive!Recycle Current Volume}
3035 If Bacula needs a new Volume, this directive instructs Bacula to Prune
3036 the volume respecting the Job and File retention periods. If all Jobs
3037 are pruned (i.e. the volume is Purged), then the Volume is recycled and
3038 will be used as the next Volume to be written. This directive respects
3039 any Job, File, or Volume retention periods that you may have specified,
3040 and thus it is {\bf much} better to use it rather than the Purge Oldest
3043 This directive can be useful if you have: a fixed number of Volumes in
3044 the Pool, you want to cycle through them, and you have specified
3045 retention periods that prune Volumes before you have cycled through the
3048 However, if you use this directive and have only one Volume in the Pool,
3049 you will immediately recycle your Volume if you fill it and Bacula needs
3050 another one. Thus your backup will be totally invalid. Please use this
3051 directive with care. The default is {\bf no}.
3055 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3056 \index[dir]{Purge Oldest Volume}
3057 \index[dir]{Directive!Purge Oldest Volume}
3058 This directive instructs the Director to search for the oldest used
3059 Volume in the Pool when another Volume is requested by the Storage
3060 daemon and none are available. The catalog is then {\bf purged}
3061 irrespective of retention periods of all Files and Jobs written to this
3062 Volume. The Volume is then recycled and will be used as the next Volume
3063 to be written. This directive overrides any Job, File, or Volume
3064 retention periods that you may have specified.
3066 This directive can be useful if you have a fixed number of Volumes in
3067 the Pool and you want to cycle through them and reusing the oldest one
3068 when all Volumes are full, but you don't want to worry about setting
3069 proper retention periods. However, by using this option you risk losing
3072 Please be aware that {\bf Purge Oldest Volume} disregards all retention
3073 periods. If you have only a single Volume defined and you turn this
3074 variable on, that Volume will always be immediately overwritten when it
3075 fills! So at a minimum, ensure that you have a decent number of Volumes
3076 in your Pool before running any jobs. If you want retention periods to
3077 apply do not use this directive. To specify a retention period, use the
3078 {\bf Volume Retention} directive (see above).
3080 We {\bf highly} recommend against using this directive, because it is
3081 sure that some day, Bacula will recycle a Volume that contains current
3082 data. The default is {\bf no}.
3084 \item [File Retention = \lt{}time-period-specification\gt{}]
3085 \index[dir]{File Retention}
3086 \index[dir]{Directive!File Retention}
3087 The File Retention directive defines the length of time that Bacula will
3088 keep File records in the Catalog database after the End time of the
3089 Job corresponding to the File records.
3091 This directive takes precedence over Client directives of the same name. For
3092 example, you can decide to increase Retention times for Archive or OffSite
3095 Note, this affects only records in the catalog database. It does not affect
3096 your archive backups.
3098 For more information see Client documentation about
3099 \ilink{FileRetention}{FileRetention}
3101 \item [Job Retention = \lt{}time-period-specification\gt{}]
3102 \index[dir]{Job Retention}
3103 \index[dir]{Directive!Job Retention}
3105 The Job Retention directive defines the length of time that Bacula will keep
3106 Job records in the Catalog database after the Job End time. As with the
3107 other retention periods, this affects only records in the catalog and not
3108 data in your archive backup.
3110 This directive takes precedence over Client directives of the same name.
3111 For example, you can decide to increase Retention times for Archive or
3114 For more information see Client side documentation
3115 \ilink{JobRetention}{JobRetention}
3117 \item [Cleaning Prefix = \lt{}string\gt{}]
3118 \index[dir]{Cleaning Prefix}
3119 \index[dir]{Directive!Cleaning Prefix}
3120 This directive defines a prefix string, which if it matches the
3121 beginning of a Volume name during labeling of a Volume, the Volume will
3122 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3123 never attempt to use this tape. This is primarily for use with
3124 autochangers that accept barcodes where the convention is that barcodes
3125 beginning with {\bf CLN} are treated as cleaning tapes.
3128 \item [Label Format = \lt{}format\gt{}]
3129 \index[dir]{Label Format}
3130 \index[dir]{Directive!Label Format}
3131 This directive specifies the format of the labels contained in this
3132 pool. The format directive is used as a sort of template to create new
3133 Volume names during automatic Volume labeling.
3135 The {\bf format} should be specified in double quotes, and consists of
3136 letters, numbers and the special characters hyphen ({\bf -}), underscore
3137 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3138 characters for a Volume name. The {\bf format} should be enclosed in
3141 In addition, the format may contain a number of variable expansion
3142 characters which will be expanded by a complex algorithm allowing you to
3143 create Volume names of many different formats. In all cases, the
3144 expansion process must resolve to the set of characters noted above that
3145 are legal Volume names. Generally, these variable expansion characters
3146 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
3147 specify variable expansion characters, you should always enclose the
3148 format with double quote characters ({\bf "}). For more details on
3149 variable expansion, please see the \ilink{Variable
3150 Expansion}{VarsChapter} Chapter of this manual.
3152 If no variable expansion characters are found in the string, the Volume
3153 name will be formed from the {\bf format} string appended with the
3154 a unique number that increases. If you do not remove volumes from the
3155 pool, this number should be the number of volumes plus one, but this
3156 is not guaranteed. The unique number will be edited as four
3157 digits with leading zeros. For example, with a {\bf Label Format =
3158 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3161 With the exception of Job specific variables, you can test your {\bf
3162 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
3165 In almost all cases, you should enclose the format specification (part
3166 after the equal sign) in double quotes. Please note that this directive
3167 is deprecated and is replaced in version 1.37 and greater with a Python
3168 script for creating volume names.
3172 In order for a Pool to be used during a Backup Job, the Pool must have at
3173 least one Volume associated with it. Volumes are created for a Pool using
3174 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3175 program. In addition to adding Volumes to the Pool (i.e. putting the
3176 Volume names in the Catalog database), the physical Volume must be labeled
3177 with a valid Bacula software volume label before {\bf Bacula} will accept
3178 the Volume. This will be automatically done if you use the {\bf label}
3179 command. Bacula can automatically label Volumes if instructed to do so,
3180 but this feature is not yet fully implemented.
3182 The following is an example of a valid Pool resource definition:
3194 \subsection{The Scratch Pool}
3195 \label{TheScratchPool}
3196 \index[general]{Scratch Pool}
3197 In general, you can give your Pools any name you wish, but there is one
3198 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3199 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3200 writing and it cannot find one, it will look in the Scratch pool, and if
3201 it finds an available Volume, it will move it out of the Scratch pool into
3202 the Pool currently being used by the job.
3205 \section{The Catalog Resource}
3206 \label{CatalogResource}
3207 \index[general]{Resource!Catalog}
3208 \index[general]{Catalog Resource}
3210 The Catalog Resource defines what catalog to use for the current job.
3211 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3212 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3213 may be as many Catalogs (databases) defined as you wish. For example, you
3214 may want each Client to have its own Catalog database, or you may want
3215 backup jobs to use one database and verify or restore jobs to use another
3218 Since SQLite is compiled in, it always runs on the same machine
3219 as the Director and the database must be directly accessible (mounted) from
3220 the Director. However, since both MySQL and PostgreSQL are networked
3221 databases, they may reside either on the same machine as the Director
3222 or on a different machine on the network. See below for more details.
3227 \index[dir]{Catalog}
3228 \index[dir]{Directive!Catalog}
3229 Start of the Catalog resource. At least one Catalog resource must be
3233 \item [Name = \lt{}name\gt{}]
3235 \index[dir]{Directive!Name}
3236 The name of the Catalog. No necessary relation to the database server
3237 name. This name will be specified in the Client resource directive
3238 indicating that all catalog data for that Client is maintained in this
3239 Catalog. This directive is required.
3241 \item [password = \lt{}password\gt{}]
3242 \index[dir]{password}
3243 \index[dir]{Directive!password}
3244 This specifies the password to use when logging into the database. This
3245 directive is required.
3247 \item [DB Name = \lt{}name\gt{}]
3248 \index[dir]{DB Name}
3249 \index[dir]{Directive!DB Name}
3250 This specifies the name of the database. If you use multiple catalogs
3251 (databases), you specify which one here. If you are using an external
3252 database server rather than the internal one, you must specify a name
3253 that is known to the server (i.e. you explicitly created the Bacula
3254 tables using this name. This directive is required.
3256 \item [user = \lt{}user\gt{}]
3258 \index[dir]{Directive!user}
3259 This specifies what user name to use to log into the database. This
3260 directive is required.
3262 \item [DB Socket = \lt{}socket-name\gt{}]
3263 \index[dir]{DB Socket}
3264 \index[dir]{Directive!DB Socket}
3265 This is the name of a socket to use on the local host to connect to the
3266 database. This directive is used only by MySQL and is ignored by SQLite.
3267 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3268 will use the default socket. If the DB Socket is specified, the
3269 MySQL server must reside on the same machine as the Director.
3271 \item [DB Address = \lt{}address\gt{}]
3272 \index[dir]{DB Address}
3273 \index[dir]{Directive!DB Address}
3274 This is the host address of the database server. Normally, you would specify
3275 this instead of {\bf DB Socket} if the database server is on another machine.
3276 In that case, you will also specify {\bf DB Port}. This directive is used
3277 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3278 This directive is optional.
3280 \item [DB Port = \lt{}port\gt{}]
3281 \index[dir]{DB Port}
3282 \index[dir]{Directive!DB Port}
3283 This defines the port to be used in conjunction with {\bf DB Address} to
3284 access the database if it is on another machine. This directive is used only
3285 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3286 directive is optional.
3288 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3289 %% \index[dir]{Multiple Connections}
3290 %% \index[dir]{Directive!Multiple Connections}
3291 %% By default, this directive is set to no. In that case, each job that uses
3293 %% same Catalog will use a single connection to the catalog. It will be shared,
3294 %% and Bacula will allow only one Job at a time to communicate. If you set this
3295 %% directive to yes, Bacula will permit multiple connections to the database,
3296 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3297 %% this is no problem. For MySQL, you must be *very* careful to have the
3298 %% multi-thread version of the client library loaded on your system. When this
3299 %% directive is set yes, each Job will have a separate connection to the
3300 %% database, and the database will control the interaction between the
3302 %% Jobs. This can significantly speed up the database operations if you are
3303 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3304 %% Bacula will automatically enable transactions. This can significantly speed
3305 %% up insertion of attributes in the database either for a single Job or
3306 %% multiple simultaneous Jobs.
3308 %% This directive has not been tested. Please test carefully before running it
3309 %% in production and report back your results.
3313 The following is an example of a valid Catalog resource definition:
3322 password = "" # no password = no security
3327 or for a Catalog on another machine:
3337 DB Address = remote.acme.com
3343 \section{The Messages Resource}
3344 \label{MessagesResource2}
3345 \index[general]{Resource!Messages}
3346 \index[general]{Messages Resource}
3348 For the details of the Messages Resource, please see the
3349 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3352 \section{The Console Resource}
3353 \label{ConsoleResource1}
3354 \index[general]{Console Resource}
3355 \index[general]{Resource!Console}
3357 As of Bacula version 1.33 and higher, there are three different kinds of
3358 consoles, which the administrator or user can use to interact with the
3359 Director. These three kinds of consoles comprise three different security
3363 \item The first console type is an {\bf anonymous} or {\bf default} console,
3364 which has full privileges. There is no console resource necessary for
3365 this type since the password is specified in the Director's resource and
3366 consequently such consoles do not have a name as defined on a {\bf Name
3367 =} directive. This is the kind of console that was initially
3368 implemented in versions prior to 1.33 and remains valid. Typically you
3369 would use it only for administrators.
3371 \item The second type of console, and new to version 1.33 and higher is a
3372 "named" console defined within a Console resource in both the Director's
3373 configuration file and in the Console's configuration file. Both the
3374 names and the passwords in these two entries must match much as is the
3375 case for Client programs.
3377 This second type of console begins with absolutely no privileges except
3378 those explicitly specified in the Director's Console resource. Thus you
3379 can have multiple Consoles with different names and passwords, sort of
3380 like multiple users, each with different privileges. As a default,
3381 these consoles can do absolutely nothing -- no commands whatsoever. You
3382 give them privileges or rather access to commands and resources by
3383 specifying access control lists in the Director's Console resource. The
3384 ACLs are specified by a directive followed by a list of access names.
3385 Examples of this are shown below.
3387 \item The third type of console is similar to the above mentioned one in that
3388 it requires a Console resource definition in both the Director and the
3389 Console. In addition, if the console name, provided on the {\bf Name =}
3390 directive, is the same as a Client name, that console is permitted to
3391 use the {\bf SetIP} command to change the Address directive in the
3392 Director's client resource to the IP address of the Console. This
3393 permits portables or other machines using DHCP (non-fixed IP addresses)
3394 to "notify" the Director of their current IP address.
3397 The Console resource is optional and need not be specified. The following
3398 directives are permitted within the Director's configuration resource:
3402 \item [Name = \lt{}name\gt{}]
3404 \index[dir]{Directive!Name}
3405 The name of the console. This name must match the name specified in the
3406 Console's configuration resource (much as is the case with Client
3409 \item [Password = \lt{}password\gt{}]
3410 \index[dir]{Password}
3411 \index[dir]{Directive!Password}
3412 Specifies the password that must be supplied for a named Bacula Console
3413 to be authorized. The same password must appear in the {\bf Console}
3414 resource of the Console configuration file. For added security, the
3415 password is never actually passed across the network but rather a
3416 challenge response hash code created with the password. This directive
3417 is required. If you have either {\bf /dev/random} {\bf bc} on your
3418 machine, Bacula will generate a random password during the configuration
3419 process, otherwise it will be left blank.
3421 The password is plain text. It is not generated through any special
3422 process. However, it is preferable for security reasons to choose
3425 \item [JobACL = \lt{}name-list\gt{}]
3427 \index[dir]{Directive!JobACL}
3428 This directive is used to specify a list of Job resource names that can
3429 be accessed by the console. Without this directive, the console cannot
3430 access any of the Director's Job resources. Multiple Job resource names
3431 may be specified by separating them with commas, and/or by specifying
3432 multiple JobACL directives. For example, the directive may be specified
3437 JobACL = kernsave, "Backup client 1", "Backup client 2"
3438 JobACL = "RestoreFiles"
3443 With the above specification, the console can access the Director's resources
3444 for the four jobs named on the JobACL directives, but for no others.
3446 \item [ClientACL = \lt{}name-list\gt{}]
3447 \index[dir]{ClientACL}
3448 \index[dir]{Directive!ClientACL}
3449 This directive is used to specify a list of Client resource names that can
3451 accessed by the console.
3453 \item [StorageACL = \lt{}name-list\gt{}]
3454 \index[dir]{StorageACL}
3455 \index[dir]{Directive!StorageACL}
3456 This directive is used to specify a list of Storage resource names that can
3457 be accessed by the console.
3459 \item [ScheduleACL = \lt{}name-list\gt{}]
3460 \index[dir]{ScheduleACL}
3461 \index[dir]{Directive!ScheduleACL}
3462 This directive is used to specify a list of Schedule resource names that can
3463 be accessed by the console.
3465 \item [PoolACL = \lt{}name-list\gt{}]
3466 \index[dir]{PoolACL}
3467 \index[dir]{Directive!PoolACL}
3468 This directive is used to specify a list of Pool resource names that can be
3469 accessed by the console.
3471 \item [FileSetACL = \lt{}name-list\gt{}]
3472 \index[dir]{FileSetACL}
3473 \index[dir]{Directive!FileSetACL}
3474 This directive is used to specify a list of FileSet resource names that
3475 can be accessed by the console.
3477 \item [CatalogACL = \lt{}name-list\gt{}]
3478 \index[dir]{CatalogACL}
3479 \index[dir]{Directive!CatalogACL}
3480 This directive is used to specify a list of Catalog resource names that
3481 can be accessed by the console.
3483 \item [CommandACL = \lt{}name-list\gt{}]
3484 \index[dir]{CommandACL}
3485 \index[dir]{Directive!CommandACL}
3486 This directive is used to specify a list of of console commands that can
3487 be executed by the console.
3489 \item [WhereACL = \lt{}string\gt{}]
3490 \index[dir]{WhereACL}
3491 \index[dir]{Directive!WhereACL}
3492 This directive permits you to specify where a restricted console
3493 can restore files. If this directive is not specified, only the
3494 default restore location is permitted (normally {\bf
3495 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3496 user enters will be accepted (not very secure), any other
3497 value specified (there may be multiple WhereACL directives) will
3498 restrict the user to use that path. For example, on a Unix system,
3499 if you specify "/", the file will be restored to the original
3500 location. This directive is untested.
3504 Aside from Director resource names and console command names, the special
3505 keyword {\bf *all*} can be specified in any of the above access control lists.
3506 When this keyword is present, any resource or command name (which ever is
3507 appropriate) will be accepted. For an example configuration file, please see
3509 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3512 \section{The Counter Resource}
3513 \label{CounterResource}
3514 \index[general]{Resource!Counter}
3515 \index[general]{Counter Resource}
3517 The Counter Resource defines a counter variable that can be accessed by
3518 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3520 \ilink{LabelFormat}{Label} directive in this chapter for more
3526 \index[dir]{Counter}
3527 \index[dir]{Directive!Counter}
3528 Start of the Counter resource. Counter directives are optional.
3530 \item [Name = \lt{}name\gt{}]
3532 \index[dir]{Directive!Name}
3533 The name of the Counter. This is the name you will use in the variable
3534 expansion to reference the counter value.
3536 \item [Minimum = \lt{}integer\gt{}]
3537 \index[dir]{Minimum}
3538 \index[dir]{Directive!Minimum}
3539 This specifies the minimum value that the counter can have. It also becomes
3540 the default. If not supplied, zero is assumed.
3542 \item [Maximum = \lt{}integer\gt{}]
3543 \index[dir]{Maximum}
3544 \index[dir]{Directive!Maximum}
3545 \index[dir]{Directive!Maximum}
3546 This is the maximum value value that the counter can have. If not specified
3547 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3548 the 31 power). When the counter is incremented past this value, it is reset
3551 \item [*WrapCounter = \lt{}counter-name\gt{}]
3552 \index[dir]{*WrapCounter}
3553 \index[dir]{Directive!*WrapCounter}
3554 If this value is specified, when the counter is incremented past the
3556 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3557 is incremented. (This is not currently implemented).
3559 \item [Catalog = \lt{}catalog-name\gt{}]
3560 \index[dir]{Catalog}
3561 \index[dir]{Directive!Catalog}
3562 If this directive is specified, the counter and its values will be saved in
3563 the specified catalog. If this directive is not present, the counter will be
3564 redefined each time that Bacula is started.
3567 \section{Example Director Configuration File}
3568 \label{SampleDirectorConfiguration}
3569 \index[general]{File!Example Director Configuration}
3570 \index[general]{Example Director Configuration File}
3572 An example Director configuration file might be the following:
3577 # Default Bacula Director Configuration file
3579 # The only thing that MUST be changed is to add one or more
3580 # file or directory names in the Include directive of the
3583 # For Bacula release 1.15 (5 March 2002) -- redhat
3585 # You might also want to change the default email address
3586 # from root to your address. See the "mail" and "operator"
3587 # directives in the Messages resource.
3589 Director { # define myself
3591 QueryFile = "/home/kern/bacula/bin/query.sql"
3592 WorkingDirectory = "/home/kern/bacula/bin/working"
3593 PidDirectory = "/home/kern/bacula/bin/working"
3594 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3596 # Define the backup Job
3598 Name = "NightlySave"
3600 Level = Incremental # default
3603 Schedule = "WeeklyCycle"
3613 Where = /tmp/bacula-restores
3619 # List of files to be backed up
3623 Options { signature=SHA1}
3625 # Put your list of files here, one per line or include an
3626 # external list with:
3630 # Note: / backs up everything
3635 # When to do the backups
3637 Name = "WeeklyCycle"
3638 Run = level=Full sun at 2:05
3639 Run = level=Incremental mon-sat at 2:05
3641 # Client (File Services) to backup
3646 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3647 File Retention = 60d # sixty day file retention
3648 Job Retention = 1y # 1 year Job retention
3649 AutoPrune = yes # Auto apply retention periods
3651 # Definition of DLT tape storage device
3655 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3656 Device = "HP DLT 80" # same as Device in Storage daemon
3657 Media Type = DLT8000 # same as MediaType in Storage daemon
3659 # Definition for a DLT autochanger device
3663 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3664 Device = "Autochanger" # same as Device in Storage daemon
3665 Media Type = DLT-8000 # Different from DLTDrive
3668 # Definition of DDS tape storage device
3672 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3673 Device = SDT-10000 # same as Device in Storage daemon
3674 Media Type = DDS-4 # same as MediaType in Storage daemon
3676 # Definition of 8mm tape storage device
3680 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3681 Device = "Exabyte 8mm"
3684 # Definition of file storage device
3688 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3689 Device = FileStorage
3692 # Generic catalog service
3695 dbname = bacula; user = bacula; password = ""
3697 # Reasonable message delivery -- send most everything to
3698 # the email address and to the console
3701 mail = root@localhost = all, !skipped, !terminate
3702 operator = root@localhost = mount
3703 console = all, !skipped, !saved
3706 # Default pool definition
3714 # Restricted console used by tray-monitor to get the status of the director
3718 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3719 CommandACL = status, .status