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[MaxConsoleConnections = \lt{}number\gt{}]
342 \index[dir]{MaximumConsoleConnections}
343 \index[dir]{MaxConsoleConnections}
344 \index[dir]{Directive!MaxConsoleConnections}
346 where \lt{}number\gt{} is the maximum number of Console Connections that
347 could run concurrently. The default is set to 20, but you may set it to a
352 The following is an example of a valid Director resource definition:
358 WorkingDirectory = "$HOME/bacula/bin/working"
359 Password = UA_password
360 PidDirectory = "$HOME/bacula/bin/working"
361 QueryFile = "$HOME/bacula/bin/query.sql"
367 \section{The Job Resource}
369 \index[general]{Resource!Job}
370 \index[general]{Job Resource}
372 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
373 perform. Each Job resource definition contains the name of a Client and
374 a FileSet to backup, the Schedule for the Job, where the data
375 are to be stored, and what media Pool can be used. In effect, each Job
376 resource must specify What, Where, How, and When or FileSet, Storage,
377 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
378 be specified for a restore job for historical reasons, but it is no longer used.
380 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
381 job. If you want to backup multiple FileSets on the same Client or multiple
382 Clients, you must define a Job for each one.
384 Note, you define only a single Job to do the Full, Differential, and
385 Incremental backups since the different backup levels are tied together by
386 a unique Job name. Normally, you will have only one Job per Client, but
387 if a client has a really huge number of files (more than several million),
388 you might want to split it into to Jobs each with a different FileSet
389 covering only part of the total files.
391 Multiple Storage daemons are not currently supported for Jobs, so if
392 you do want to use multiple storage daemons, you will need to create
393 a different Job and ensure that for each Job that the combination of
394 Client and FileSet are unique. The Client and FileSet are what Bacula
395 uses to restore a client, so if there are multiple Jobs with the same
396 Client and FileSet or multiple Storage daemons that are used, the
397 restore will not work. This problem can be resolved by defining multiple
398 FileSet definitions (the names must be different, but the contents of
399 the FileSets may be the same).
406 \index[dir]{Directive!Job}
407 Start of the Job resource. At least one Job resource is required.
409 \item [Name = \lt{}name\gt{}]
411 \index[dir]{Directive!Name}
412 The Job name. This name can be specified on the {\bf Run} command in the
413 console program to start a job. If the name contains spaces, it must be
414 specified between quotes. It is generally a good idea to give your job the
415 same name as the Client that it will backup. This permits easy
416 identification of jobs.
418 When the job actually runs, the unique Job Name will consist of the name you
419 specify here followed by the date and time the job was scheduled for
420 execution. This directive is required.
422 \item [Enabled = \lt{}yes\vb{}no\gt{}]
424 \index[dir]{Directive!Enable}
425 This directive allows you to enable or disable automatic execution
426 via the scheduler of a Job.
428 \item [Type = \lt{}job-type\gt{}]
430 \index[dir]{Directive!Type}
431 The {\bf Type} directive specifies the Job type, which may be one of the
432 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
433 directive is required. Within a particular Job Type, there are also Levels
434 as discussed in the next item.
440 Run a backup Job. Normally you will have at least one Backup job for each
441 client you want to save. Normally, unless you turn off cataloging, most all
442 the important statistics and data concerning files backed up will be placed
447 Run a restore Job. Normally, you will specify only one Restore job
448 which acts as a sort of prototype that you will modify using the console
449 program in order to perform restores. Although certain basic
450 information from a Restore job is saved in the catalog, it is very
451 minimal compared to the information stored for a Backup job -- for
452 example, no File database entries are generated since no Files are
455 {\bf Restore} jobs cannot be
456 automatically started by the scheduler as is the case for Backup, Verify
457 and Admin jobs. To restore files, you must use the {\bf restore} command
463 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
464 contents of the catalog to the file system, or to what was backed up. In
465 addition, to verifying that a tape that was written can be read, you can
466 also use {\bf verify} as a sort of tripwire intrusion detection.
470 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
471 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
472 Although an Admin job is recorded in the catalog, very little data is saved.
477 \item [Level = \lt{}job-level\gt{}]
479 \index[dir]{Directive!Level}
480 The Level directive specifies the default Job level to be run. Each
481 different Job Type (Backup, Restore, ...) has a different set of Levels
482 that can be specified. The Level is normally overridden by a different
483 value that is specified in the {\bf Schedule} resource. This directive
484 is not required, but must be specified either by a {\bf Level} directive
485 or as an override specified in the {\bf Schedule} resource.
487 For a {\bf Backup} Job, the Level may be one of the following:
493 When the Level is set to Full all files in the FileSet whether or not
494 they have changed will be backed up.
497 \index[dir]{Incremental}
498 When the Level is set to Incremental all files specified in the FileSet
499 that have changed since the last successful backup of the the same Job
500 using the same FileSet and Client, will be backed up. If the Director
501 cannot find a previous valid Full backup then the job will be upgraded
502 into a Full backup. When the Director looks for a valid backup record
503 in the catalog database, it looks for a previous Job with:
506 \item The same Job name.
507 \item The same Client name.
508 \item The same FileSet (any change to the definition of the FileSet such as
509 adding or deleting a file in the Include or Exclude sections constitutes a
511 \item The Job was a Full, Differential, or Incremental backup.
512 \item The Job terminated normally (i.e. did not fail or was not canceled).
513 \item The Job started no longer ago than {\bf Max Full Interval}.
516 If all the above conditions do not hold, the Director will upgrade the
517 Incremental to a Full save. Otherwise, the Incremental backup will be
518 performed as requested.
520 The File daemon (Client) decides which files to backup for an
521 Incremental backup by comparing start time of the prior Job (Full,
522 Differential, or Incremental) against the time each file was last
523 "modified" (st\_mtime) and the time its attributes were last
524 "changed"(st\_ctime). If the file was modified or its attributes
525 changed on or after this start time, it will then be backed up.
527 Some virus scanning software may change st\_ctime while
528 doing the scan. For example, if the virus scanning program attempts to
529 reset the access time (st\_atime), which Bacula does not use, it will
530 cause st\_ctime to change and hence Bacula will backup the file during
531 an Incremental or Differential backup. In the case of Sophos virus
532 scanning, you can prevent it from resetting the access time (st\_atime)
533 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
534 option. For other software, please see their manual.
536 When Bacula does an Incremental backup, all modified files that are
537 still on the system are backed up. However, any file that has been
538 deleted since the last Full backup remains in the Bacula catalog,
539 which means that if between a Full save and the time you do a
540 restore, some files are deleted, those deleted files will also be
541 restored. The deleted files will no longer appear in the catalog
542 after doing another Full save.
544 In addition, if you move a directory rather than copy it, the files in
545 it do not have their modification time (st\_mtime) or their attribute
546 change time (st\_ctime) changed. As a consequence, those files will
547 probably not be backed up by an Incremental or Differential backup which
548 depend solely on these time stamps. If you move a directory, and wish
549 it to be properly backed up, it is generally preferable to copy it, then
552 However, to manage deleted files or directories changes in the
553 catalog during an Incremental backup you can use \texttt{accurate}
554 mode. This is quite memory consuming process. See \ilink{Accurate
555 mode}{accuratemode} for more details.
558 \index[dir]{Differential}
559 When the Level is set to Differential
560 all files specified in the FileSet that have changed since the last
561 successful Full backup of the same Job will be backed up.
562 If the Director cannot find a
563 valid previous Full backup for the same Job, FileSet, and Client,
564 backup, then the Differential job will be upgraded into a Full backup.
565 When the Director looks for a valid Full backup record in the catalog
566 database, it looks for a previous Job with:
569 \item The same Job name.
570 \item The same Client name.
571 \item The same FileSet (any change to the definition of the FileSet such as
572 adding or deleting a file in the Include or Exclude sections constitutes a
574 \item The Job was a FULL backup.
575 \item The Job terminated normally (i.e. did not fail or was not canceled).
576 \item The Job started no longer ago than {\bf Max Full Interval}.
579 If all the above conditions do not hold, the Director will upgrade the
580 Differential to a Full save. Otherwise, the Differential backup will be
581 performed as requested.
583 The File daemon (Client) decides which files to backup for a
584 differential backup by comparing the start time of the prior Full backup
585 Job against the time each file was last "modified" (st\_mtime) and the
586 time its attributes were last "changed" (st\_ctime). If the file was
587 modified or its attributes were changed on or after this start time, it
588 will then be backed up. The start time used is displayed after the {\bf
589 Since} on the Job report. In rare cases, using the start time of the
590 prior backup may cause some files to be backed up twice, but it ensures
591 that no change is missed. As with the Incremental option, you should
592 ensure that the clocks on your server and client are synchronized or as
593 close as possible to avoid the possibility of a file being skipped.
594 Note, on versions 1.33 or greater Bacula automatically makes the
595 necessary adjustments to the time between the server and the client so
596 that the times Bacula uses are synchronized.
598 When Bacula does a Differential backup, all modified files that are
599 still on the system are backed up. However, any file that has been
600 deleted since the last Full backup remains in the Bacula catalog, which
601 means that if between a Full save and the time you do a restore, some
602 files are deleted, those deleted files will also be restored. The
603 deleted files will no longer appear in the catalog after doing another
604 Full save. However, to remove deleted files from the catalog during a
605 Differential backup is quite a time consuming process and not currently
606 implemented in Bacula. It is, however, a planned future feature.
608 As noted above, if you move a directory rather than copy it, the
609 files in it do not have their modification time (st\_mtime) or
610 their attribute change time (st\_ctime) changed. As a
611 consequence, those files will probably not be backed up by an
612 Incremental or Differential backup which depend solely on these
613 time stamps. If you move a directory, and wish it to be
614 properly backed up, it is generally preferable to copy it, then
615 delete the original. Alternatively, you can move the directory, then
616 use the {\bf touch} program to update the timestamps.
618 %% TODO: merge this with incremental
619 However, to manage deleted files or directories changes in the
620 catalog during an Differential backup you can use \texttt{accurate}
621 mode. This is quite memory consuming process. See \ilink{Accurate
622 mode}{accuratemode} for more details.
624 Every once and a while, someone asks why we need Differential
625 backups as long as Incremental backups pickup all changed files.
626 There are possibly many answers to this question, but the one
627 that is the most important for me is that a Differential backup
629 all the Incremental and Differential backups since the last Full backup
630 into a single Differential backup. This has two effects: 1. It gives
631 some redundancy since the old backups could be used if the merged backup
632 cannot be read. 2. More importantly, it reduces the number of Volumes
633 that are needed to do a restore effectively eliminating the need to read
634 all the volumes on which the preceding Incremental and Differential
635 backups since the last Full are done.
639 For a {\bf Restore} Job, no level needs to be specified.
641 For a {\bf Verify} Job, the Level may be one of the following:
646 \index[dir]{InitCatalog}
647 does a scan of the specified {\bf FileSet} and stores the file
648 attributes in the Catalog database. Since no file data is saved, you
649 might ask why you would want to do this. It turns out to be a very
650 simple and easy way to have a {\bf Tripwire} like feature using {\bf
651 Bacula}. In other words, it allows you to save the state of a set of
652 files defined by the {\bf FileSet} and later check to see if those files
653 have been modified or deleted and if any new files have been added.
654 This can be used to detect system intrusion. Typically you would
655 specify a {\bf FileSet} that contains the set of system files that
656 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
657 run the {\bf InitCatalog} level verify one time when your system is
658 first setup, and then once again after each modification (upgrade) to
659 your system. Thereafter, when your want to check the state of your
660 system files, you use a {\bf Verify} {\bf level = Catalog}. This
661 compares the results of your {\bf InitCatalog} with the current state of
666 Compares the current state of the files against the state previously
667 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
668 items reported are determined by the {\bf verify} options specified on
669 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
670 FileSet} resource below for more details). Typically this command will
671 be run once a day (or night) to check for any changes to your system
674 Please note! If you run two Verify Catalog jobs on the same client at
675 the same time, the results will certainly be incorrect. This is because
676 Verify Catalog modifies the Catalog database while running in order to
679 \item [VolumeToCatalog]
680 \index[dir]{VolumeToCatalog}
681 This level causes Bacula to read the file attribute data written to the
682 Volume from the last Job. 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 Catalog} 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 Catalog}
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 you do not have sufficient memory, the restore 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 (|), 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{}]
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 [Messages = \lt{}messages-resource-name\gt{}]
843 \index[dir]{Messages}
844 \index[dir]{Directive!Messages}
845 The Messages directive defines what Messages resource should be used for
846 this job, and thus how and where the various messages are to be
847 delivered. For example, you can direct some messages to a log file, and
848 others can be sent by email. For additional details, see the
849 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
850 directive is required.
852 \item [Pool = \lt{}pool-resource-name\gt{}]
854 \index[dir]{Directive!Pool}
855 The Pool directive defines the pool of Volumes where your data can be
856 backed up. Many Bacula installations will use only the {\bf Default}
857 pool. However, if you want to specify a different set of Volumes for
858 different Clients or different Jobs, you will probably want to use
859 Pools. For additional details, see the \ilink{Pool Resource
860 section}{PoolResource} of this chapter. This directive is required.
862 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
863 \index[dir]{Full Backup Pool}
864 \index[dir]{Directive!Full Backup Pool}
865 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
866 It will override any Pool specification during a Full backup. This
867 directive is optional.
869 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
870 \index[dir]{Differential Backup Pool}
871 \index[dir]{Directive!Differential Backup Pool}
872 The {\it Differential Backup Pool} specifies a Pool to be used for
873 Differential backups. It will override any Pool specification during a
874 Differential backup. This directive is optional.
876 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
877 \index[dir]{Incremental Backup Pool}
878 \index[dir]{Directive!Incremental Backup Pool}
879 The {\it Incremental Backup Pool} specifies a Pool to be used for
880 Incremental backups. It will override any Pool specification during an
881 Incremental backup. This directive is optional.
883 \item [Schedule = \lt{}schedule-name\gt{}]
884 \index[dir]{Schedule}
885 \index[dir]{Directive!Schedule}
886 The Schedule directive defines what schedule is to be used for the Job.
887 The schedule in turn determines when the Job will be automatically
888 started and what Job level (i.e. Full, Incremental, ...) is to be run.
889 This directive is optional, and if left out, the Job can only be started
890 manually using the Console program. Although you may specify only a
891 single Schedule resource for any one job, the Schedule resource may
892 contain multiple {\bf Run} directives, which allow you to run the Job at
893 many different times, and each {\bf run} directive permits overriding
894 the default Job Level Pool, Storage, and Messages resources. This gives
895 considerable flexibility in what can be done with a single Job. For
896 additional details, see the \ilink{Schedule Resource
897 Chapter}{ScheduleResource} of this manual.
900 \item [Storage = \lt{}storage-resource-name\gt{}]
902 \index[dir]{Directive!Storage}
903 The Storage directive defines the name of the storage services where you
904 want to backup the FileSet data. For additional details, see the
905 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
906 The Storage resource may also be specified in the Job's Pool resource,
907 in which case the value in the Pool resource overrides any value
908 in the Job. This Storage resource definition is not required by either
909 the Job resource or in the Pool, but it must be specified in
910 one or the other, if not an error will result.
912 \item [Max Start Delay = \lt{}time\gt{}]
913 \index[dir]{Max Start Delay}
914 \index[dir]{Directive!Max Start Delay}
915 The time specifies the maximum delay between the scheduled time and the
916 actual start time for the Job. For example, a job can be scheduled to
917 run at 1:00am, but because other jobs are running, it may wait to run.
918 If the delay is set to 3600 (one hour) and the job has not begun to run
919 by 2:00am, the job will be canceled. This can be useful, for example,
920 to prevent jobs from running during day time hours. The default is 0
921 which indicates no limit.
923 \item [Max Run Time = \lt{}time\gt{}]
924 \index[dir]{Max Run Time}
925 \index[dir]{Directive!Max Run Time}
926 The time specifies the maximum allowed time that a job may run, counted
927 from when the job starts, ({\bf not} necessarily the same as when the
930 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
931 \index[dir]{Incremental Wait Run Time}
932 \index[dir]{Differential Wait Run Time}
933 \index[dir]{Directive!Differential Max Wait Time}
934 Theses directives have been deprecated in favor of
935 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
937 \item [Incremental Max Run Time = \lt{}time\gt{}]
938 \index[dir]{Incremental Max Run Time}
939 \index[dir]{Directive!Incremental Max Run Time}
940 The time specifies the maximum allowed time that an Incremental backup job may
941 run, counted from when the job starts, ({\bf not} necessarily the same as when
942 the job was scheduled).
944 \item [Differential Max Wait Time = \lt{}time\gt{}]
945 \index[dir]{Differential Max Run Time}
946 \index[dir]{Directive!Differential Max Run Time}
947 The time specifies the maximum allowed time that a Differential backup job may
948 run, counted from when the job starts, ({\bf not} necessarily the same as when
949 the job was scheduled).
951 \item [Max Run Sched Time = \lt{}time\gt{}]
952 \index[dir]{Max Run Sched Time}
953 \index[dir]{Directive!Max Run Sched Time}
955 The time specifies the maximum allowed time that a job may run, counted from
956 when the job was scheduled. This can be useful to prevent jobs from running
957 during working hours. We can see it like \texttt{Max Start Delay + Max Run
960 \item [Max Wait Time = \lt{}time\gt{}]
961 \index[dir]{Max Wait Time}
962 \index[dir]{Directive!Max Wait Time}
963 The time specifies the maximum allowed time that a job may block waiting
964 for a resource (such as waiting for a tape to be mounted, or waiting for
965 the storage or file daemons to perform their duties), counted from the
966 when the job starts, ({\bf not} necessarily the same as when the job was
967 scheduled). This directive works as expected since bacula 2.3.18.
969 \addcontentsline{lof}{figure}{Job time control directives}
970 \includegraphics{\idir different_time.eps}
972 \item [Max Full Interval = \lt{}time\gt{}]
973 \index[dir]{Max Full Interval}
974 \index[dir]{Directive!Max Full Interval}
975 The time specifies the maximum allowed age (counting from start time) of
976 the most recent successful Full backup that is required in order to run
977 Incremental or Differential backup jobs. If the most recent Full backup
978 is older than this interval, Incremental and Differential backups will be
979 upgraded to Full backups automatically. If this directive is not present,
980 or specified as 0, then the age of the previous Full backup is not
983 \label{PreferMountedVolumes}
984 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
985 \index[dir]{Prefer Mounted Volumes}
986 \index[dir]{Directive!Prefer Mounted Volumes}
987 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
988 yes), the Storage daemon is requested to select either an Autochanger or
989 a drive with a valid Volume already mounted in preference to a drive
990 that is not ready. This means that all jobs will attempt to append
991 to the same Volume (providing the Volume is appropriate -- right Pool,
992 ... for that job), unless you are using multiple pools.
993 If no drive with a suitable Volume is available, it
994 will select the first available drive. Note, any Volume that has
995 been requested to be mounted, will be considered valid as a mounted
996 volume by another job. This if multiple jobs start at the same time
997 and they all prefer mounted volumes, the first job will request the
998 mount, and the other jobs will use the same volume.
1000 If the directive is set to {\bf no}, the Storage daemon will prefer
1001 finding an unused drive, otherwise, each job started will append to the
1002 same Volume (assuming the Pool is the same for all jobs). Setting
1003 Prefer Mounted Volumes to no can be useful for those sites
1004 with multiple drive autochangers that prefer to maximize backup
1005 throughput at the expense of using additional drives and Volumes.
1006 This means that the job will prefer to use an unused drive rather
1007 than use a drive that is already in use.
1009 Despite the above, we recommend against setting this directive to
1011 it tends to add a lot of swapping of Volumes between the different
1012 drives and can easily lead to deadlock situations in the Storage
1013 daemon. We will accept bug reports against it, but we cannot guarantee
1014 that we will be able to fix the problem in a reasonable time.
1016 A better alternative for using multiple drives is to use multiple
1017 pools so that Bacula will be forced to mount Volumes from those Pools
1018 on different drives.
1020 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1021 \index[dir]{Prune Jobs}
1022 \index[dir]{Directive!Prune Jobs}
1023 Normally, pruning of Jobs from the Catalog is specified on a Client by
1024 Client basis in the Client resource with the {\bf AutoPrune} directive.
1025 If this directive is specified (not normally) and the value is {\bf
1026 yes}, it will override the value specified in the Client resource. The
1027 default is {\bf no}.
1030 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1031 \index[dir]{Prune Files}
1032 \index[dir]{Directive!Prune Files}
1033 Normally, pruning of Files from the Catalog is specified on a Client by
1034 Client basis in the Client resource with the {\bf AutoPrune} directive.
1035 If this directive is specified (not normally) and the value is {\bf
1036 yes}, it will override the value specified in the Client resource. The
1037 default is {\bf no}.
1039 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1040 \index[dir]{Prune Volumes}
1041 \index[dir]{Directive!Prune Volumes}
1042 Normally, pruning of Volumes from the Catalog is specified on a Client
1043 by Client basis in the Client resource with the {\bf AutoPrune}
1044 directive. If this directive is specified (not normally) and the value
1045 is {\bf yes}, it will override the value specified in the Client
1046 resource. The default is {\bf no}.
1048 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1049 \index[dir]{RunScript}
1050 \index[dir]{Directive!Run Script}
1052 The RunScript directive behaves like a resource in that it
1053 requires opening and closing braces around a number of directives
1054 that make up the body of the runscript.
1056 The specified {\bf Command} (see below for details) is run as an external
1057 program prior or after the current Job. This is optional. By default, the
1058 program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1060 \textbf{Console} options are special commands that are sent to the director instead
1061 of the OS. At this time, console command ouputs are redirected to log with
1064 You can use following console command : \texttt{delete}, \texttt{disable},
1065 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1066 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1067 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1068 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1069 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1070 more information. You need to specify needed information on command line, nothing
1071 will be prompted. Example :
1074 Console = "prune files client=%c"
1075 Console = "update stats age=3"
1078 You can specify more than one Command/Console option per RunScript.
1080 You can use following options may be specified in the body
1083 \begin{tabular}{|c|c|c|l}
1084 Options & Value & Default & Information \\
1087 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
1089 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
1091 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
1093 Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
1095 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
1096 something different from 0 \\
1098 Command & & & Path to your script\\
1100 Console & & & Console command\\
1105 Any output sent by the command to standard output will be included in the
1106 Bacula job report. The command string must be a valid program name or name
1109 In addition, the command string is parsed then fed to the OS,
1110 which means that the path will be searched to execute your specified
1111 command, but there is no shell interpretation, as a consequence, if you
1112 invoke complicated commands or want any shell features such as redirection
1113 or piping, you must call a shell script and do it inside that script.
1115 Before submitting the specified command to the operating system, Bacula
1116 performs character substitution of the following characters:
1118 \label{character substitution}
1123 %d = Director's name
1124 %e = Job Exit Status
1130 %t = Job type (Backup, ...)
1131 %v = Volume name (Only on director side)
1136 The Job Exit Status code \%e edits the following values:
1138 \index[dir]{Exit Status}
1145 \item Unknown term code
1148 Thus if you edit it on a command line, you will need to enclose
1149 it within some sort of quotes.
1152 You can use these following shortcuts:\\
1154 \begin{tabular}{|c|c|c|c|c|c}
1155 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1157 Run Before Job & & & Yes & No & Before \\
1159 Run After Job & Yes & No & & No & After \\
1161 Run After Failed Job & No & Yes & & No & After \\
1163 Client Run Before Job & & & Yes & Yes & Before \\
1165 Client Run After Job & Yes & No & & Yes & After \\
1173 Command = "/etc/init.d/apache stop"
1179 Command = "/etc/init.d/apache start"
1183 {\bf Notes about ClientRunBeforeJob}
1185 For compatibility reasons, with this shortcut, the command is executed
1186 directly when the client recieve it. And if the command is in error, other
1187 remote runscripts will be discarded. To be sure that all commands will be
1188 sent and executed, you have to use RunScript syntax.
1190 {\bf Special Windows Considerations}
1192 You can run scripts just after snapshots initializations with
1193 \textsl{AfterVSS} keyword.
1195 In addition, for a Windows client on version 1.33 and above, please take
1196 note that you must ensure a correct path to your script. The script or
1197 program can be a .com, .exe or a .bat file. If you just put the program
1198 name in then Bacula will search using the same rules that cmd.exe uses
1199 (current directory, Bacula bin directory, and PATH). It will even try the
1200 different extensions in the same order as cmd.exe.
1201 The command can be anything that cmd.exe or command.com will recognize
1202 as an executable file.
1204 However, if you have slashes in the program name then Bacula figures you
1205 are fully specifying the name, so you must also explicitly add the three
1206 character extension.
1208 The command is run in a Win32 environment, so Unix like commands will not
1209 work unless you have installed and properly configured Cygwin in addition
1210 to and separately from Bacula.
1212 The System \%Path\% will be searched for the command. (under the
1213 environment variable dialog you have have both System Environment and
1214 User Environment, we believe that only the System environment will be
1215 available to bacula-fd, if it is running as a service.)
1217 System environment variables can be referenced with \%var\% and
1218 used as either part of the command name or arguments.
1220 So if you have a script in the Bacula\\bin directory then the following lines
1225 Client Run Before Job = systemstate
1227 Client Run Before Job = systemstate.bat
1229 Client Run Before Job = "systemstate"
1231 Client Run Before Job = "systemstate.bat"
1233 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1237 The outer set of quotes is removed when the configuration file is parsed.
1238 You need to escape the inner quotes so that they are there when the code
1239 that parses the command line for execution runs so it can tell what the
1245 ClientRunBeforeJob = "\"C:/Program Files/Software
1246 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1250 The special characters
1254 will need to be quoted,
1255 if they are part of a filename or argument.
1257 If someone is logged in, a blank "command" window running the commands
1258 will be present during the execution of the command.
1260 Some Suggestions from Phil Stracchino for running on Win32 machines with
1261 the native Win32 File daemon:
1264 \item You might want the ClientRunBeforeJob directive to specify a .bat
1265 file which runs the actual client-side commands, rather than trying
1266 to run (for example) regedit /e directly.
1267 \item The batch file should explicitly 'exit 0' on successful completion.
1268 \item The path to the batch file should be specified in Unix form:
1270 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1272 rather than DOS/Windows form:
1274 ClientRunBeforeJob =
1276 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1280 For Win32, please note that there are certain limitations:
1282 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1284 Lines like the above do not work because there are limitations of
1285 cmd.exe that is used to execute the command.
1286 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1287 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1288 cmd prompt and see what happens. Once the command is correct insert a
1289 backslash (\textbackslash{}) before each double quote ("), and
1290 then put quotes around the whole thing when putting it in
1291 the director's .conf file. You either need to have only one set of quotes
1292 or else use the short name and don't put quotes around the command path.
1294 Below is the output from cmd's help as it relates to the command line
1295 passed to the /c option.
1298 If /C or /K is specified, then the remainder of the command line after
1299 the switch is processed as a command line, where the following logic is
1300 used to process quote (") characters:
1304 If all of the following conditions are met, then quote characters
1305 on the command line are preserved:
1308 \item exactly two quote characters.
1309 \item no special characters between the two quote characters,
1310 where special is one of:
1314 \item there are one or more whitespace characters between the
1315 the two quote characters.
1316 \item the string between the two quote characters is the name
1317 of an executable file.
1320 \item Otherwise, old behavior is to see if the first character is
1321 a quote character and if so, strip the leading character and
1322 remove the last quote character on the command line, preserving
1323 any text after the last quote character.
1328 The following example of the use of the Client Run Before Job directive was
1329 submitted by a user:\\
1330 You could write a shell script to back up a DB2 database to a FIFO. The shell
1340 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1345 The following line in the Job resource in the bacula-dir.conf file:
1348 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1353 When the job is run, you will get messages from the output of the script
1354 stating that the backup has started. Even though the command being run is
1355 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1356 command, thus the backup stalls.
1358 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1363 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1368 It is important to redirect the input and outputs of a backgrounded command to
1369 /dev/null to prevent the script from blocking.
1371 \item [Run Before Job = \lt{}command\gt{}]
1372 \index[dir]{Run Before Job}
1373 \index[dir]{Directive!Run Before Job}
1374 \index[dir]{Directive!Run Before Job}
1375 The specified {\bf command} is run as an external program prior to running the
1376 current Job. This directive is not required, but if it is defined, and if the
1377 exit code of the program run is non-zero, the current Bacula job will be
1381 Run Before Job = "echo test"
1383 it's equivalent to :
1386 Command = "echo test"
1392 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1393 simple way to modify your schedules during a holiday. For example, suppose
1394 that you normally do Full backups on Fridays, but Thursday and Friday are
1395 holidays. To avoid having to change tapes between Thursday and Friday when
1396 no one is in the office, you can create a RunBeforeJob that returns a
1397 non-zero status on Thursday and zero on all other days. That way, the
1398 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1399 before leaving will be used.
1401 \item [Run After Job = \lt{}command\gt{}]
1402 \index[dir]{Run After Job}
1403 \index[dir]{Directive!Run After Job}
1404 The specified {\bf command} is run as an external program if the current
1405 job terminates normally (without error or without being canceled). This
1406 directive is not required. If the exit code of the program run is
1407 non-zero, Bacula will print a warning message. Before submitting the
1408 specified command to the operating system, Bacula performs character
1409 substitution as described above for the {\bf RunScript} directive.
1411 An example of the use of this directive is given in the
1412 \ilink{Tips Chapter}{JobNotification} of this manual.
1414 See the {\bf Run After Failed Job} if you
1415 want to run a script after the job has terminated with any
1418 \item [Run After Failed Job = \lt{}command\gt{}]
1419 \index[dir]{Run After Job}
1420 \index[dir]{Directive!Run After Job}
1421 The specified {\bf command} is run as an external program after the current
1422 job terminates with any error status. This directive is not required. The
1423 command string must be a valid program name or name of a shell script. If
1424 the exit code of the program run is non-zero, Bacula will print a
1425 warning message. Before submitting the specified command to the
1426 operating system, Bacula performs character substitution as described above
1427 for the {\bf RunScript} directive. Note, if you wish that your script
1428 will run regardless of the exit status of the Job, you can use this :
1431 Command = "echo test"
1435 RunsOnSuccess = yes # default, you can drop this line
1439 An example of the use of this directive is given in the
1440 \ilink{Tips Chapter}{JobNotification} of this manual.
1443 \item [Client Run Before Job = \lt{}command\gt{}]
1444 \index[dir]{Client Run Before Job}
1445 \index[dir]{Directive!Client Run Before Job}
1446 This directive is the same as {\bf Run Before Job} except that the
1447 program is run on the client machine. The same restrictions apply to
1448 Unix systems as noted above for the {\bf RunScript}.
1450 \item [Client Run After Job = \lt{}command\gt{}]
1451 \index[dir]{Client Run After Job}
1452 \index[dir]{Directive!Client Run After Job}
1453 The specified {\bf command} is run on the client machine as soon
1454 as data spooling is complete in order to allow restarting applications
1455 on the client as soon as possible. .
1457 Note, please see the notes above in {\bf RunScript}
1458 concerning Windows clients.
1460 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1461 \index[dir]{Rerun Failed Levels}
1462 \index[dir]{Directive!Rerun Failed Levels}
1463 If this directive is set to {\bf yes} (default no), and Bacula detects that
1464 a previous job at a higher level (i.e. Full or Differential) has failed,
1465 the current job level will be upgraded to the higher level. This is
1466 particularly useful for Laptops where they may often be unreachable, and if
1467 a prior Full save has failed, you wish the very next backup to be a Full
1468 save rather than whatever level it is started as.
1470 There are several points that must be taken into account when using this
1471 directive: first, a failed job is defined as one that has not terminated
1472 normally, which includes any running job of the same name (you need to
1473 ensure that two jobs of the same name do not run simultaneously);
1474 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1475 when checking for failed levels, which means that any FileSet change will
1478 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1479 \index[dir]{Spool Data}
1480 \index[dir]{Directive!Spool Data}
1482 If this directive is set to {\bf yes} (default no), the Storage daemon will
1483 be requested to spool the data for this Job to disk rather than write it
1484 directly to tape. Once all the data arrives or the spool files' maximum sizes
1485 are reached, the data will be despooled and written to tape. Spooling data
1486 prevents tape shoe-shine (start and stop) during
1487 Incremental saves. If you are writing to a disk file using this option
1488 will probably just slow down the backup jobs.
1490 NOTE: When this directive is set to yes, Spool Attributes is also
1491 automatically set to yes.
1493 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1494 \index[dir]{Spool Attributes}
1495 \index[dir]{Directive!Spool Attributes}
1497 \index[general]{slow}
1498 \index[dir]{Backups!slow}
1499 \index[general]{Backups!slow}
1500 The default is set to {\bf no}, which means that the File attributes are
1501 sent by the Storage daemon to the Director as they are stored on tape.
1502 However, if you want to avoid the possibility that database updates will
1503 slow down writing to the tape, you may want to set the value to {\bf
1504 yes}, in which case the Storage daemon will buffer the File attributes
1505 and Storage coordinates to a temporary file in the Working Directory,
1506 then when writing the Job data to the tape is completed, the attributes
1507 and storage coordinates will be sent to the Director.
1509 NOTE: When Spool Data is set to yes, Spool Attributes is also
1510 automatically set to yes.
1512 \item [Where = \lt{}directory\gt{}]
1514 \index[dir]{Directive!Where}
1515 This directive applies only to a Restore job and specifies a prefix to
1516 the directory name of all files being restored. This permits files to
1517 be restored in a different location from which they were saved. If {\bf
1518 Where} is not specified or is set to backslash ({\bf /}), the files will
1519 be restored to their original location. By default, we have set {\bf
1520 Where} in the example configuration files to be {\bf
1521 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1524 \item [Add Prefix = \lt{}directory\gt{}]
1525 \label{confaddprefix}
1526 \index[dir]{AddPrefix}
1527 \index[dir]{Directive!AddPrefix}
1528 This directive applies only to a Restore job and specifies a prefix to the
1529 directory name of all files being restored. This will use \ilink{File
1530 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1532 \item [Add Suffix = \lt{}extention\gt{}]
1533 \index[dir]{AddSuffix}
1534 \index[dir]{Directive!AddSuffix}
1535 This directive applies only to a Restore job and specifies a suffix to all
1536 files being restored. This will use \ilink{File Relocation}{filerelocation}
1537 feature implemented in Bacula 2.1.8 or later.
1539 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1540 \texttt{/etc/passwsd.old}
1542 \item [Strip Prefix = \lt{}directory\gt{}]
1543 \index[dir]{StripPrefix}
1544 \index[dir]{Directive!StripPrefix}
1545 This directive applies only to a Restore job and specifies a prefix to remove
1546 from the directory name of all files being restored. This will use the
1547 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1550 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1553 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1561 \item [RegexWhere = \lt{}expressions\gt{}]
1562 \index[dir]{RegexWhere}
1563 \index[dir]{Directive!RegexWhere}
1564 This directive applies only to a Restore job and specifies a regex filename
1565 manipulation of all files being restored. This will use \ilink{File
1566 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1568 For more informations about how use this option, see
1569 \ilink{this}{useregexwhere}.
1571 \item [Replace = \lt{}replace-option\gt{}]
1572 \index[dir]{Replace}
1573 \index[dir]{Directive!Replace}
1574 This directive applies only to a Restore job and specifies what happens
1575 when Bacula wants to restore a file or directory that already exists.
1576 You have the following options for {\bf replace-option}:
1582 when the file to be restored already exists, it is deleted and then
1583 replaced by the copy that was backed up. This is the default value.
1586 \index[dir]{ifnewer}
1587 if the backed up file (on tape) is newer than the existing file, the
1588 existing file is deleted and replaced by the back up.
1591 \index[dir]{ifolder}
1592 if the backed up file (on tape) is older than the existing file, the
1593 existing file is deleted and replaced by the back up.
1597 if the backed up file already exists, Bacula skips restoring this file.
1600 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1601 \index[dir]{Prefix Links}
1602 \index[dir]{Directive!Prefix Links}
1603 If a {\bf Where} path prefix is specified for a recovery job, apply it
1604 to absolute links as well. The default is {\bf No}. When set to {\bf
1605 Yes} then while restoring files to an alternate directory, any absolute
1606 soft links will also be modified to point to the new alternate
1607 directory. Normally this is what is desired -- i.e. everything is self
1608 consistent. However, if you wish to later move the files to their
1609 original locations, all files linked with absolute names will be broken.
1611 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1612 \index[dir]{Maximum Concurrent Jobs}
1613 \index[dir]{Directive!Maximum Concurrent Jobs}
1614 where \lt{}number\gt{} is the maximum number of Jobs from the current
1615 Job resource that can run concurrently. Note, this directive limits
1616 only Jobs with the same name as the resource in which it appears. Any
1617 other restrictions on the maximum concurrent jobs such as in the
1618 Director, Client, or Storage resources will also apply in addition to
1619 the limit specified here. The default is set to 1, but you may set it
1620 to a larger number. We strongly recommend that you read the WARNING
1621 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1622 Director's resource.
1624 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1625 \index[dir]{Reschedule On Error}
1626 \index[dir]{Directive!Reschedule On Error}
1627 If this directive is enabled, and the job terminates in error, the job
1628 will be rescheduled as determined by the {\bf Reschedule Interval} and
1629 {\bf Reschedule Times} directives. If you cancel the job, it will not
1630 be rescheduled. The default is {\bf no} (i.e. the job will not be
1633 This specification can be useful for portables, laptops, or other
1634 machines that are not always connected to the network or switched on.
1636 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1637 \index[dir]{Reschedule Interval}
1638 \index[dir]{Directive!Reschedule Interval}
1639 If you have specified {\bf Reschedule On Error = yes} and the job
1640 terminates in error, it will be rescheduled after the interval of time
1641 specified by {\bf time-specification}. See \ilink{the time
1642 specification formats}{Time} in the Configure chapter for details of
1643 time specifications. If no interval is specified, the job will not be
1644 rescheduled on error.
1646 \item [Reschedule Times = \lt{}count\gt{}]
1647 \index[dir]{Reschedule Times}
1648 \index[dir]{Directive!Reschedule Times}
1649 This directive specifies the maximum number of times to reschedule the
1650 job. If it is set to zero (the default) the job will be rescheduled an
1651 indefinite number of times.
1653 \item [Run = \lt{}job-name\gt{}]
1655 \index[dir]{Directive!Run}
1656 \index[dir]{Clone a Job}
1657 The Run directive (not to be confused with the Run option in a
1658 Schedule) allows you to start other jobs or to clone jobs. By using the
1659 cloning keywords (see below), you can backup
1660 the same data (or almost the same data) to two or more drives
1661 at the same time. The {\bf job-name} is normally the same name
1662 as the current Job resource (thus creating a clone). However, it
1663 may be any Job name, so one job may start other related jobs.
1665 The part after the equal sign must be enclosed in double quotes,
1666 and can contain any string or set of options (overrides) that you
1667 can specify when entering the Run command from the console. For
1668 example {\bf storage=DDS-4 ...}. In addition, there are two special
1669 keywords that permit you to clone the current job. They are {\bf level=\%l}
1670 and {\bf since=\%s}. The \%l in the level keyword permits
1671 entering the actual level of the current job and the \%s in the since
1672 keyword permits putting the same time for comparison as used on the
1673 current job. Note, in the case of the since keyword, the \%s must be
1674 enclosed in double quotes, and thus they must be preceded by a backslash
1675 since they are already inside quotes. For example:
1678 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1681 A cloned job will not start additional clones, so it is not
1682 possible to recurse.
1684 Please note that all cloned jobs, as specified in the Run directives are
1685 submitted for running before the original job is run (while it is being
1686 initialized). This means that any clone job will actually start before
1687 the original job, and may even block the original job from starting
1688 until the original job finishes unless you allow multiple simultaneous
1689 jobs. Even if you set a lower priority on the clone job, if no other
1690 jobs are running, it will start before the original job.
1692 If you are trying to prioritize jobs by using the clone feature (Run
1693 directive), you will find it much easier to do using a RunScript
1694 resource, or a RunBeforeJob directive.
1697 \item [Priority = \lt{}number\gt{}]
1698 \index[dir]{Priority}
1699 \index[dir]{Directive!Priority}
1700 This directive permits you to control the order in which your jobs will
1701 be run by specifying a positive non-zero number. The higher the number,
1702 the lower the job priority. Assuming you are not running concurrent jobs,
1703 all queued jobs of priority 1 will run before queued jobs of priority 2
1704 and so on, regardless of the original scheduling order.
1706 The priority only affects waiting jobs that are queued to run, not jobs
1707 that are already running. If one or more jobs of priority 2 are already
1708 running, and a new job is scheduled with priority 1, the currently
1709 running priority 2 jobs must complete before the priority 1 job is
1710 run, unless Allow Mixed Priority is set.
1712 The default priority is 10.
1714 If you want to run concurrent jobs you should
1715 keep these points in mind:
1718 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1721 \item Bacula concurrently runs jobs of only one priority at a time. It
1722 will not simultaneously run a priority 1 and a priority 2 job.
1724 \item If Bacula is running a priority 2 job and a new priority 1 job is
1725 scheduled, it will wait until the running priority 2 job terminates even
1726 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1727 to run simultaneously.
1729 \item Suppose that bacula is running a priority 2 job and a new priority 1
1730 job is scheduled and queued waiting for the running priority 2 job to
1731 terminate. If you then start a second priority 2 job, the waiting
1732 priority 1 job will prevent the new priority 2 job from running
1733 concurrently with the running priority 2 job. That is: as long as there
1734 is a higher priority job waiting to run, no new lower priority jobs will
1735 start even if the Maximum Concurrent Jobs settings would normally allow
1736 them to run. This ensures that higher priority jobs will be run as soon
1740 If you have several jobs of different priority, it may not best to start
1741 them at exactly the same time, because Bacula must examine them one at a
1742 time. If by Bacula starts a lower priority job first, then it will run
1743 before your high priority jobs. If you experience this problem, you may
1744 avoid it by starting any higher priority jobs a few seconds before lower
1745 priority ones. This insures that Bacula will examine the jobs in the
1746 correct order, and that your priority scheme will be respected.
1748 \label{AllowMixedPriority}
1749 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1750 \index[dir]{Allow Mixed Priority}
1751 This directive is only implemented in version 2.5 and later. When
1752 set to {\bf yes} (default {\bf no}), this job may run even if lower
1753 priority jobs are already running. This means a high priority job
1754 will not have to wait for other jobs to finish before starting.
1755 The scheduler will only mix priorities when all running jobs have
1758 Note that only higher priority jobs will start early. Suppose the
1759 director will allow two concurrent jobs, and that two jobs with
1760 priority 10 are running, with two more in the queue. If a job with
1761 priority 5 is added to the queue, it will be run as soon as one of
1762 the running jobs finishes. However, new priority 10 jobs will not
1763 be run until the priority 5 job has finished.
1765 \label{WritePartAfterJob}
1766 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1767 \index[dir]{Write Part After Job}
1768 \index[dir]{Directive!Write Part After Job}
1769 This directive is only implemented in version 1.37 and later.
1770 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1771 will be created after the job is finished.
1773 It should be set to {\bf yes} when writing to devices that require mount
1774 (for example DVD), so you are sure that the current part, containing
1775 this job's data, is written to the device, and that no data is left in
1776 the temporary file on the hard disk. However, on some media, like DVD+R
1777 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1778 written. So, if you run several jobs each after another, you could set
1779 this directive to {\bf no} for all jobs, except the last one, to avoid
1780 wasting too much space, but to ensure that the data is written to the
1781 medium when all jobs are finished.
1783 This directive is ignored with tape and FIFO devices.
1787 The following is an example of a valid Job resource definition:
1794 Level = Incremental # default
1796 FileSet="Minou Full Set"
1799 Schedule = "MinouWeeklyCycle"
1805 \section{The JobDefs Resource}
1806 \label{JobDefsResource}
1807 \index[general]{JobDefs Resource}
1808 \index[general]{Resource!JobDefs}
1810 The JobDefs resource permits all the same directives that can appear in a Job
1811 resource. However, a JobDefs resource does not create a Job, rather it can be
1812 referenced within a Job to provide defaults for that Job. This permits you to
1813 concisely define several nearly identical Jobs, each one referencing a JobDefs
1814 resource which contains the defaults. Only the changes from the defaults need to
1815 be mentioned in each Job.
1817 \section{The Schedule Resource}
1818 \label{ScheduleResource}
1819 \index[general]{Resource!Schedule}
1820 \index[general]{Schedule Resource}
1822 The Schedule resource provides a means of automatically scheduling a Job as
1823 well as the ability to override the default Level, Pool, Storage and Messages
1824 resources. If a Schedule resource is not referenced in a Job, the Job can only
1825 be run manually. In general, you specify an action to be taken and when.
1830 \index[dir]{Schedule}
1831 \index[dir]{Directive!Schedule}
1832 Start of the Schedule directives. No {\bf Schedule} resource is
1833 required, but you will need at least one if you want Jobs to be
1834 automatically started.
1836 \item [Name = \lt{}name\gt{}]
1838 \index[dir]{Directive!Name}
1839 The name of the schedule being defined. The Name directive is required.
1841 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1843 \index[dir]{Directive!Run}
1844 The Run directive defines when a Job is to be run, and what overrides if
1845 any to apply. You may specify multiple {\bf run} directives within a
1846 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1847 multiple schedules). If you have two {\bf Run} directives that start at
1848 the same time, two Jobs will start at the same time (well, within one
1849 second of each other).
1851 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1852 Messages, and the Pool specifications provided in the Job resource. In
1853 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1854 specifications permit overriding the Pool specification according to
1855 what backup Job Level is in effect.
1857 By the use of overrides, you may customize a particular Job. For
1858 example, you may specify a Messages override for your Incremental
1859 backups that outputs messages to a log file, but for your weekly or
1860 monthly Full backups, you may send the output by email by using a
1861 different Messages override.
1863 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1864 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1865 or IncrementalPool, and the {\bf value} is as defined on the respective
1866 directive formats for the Job resource. You may specify multiple {\bf
1867 Job-overrides} on one {\bf Run} directive by separating them with one or
1868 more spaces or by separating them with a trailing comma. For example:
1874 \index[dir]{Directive!Level}
1875 is all files in the FileSet whether or not they have changed.
1877 \item [Level=Incremental]
1879 \index[dir]{Directive!Level}
1880 is all files that have changed since the last backup.
1884 \index[dir]{Directive!Pool}
1885 specifies to use the Pool named {\bf Weekly}.
1887 \item [Storage=DLT\_Drive]
1888 \index[dir]{Storage}
1889 \index[dir]{Directive!Storage}
1890 specifies to use {\bf DLT\_Drive} for the storage device.
1892 \item [Messages=Verbose]
1893 \index[dir]{Messages}
1894 \index[dir]{Directive!Messages}
1895 specifies to use the {\bf Verbose} message resource for the Job.
1897 \item [FullPool=Full]
1898 \index[dir]{FullPool}
1899 \index[dir]{Directive!FullPool}
1900 specifies to use the Pool named {\bf Full} if the job is a full backup, or
1902 upgraded from another type to a full backup.
1904 \item [DifferentialPool=Differential]
1905 \index[dir]{DifferentialPool}
1906 \index[dir]{Directive!DifferentialPool}
1907 specifies to use the Pool named {\bf Differential} if the job is a
1908 differential backup.
1910 \item [IncrementalPool=Incremental]
1911 \index[dir]{IncrementalPool}
1912 \index[dir]{Directive!IncrementalPool}
1913 specifies to use the Pool named {\bf Incremental} if the job is an
1916 \item [SpoolData=yes\vb{}no]
1917 \index[dir]{SpoolData}
1918 \index[dir]{Directive!SpoolData}
1919 tells Bacula to request the Storage daemon to spool data to a disk file
1920 before writing it to the Volume (normally a tape). Thus the data is
1921 written in large blocks to the Volume rather than small blocks. This
1922 directive is particularly useful when running multiple simultaneous
1923 backups to tape. It prevents interleaving of the job data and reduces
1924 or eliminates tape drive stop and start commonly known as "shoe-shine".
1926 \item [SpoolSize={\it bytes}]
1927 \index[dir]{SpoolSize}
1928 \index[dir]{Directive!SpoolSize}
1929 where the bytes specify the maximum spool size for this job.
1930 The default is take from Device Maximum Spool Size limit.
1931 This directive is available only in Bacula version 2.3.5 or
1934 \item [WritePartAfterJob=yes\vb{}no]
1935 \index[dir]{WritePartAfterJob}
1936 \index[dir]{Directive!WritePartAfterJob}
1937 tells Bacula to request the Storage daemon to write the current part
1938 file to the device when the job is finished (see \ilink{Write Part After
1939 Job directive in the Job resource}{WritePartAfterJob}). Please note,
1940 this directive is implemented only in version 1.37 and later. The
1941 default is yes. We strongly recommend that you keep this set to yes
1942 otherwise, when the last job has finished one part will remain in the
1943 spool file and restore may or may not work.
1947 {\bf Date-time-specification} determines when the Job is to be run. The
1948 specification is a repetition, and as a default Bacula is set to run a job at
1949 the beginning of the hour of every hour of every day of every week of every
1950 month of every year. This is not normally what you want, so you must specify
1951 or limit when you want the job to run. Any specification given is assumed to
1952 be repetitive in nature and will serve to override or limit the default
1953 repetition. This is done by specifying masks or times for the hour, day of the
1954 month, day of the week, week of the month, week of the year, and month when
1955 you want the job to run. By specifying one or more of the above, you can
1956 define a schedule to repeat at almost any frequency you want.
1958 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
1959 minute} the Job is to be run. Of these four items to be specified, {\bf day}
1960 is special in that you may either specify a day of the month such as 1, 2,
1961 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
1962 Sunday. Finally, you may also specify a week qualifier to restrict the
1963 schedule to the first, second, third, fourth, or fifth week of the month.
1965 For example, if you specify only a day of the week, such as {\bf Tuesday} the
1966 Job will be run every hour of every Tuesday of every Month. That is the {\bf
1967 month} and {\bf hour} remain set to the defaults of every month and all
1970 Note, by default with no other specification, your job will run at the
1971 beginning of every hour. If you wish your job to run more than once in any
1972 given hour, you will need to specify multiple {\bf run} specifications each
1973 with a different minute.
1975 The date/time to run the Job can be specified in the following way in
1982 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
1983 second | third | fourth | fifth
1984 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
1985 sunday | monday | tuesday | wednesday |
1986 thursday | friday | saturday
1987 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
1988 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
1989 aug | sep | oct | nov | dec | january |
1990 february | ... | december
1991 <daily-keyword> = daily
1992 <weekly-keyword> = weekly
1993 <monthly-keyword> = monthly
1994 <hourly-keyword> = hourly
1995 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
1996 <number> = <digit> | <digit><number>
1997 <12hour> = 0 | 1 | 2 | ... 12
1998 <hour> = 0 | 1 | 2 | ... 23
1999 <minute> = 0 | 1 | 2 | ... 59
2000 <day> = 1 | 2 | ... 31
2001 <time> = <hour>:<minute> |
2002 <12hour>:<minute>am |
2004 <time-spec> = <at-keyword> <time> |
2006 <date-keyword> = <void-keyword> <weekly-keyword>
2007 <day-range> = <day>-<day>
2008 <month-range> = <month-keyword>-<month-keyword>
2009 <wday-range> = <wday-keyword>-<wday-keyword>
2010 <range> = <day-range> | <month-range> |
2012 <date> = <date-keyword> | <day> | <range>
2013 <date-spec> = <date> | <date-spec>
2014 <day-spec> = <day> | <wday-keyword> |
2015 <day> | <wday-range> |
2016 <week-keyword> <wday-keyword> |
2017 <week-keyword> <wday-range> |
2019 <month-spec> = <month-keyword> | <month-range> |
2021 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2027 Note, the Week of Year specification wnn follows the ISO standard definition
2028 of the week of the year, where Week 1 is the week in which the first Thursday
2029 of the year occurs, or alternatively, the week which contains the 4th of
2030 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2031 precedes the first ISO week (i.e. has the first few days of the year if any
2032 occur before Thursday). w00 is not defined by the ISO specification. A week
2033 starts with Monday and ends with Sunday.
2035 According to the NIST (US National Institute of Standards and Technology),
2036 12am and 12pm are ambiguous and can be defined to anything. However,
2037 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2038 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2039 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2040 am/pm). This is the definition in Bacula version 2.0.3 and later.
2042 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2043 with level full each Sunday at 2:05am and an incremental job Monday through
2044 Saturday at 2:05am is:
2049 Name = "WeeklyCycle"
2050 Run = Level=Full sun at 2:05
2051 Run = Level=Incremental mon-sat at 2:05
2056 An example of a possible monthly cycle is as follows:
2061 Name = "MonthlyCycle"
2062 Run = Level=Full Pool=Monthly 1st sun at 2:05
2063 Run = Level=Differential 2nd-5th sun at 2:05
2064 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2069 The first of every month:
2075 Run = Level=Full on 1 at 2:05
2076 Run = Level=Incremental on 2-31 at 2:05
2087 Run = Level=Full hourly at 0:05
2088 Run = Level=Full hourly at 0:15
2089 Run = Level=Full hourly at 0:25
2090 Run = Level=Full hourly at 0:35
2091 Run = Level=Full hourly at 0:45
2092 Run = Level=Full hourly at 0:55
2097 \section{Technical Notes on Schedules}
2098 \index[general]{Schedules!Technical Notes on}
2099 \index[general]{Technical Notes on Schedules}
2101 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2102 minute field to each schedule. The masks are hour, day of the month (mday),
2103 month, day of the week (wday), week of the month (wom), and week of the year
2104 (woy). The schedule is initialized to have the bits of each of these masks
2105 set, which means that at the beginning of every hour, the job will run. When
2106 you specify a month for the first time, the mask will be cleared and the bit
2107 corresponding to your selected month will be selected. If you specify a second
2108 month, the bit corresponding to it will also be added to the mask. Thus when
2109 Bacula checks the masks to see if the bits are set corresponding to the
2110 current time, your job will run only in the two months you have set. Likewise,
2111 if you set a time (hour), the hour mask will be cleared, and the hour you
2112 specify will be set in the bit mask and the minutes will be stored in the
2115 For any schedule you have defined, you can see how these bits are set by doing
2116 a {\bf show schedules} command in the Console program. Please note that the
2117 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2121 \section{The Client Resource}
2122 \label{ClientResource2}
2123 \index[general]{Resource!Client}
2124 \index[general]{Client Resource}
2126 The Client resource defines the attributes of the Clients that are served by
2127 this Director; that is the machines that are to be backed up. You will need
2128 one Client resource definition for each machine to be backed up.
2132 \item [Client (or FileDaemon)]
2133 \index[dir]{Client (or FileDaemon)}
2134 \index[dir]{Directive!Client (or FileDaemon)}
2135 Start of the Client directives.
2137 \item [Name = \lt{}name\gt{}]
2139 \index[dir]{Directive!Name}
2140 The client name which will be used in the Job resource directive or in the
2141 console run command. This directive is required.
2143 \item [Address = \lt{}address\gt{}]
2144 \index[dir]{Address}
2145 \index[dir]{Directive!FD Address}
2146 \index[dir]{File Daemon Address}
2147 \index[dir]{Client Address}
2148 Where the address is a host name, a fully qualified domain name, or a
2149 network address in dotted quad notation for a Bacula File server daemon.
2150 This directive is required.
2152 \item [FD Port = \lt{}port-number\gt{}]
2153 \index[dir]{FD Port}
2154 \index[dir]{Directive!FD Port}
2155 Where the port is a port number at which the Bacula File server daemon can
2156 be contacted. The default is 9102.
2158 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2159 \index[dir]{Catalog}
2160 \index[dir]{Directive!Catalog}
2161 This specifies the name of the catalog resource to be used for this Client.
2162 This directive is required.
2164 \item [Password = \lt{}password\gt{}]
2165 \index[dir]{Password}
2166 \index[dir]{Directive!Password}
2167 This is the password to be used when establishing a connection with the File
2168 services, so the Client configuration file on the machine to be backed up
2169 must have the same password defined for this Director. This directive is
2170 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2171 Bacula will generate a random password during the configuration process,
2172 otherwise it will be left blank.
2174 The password is plain text. It is not generated through any special
2175 process, but it is preferable for security reasons to make the text
2178 \label{FileRetention}
2179 \item [File Retention = \lt{}time-period-specification\gt{}]
2180 \index[dir]{File Retention}
2181 \index[dir]{Directive!File Retention}
2182 The File Retention directive defines the length of time that Bacula will
2183 keep File records in the Catalog database after the End time of the
2184 Job corresponding to the File records.
2185 When this time period expires, and if
2186 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2187 that are older than the specified File Retention period. Note, this affects
2188 only records in the catalog database. It does not affect your archive
2191 File records may actually be retained for a shorter period than you specify
2192 on this directive if you specify either a shorter {\bf Job Retention} or a
2193 shorter {\bf Volume Retention} period. The shortest retention period of the
2194 three takes precedence. The time may be expressed in seconds, minutes,
2195 hours, days, weeks, months, quarters, or years. See the
2196 \ilink{ Configuration chapter}{Time} of this manual for
2197 additional details of time specification.
2199 The default is 60 days.
2201 \label{JobRetention}
2202 \item [Job Retention = \lt{}time-period-specification\gt{}]
2203 \index[dir]{Job Retention}
2204 \index[dir]{Directive!Job Retention}
2205 The Job Retention directive defines the length of time that Bacula will keep
2206 Job records in the Catalog database after the Job End time. When
2207 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2208 Bacula will prune (remove) Job records that are older than the specified
2209 File Retention period. As with the other retention periods, this
2210 affects only records in the catalog and not data in your archive backup.
2212 If a Job record is selected for pruning, all associated File and JobMedia
2213 records will also be pruned regardless of the File Retention period set.
2214 As a consequence, you normally will set the File retention period to be
2215 less than the Job retention period. The Job retention period can actually
2216 be less than the value you specify here if you set the {\bf Volume
2217 Retention} directive in the Pool resource to a smaller duration. This is
2218 because the Job retention period and the Volume retention period are
2219 independently applied, so the smaller of the two takes precedence.
2221 The Job retention period is specified as seconds, minutes, hours, days,
2222 weeks, months, quarters, or years. See the
2223 \ilink{ Configuration chapter}{Time} of this manual for
2224 additional details of time specification.
2226 The default is 180 days.
2229 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2230 \index[dir]{AutoPrune}
2231 \index[dir]{Directive!AutoPrune}
2232 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2233 will automatically apply the File retention period and the Job retention
2234 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2235 pruning will not be done, and your Catalog will grow in size each time you
2236 run a Job. Pruning affects only information in the catalog and not data
2237 stored in the backup archives (on Volumes).
2239 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2240 \index[dir]{Maximum Concurrent Jobs}
2241 \index[dir]{Directive!Maximum Concurrent Jobs}
2242 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2243 that can run concurrently. Note, this directive limits only Jobs for Clients
2244 with the same name as the resource in which it appears. Any other
2245 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2246 Storage resources will also apply in addition to any limit specified here.
2247 The default is set to 1, but you may set it to a larger number.
2249 \item [Priority = \lt{}number\gt{}]
2250 \index[dir]{Priority}
2251 \index[dir]{Directive!Priority}
2252 The number specifies the priority of this client relative to other clients
2253 that the Director is processing simultaneously. The priority can range from
2254 1 to 1000. The clients are ordered such that the smaller number priorities
2255 are performed first (not currently implemented).
2258 The following is an example of a valid Client resource definition:
2264 FDAddress = minimatou
2266 Password = very_good
2271 \section{The Storage Resource}
2272 \label{StorageResource2}
2273 \index[general]{Resource!Storage}
2274 \index[general]{Storage Resource}
2276 The Storage resource defines which Storage daemons are available for use by
2282 \index[dir]{Storage}
2283 \index[dir]{Directive!Storage}
2284 Start of the Storage resources. At least one storage resource must be
2287 \item [Name = \lt{}name\gt{}]
2289 \index[dir]{Directive!Name}
2290 The name of the storage resource. This name appears on the Storage directive
2291 specified in the Job resource and is required.
2293 \item [Address = \lt{}address\gt{}]
2294 \index[dir]{Address}
2295 \index[dir]{Directive!SD Address}
2296 \index[dir]{Storage daemon Address}
2297 Where the address is a host name, a {\bf fully qualified domain name}, or an
2298 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2299 will be transmitted to the File daemon who will then use it to contact the
2300 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2301 the name but rather a fully qualified machine name or an IP address. This
2302 directive is required.
2304 \item [SD Port = \lt{}port\gt{}]
2305 \index[dir]{SD Port}
2306 \index[dir]{Directive!SD Port}
2307 Where port is the port to use to contact the storage daemon for information
2308 and to start jobs. This same port number must appear in the Storage resource
2309 of the Storage daemon's configuration file. The default is 9103.
2311 \item [Password = \lt{}password\gt{}]
2312 \index[dir]{Password}
2313 \index[dir]{Directive!Password}
2314 This is the password to be used when establishing a connection with the
2315 Storage services. This same password also must appear in the Director
2316 resource of the Storage daemon's configuration file. This directive is
2317 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2318 Bacula will generate a random password during the configuration process,
2319 otherwise it will be left blank.
2321 The password is plain text. It is not generated through any special
2322 process, but it is preferable for security reasons to use random text.
2324 \item [Device = \lt{}device-name\gt{}]
2326 \index[dir]{Directive!Device}
2327 This directive specifies the Storage daemon's name of the device
2328 resource to be used for the storage. If you are using an Autochanger,
2329 the name specified here should be the name of the Storage daemon's
2330 Autochanger resource rather than the name of an individual device. This
2331 name is not the physical device name, but the logical device name as
2332 defined on the {\bf Name} directive contained in the {\bf Device} or the
2333 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2334 configuration file. You can specify any name you would like (even the
2335 device name if you prefer) up to a maximum of 127 characters in length.
2336 The physical device name associated with this device is specified in the
2337 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2338 Please take care not to define two different Storage resource directives
2339 in the Director that point to the same Device in the Storage daemon.
2340 Doing so may cause the Storage daemon to block (or hang) attempting to
2341 open the same device that is already open. This directive is required.
2344 \item [Media Type = \lt{}MediaType\gt{}]
2345 \index[dir]{Media Type}
2346 \index[dir]{Directive!Media Type}
2347 This directive specifies the Media Type to be used to store the data.
2348 This is an arbitrary string of characters up to 127 maximum that you
2349 define. It can be anything you want. However, it is best to make it
2350 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2351 ...). In addition, it is essential that you make the {\bf Media Type}
2352 specification unique for each storage media type. If you have two DDS-4
2353 drives that have incompatible formats, or if you have a DDS-4 drive and
2354 a DDS-4 autochanger, you almost certainly should specify different {\bf
2355 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2356 associated with the Job, Bacula can decide to use any Storage daemon
2357 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2359 If you are writing to disk Volumes, you must make doubly sure that each
2360 Device resource defined in the Storage daemon (and hence in the
2361 Director's conf file) has a unique media type. Otherwise for Bacula
2362 versions 1.38 and older, your restores may not work because Bacula
2363 will assume that you can mount any Media Type with the same name on
2364 any Device associated with that Media Type. This is possible with
2365 tape drives, but with disk drives, unless you are very clever you
2366 cannot mount a Volume in any directory -- this can be done by creating
2367 an appropriate soft link.
2369 Currently Bacula permits only a single Media Type per Storage
2370 and Device definition. Consequently, if
2371 you have a drive that supports more than one Media Type, you can
2372 give a unique string to Volumes with different intrinsic Media
2373 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2374 those volumes will only be mounted on drives indicated with the
2375 dual type (DDS-3-4).
2377 If you want to tie Bacula to using a single Storage daemon or drive, you
2378 must specify a unique Media Type for that drive. This is an important
2379 point that should be carefully understood. Note, this applies equally
2380 to Disk Volumes. If you define more than one disk Device resource in
2381 your Storage daemon's conf file, the Volumes on those two devices are in
2382 fact incompatible because one can not be mounted on the other device
2383 since they are found in different directories. For this reason, you
2384 probably should use two different Media Types for your two disk Devices
2385 (even though you might think of them as both being File types). You can
2386 find more on this subject in the \ilink{Basic Volume
2387 Management}{DiskChapter} chapter of this manual.
2389 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2390 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2391 resource of the {\bf Storage daemon} configuration file. This directive
2392 is required, and it is used by the Director and the Storage daemon to
2393 ensure that a Volume automatically selected from the Pool corresponds to
2394 the physical device. If a Storage daemon handles multiple devices (e.g.
2395 will write to various file Volumes on different partitions), this
2396 directive allows you to specify exactly which device.
2398 As mentioned above, the value specified in the Director's Storage
2399 resource must agree with the value specified in the Device resource in
2400 the {\bf Storage daemon's} configuration file. It is also an additional
2401 check so that you don't try to write data for a DLT onto an 8mm device.
2403 \label{Autochanger1}
2404 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2405 \index[dir]{Autochanger}
2406 \index[dir]{Directive!Autochanger}
2407 If you specify {\bf yes} for this command (the default is {\bf no}),
2408 when you use the {\bf label} command or the {\bf add} command to create
2409 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2410 number. This simplifies creating database entries for Volumes in an
2411 autochanger. If you forget to specify the Slot, the autochanger will
2412 not be used. However, you may modify the Slot associated with a Volume
2413 at any time by using the {\bf update volume} or {\bf update slots}
2414 command in the console program. When {\bf autochanger} is enabled, the
2415 algorithm used by Bacula to search for available volumes will be
2416 modified to consider only Volumes that are known to be in the
2417 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2418 will attempt recycling, pruning, ..., and if still no volume is found,
2419 Bacula will search for any volume whether or not in the magazine. By
2420 privileging in changer volumes, this procedure minimizes operator
2421 intervention. The default is {\bf no}.
2423 For the autochanger to be used, you must also specify {\bf Autochanger =
2424 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2425 configuration file as well as other important Storage daemon
2426 configuration information. Please consult the \ilink{Using
2427 Autochangers}{AutochangersChapter} manual of this chapter for the
2428 details of using autochangers.
2430 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2431 \index[dir]{Maximum Concurrent Jobs}
2432 \index[dir]{Directive!Maximum Concurrent Jobs}
2433 where \lt{}number\gt{} is the maximum number of Jobs with the current
2434 Storage resource that can run concurrently. Note, this directive limits
2435 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2436 the maximum concurrent jobs such as in the Director, Job, or Client
2437 resources will also apply in addition to any limit specified here. The
2438 default is set to 1, but you may set it to a larger number. However, if
2439 you set the Storage daemon's number of concurrent jobs greater than one,
2440 we recommend that you read the waring documented under \ilink{Maximum
2441 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2442 turn data spooling on as documented in the \ilink{Data
2443 Spooling}{SpoolingChapter} chapter of this manual.
2445 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2446 \label{AllowCompression}
2447 \index[dir]{AllowCompression}
2448 \index[dir]{Directive!AllowCompression}
2450 This directive is optional, and if you specify {\bf No} (the default is {\bf
2451 Yes}), it will cause backups jobs running on this storage resource to run
2452 without client File Daemon compression. This effectively overrides
2453 compression options in FileSets used by jobs which use this storage
2456 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2457 \index[dir]{Heartbeat Interval}
2458 \index[dir]{Directive!Heartbeat}
2459 This directive is optional and if specified will cause the Director to
2460 set a keepalive interval (heartbeat) in seconds on each of the sockets
2461 it opens for the Storage resource. This value will override any
2462 specified at the Director level. It is implemented only on systems
2463 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2464 The default value is zero, which means no change is made to the socket.
2468 The following is an example of a valid Storage resource definition:
2472 # Definition of tape storage device
2476 Password = storage_password # password for Storage daemon
2477 Device = "HP DLT 80" # same as Device in Storage daemon
2478 Media Type = DLT8000 # same as MediaType in Storage daemon
2483 \section{The Pool Resource}
2484 \label{PoolResource}
2485 \index[general]{Resource!Pool}
2486 \index[general]{Pool Resource}
2488 The Pool resource defines the set of storage Volumes (tapes or files) to be
2489 used by Bacula to write the data. By configuring different Pools, you can
2490 determine which set of Volumes (media) receives the backup data. This permits,
2491 for example, to store all full backup data on one set of Volumes and all
2492 incremental backups on another set of Volumes. Alternatively, you could assign
2493 a different set of Volumes to each machine that you backup. This is most
2494 easily done by defining multiple Pools.
2496 Another important aspect of a Pool is that it contains the default attributes
2497 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2498 Volume when it is created. This avoids the need for you to answer a large
2499 number of questions when labeling a new Volume. Each of these attributes can
2500 later be changed on a Volume by Volume basis using the {\bf update} command in
2501 the console program. Note that you must explicitly specify which Pool Bacula
2502 is to use with each Job. Bacula will not automatically search for the correct
2505 Most often in Bacula installations all backups for all machines (Clients) go
2506 to a single set of Volumes. In this case, you will probably only use the {\bf
2507 Default} Pool. If your backup strategy calls for you to mount a different tape
2508 each day, you will probably want to define a separate Pool for each day. For
2509 more information on this subject, please see the
2510 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2514 To use a Pool, there are three distinct steps. First the Pool must be defined
2515 in the Director's configuration file. Then the Pool must be written to the
2516 Catalog database. This is done automatically by the Director each time that it
2517 starts, or alternatively can be done using the {\bf create} command in the
2518 console program. Finally, if you change the Pool definition in the Director's
2519 configuration file and restart Bacula, the pool will be updated alternatively
2520 you can use the {\bf update pool} console command to refresh the database
2521 image. It is this database image rather than the Director's resource image
2522 that is used for the default Volume attributes. Note, for the pool to be
2523 automatically created or updated, it must be explicitly referenced by a Job
2526 Next the physical media must be labeled. The labeling can either be done with
2527 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2528 program. The preferred method is to use the {\bf label} command in the {\bf
2531 Finally, you must add Volume names (and their attributes) to the Pool. For
2532 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2533 archive device specified for the job (i.e. if you are going to back up to a
2534 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2535 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2536 are backing up to files. When running a Job, you must explicitly specify which
2537 Pool to use. Bacula will then automatically select the next Volume to use from
2538 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2539 from the Pool is identical to that required by the Storage resource you have
2540 specified for the Job.
2542 If you use the {\bf label} command in the console program to label the
2543 Volumes, they will automatically be added to the Pool, so this last step is
2544 not normally required.
2546 It is also possible to add Volumes to the database without explicitly labeling
2547 the physical volume. This is done with the {\bf add} console command.
2549 As previously mentioned, each time Bacula starts, it scans all the Pools
2550 associated with each Catalog, and if the database record does not already
2551 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2552 probably should do an {\bf update pool} if you change the Pool definition, but
2553 currently, you must do this manually using the {\bf update pool} command in
2554 the Console program.
2556 The Pool Resource defined in the Director's configuration file
2557 (bacula-dir.conf) may contain the following directives:
2563 \index[dir]{Directive!Pool}
2564 Start of the Pool resource. There must be at least one Pool resource
2568 \item [Name = \lt{}name\gt{}]
2570 \index[dir]{Directive!Name}
2571 The name of the pool. For most applications, you will use the default
2572 pool name {\bf Default}. This directive is required.
2575 \item [Maximum Volumes = \lt{}number\gt{}]
2576 \index[dir]{Maximum Volumes}
2577 \index[dir]{Directive!Maximum Volumes}
2578 This directive specifies the maximum number of volumes (tapes or files)
2579 contained in the pool. This directive is optional, if omitted or set to
2580 zero, any number of volumes will be permitted. In general, this
2581 directive is useful for Autochangers where there is a fixed number of
2582 Volumes, or for File storage where you wish to ensure that the backups
2583 made to disk files do not become too numerous or consume too much space.
2585 \item [Pool Type = \lt{}type\gt{}]
2586 \index[dir]{Pool Type}
2587 \index[dir]{Directive!Pool Type}
2588 This directive defines the pool type, which corresponds to the type of
2589 Job being run. It is required and may be one of the following:
2599 Note, only Backup is current implemented.
2601 \item [Storage = \lt{}storage-resource-name\gt{}]
2602 \index[dir]{Storage}
2603 \index[dir]{Directive!Storage}
2604 The Storage directive defines the name of the storage services where you
2605 want to backup the FileSet data. For additional details, see the
2606 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2607 The Storage resource may also be specified in the Job resource,
2608 but the value, if any, in the Pool resource overrides any value
2609 in the Job. This Storage resource definition is not required by either
2610 the Job resource or in the Pool, but it must be specified in
2611 one or the other. If not configuration error will result.
2613 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2614 \index[dir]{Use Volume Once}
2615 \index[dir]{Directive!Use Volume Once}
2616 This directive if set to {\bf yes} specifies that each volume is to be
2617 used only once. This is most useful when the Media is a file and you
2618 want a new file for each backup that is done. The default is {\bf no}
2619 (i.e. use volume any number of times). This directive will most likely
2620 be phased out (deprecated), so you are recommended to use {\bf Maximum
2621 Volume Jobs = 1} instead.
2623 The value defined by this directive in the bacula-dir.conf file is the
2624 default value used when a Volume is created. Once the volume is
2625 created, changing the value in the bacula-dir.conf file will not change
2626 what is stored for the Volume. To change the value for an existing
2627 Volume you must use the {\bf update} command in the Console.
2629 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2630 using this directive with multiple simultaneous jobs.
2632 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2633 \index[dir]{Maximum Volume Jobs}
2634 \index[dir]{Directive!Maximum Volume Jobs}
2635 This directive specifies the maximum number of Jobs that can be written
2636 to the Volume. If you specify zero (the default), there is no limit.
2637 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2638 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2639 is marked {\bf Used} it can no longer be used for appending Jobs, much
2640 like the {\bf Full} status but it can be recycled if recycling is
2641 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2642 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2644 The value defined by this directive in the bacula-dir.conf
2645 file is the default value used when a Volume is created. Once the volume is
2646 created, changing the value in the bacula-dir.conf file will not change what
2647 is stored for the Volume. To change the value for an existing Volume you
2648 must use the {\bf update} command in the Console.
2650 If you are running multiple simultaneous jobs, this directive may not
2651 work correctly because when a drive is reserved for a job, this
2652 directive is not taken into account, so multiple jobs may try to
2653 start writing to the Volume. At some point, when the Media record is
2654 updated, multiple simultaneous jobs may fail since the Volume can no
2657 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2658 \index[dir]{Maximum Volume Files}
2659 \index[dir]{Directive!Maximum Volume Files}
2660 This directive specifies the maximum number of files that can be written
2661 to the Volume. If you specify zero (the default), there is no limit.
2662 Otherwise, when the number of files written to the Volume equals {\bf
2663 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2664 is marked {\bf Used} it can no longer be used for appending Jobs, much
2665 like the {\bf Full} status but it can be recycled if recycling is
2666 enabled and thus used again. This value is checked and the {\bf Used}
2667 status is set only at the end of a job that writes to the particular
2670 The value defined by this directive in the bacula-dir.conf file is the
2671 default value used when a Volume is created. Once the volume is
2672 created, changing the value in the bacula-dir.conf file will not change
2673 what is stored for the Volume. To change the value for an existing
2674 Volume you must use the {\bf update} command in the Console.
2676 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2677 \index[dir]{Maximum Volume Bytes}
2678 \index[dir]{Directive!Maximum Volume Bytes}
2679 This directive specifies the maximum number of bytes that can be written
2680 to the Volume. If you specify zero (the default), there is no limit
2681 except the physical size of the Volume. Otherwise, when the number of
2682 bytes written to the Volume equals {\bf size} the Volume will be marked
2683 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2684 used for appending Jobs, much like the {\bf Full} status but it can be
2685 recycled if recycling is enabled, and thus the Volume can be re-used
2686 after recycling. This value is checked and the {\bf Used} status set
2687 while the job is writing to the particular volume.
2689 This directive is particularly useful for restricting the size
2690 of disk volumes, and will work correctly even in the case of
2691 multiple simultaneous jobs writing to the volume.
2693 The value defined by this directive in the bacula-dir.conf file is the
2694 default value used when a Volume is created. Once the volume is
2695 created, changing the value in the bacula-dir.conf file will not change
2696 what is stored for the Volume. To change the value for an existing
2697 Volume you must use the {\bf update} command in the Console.
2699 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2700 \index[dir]{Volume Use Duration}
2701 \index[dir]{Directive!Volume Use Duration}
2702 The Volume Use Duration directive defines the time period that the
2703 Volume can be written beginning from the time of first data write to the
2704 Volume. If the time-period specified is zero (the default), the Volume
2705 can be written indefinitely. Otherwise, the next time a job
2706 runs that wants to access this Volume, and the time period from the
2707 first write to the volume (the first Job written) exceeds the
2708 time-period-specification, the Volume will be marked {\bf Used}, which
2709 means that no more Jobs can be appended to the Volume, but it may be
2710 recycled if recycling is enabled. Using the command {\bf
2711 status dir} applies algorithms similar to running jobs, so
2712 during such a command, the Volume status may also be changed.
2714 recycled, it will be available for use again.
2716 You might use this directive, for example, if you have a Volume used for
2717 Incremental backups, and Volumes used for Weekly Full backups. Once the
2718 Full backup is done, you will want to use a different Incremental
2719 Volume. This can be accomplished by setting the Volume Use Duration for
2720 the Incremental Volume to six days. I.e. it will be used for the 6
2721 days following a Full save, then a different Incremental volume will be
2722 used. Be careful about setting the duration to short periods such as 23
2723 hours, or you might experience problems of Bacula waiting for a tape
2724 over the weekend only to complete the backups Monday morning when an
2725 operator mounts a new tape.
2727 The use duration is checked and the {\bf Used} status is set only at the
2728 end of a job that writes to the particular volume, which means that even
2729 though the use duration may have expired, the catalog entry will not be
2730 updated until the next job that uses this volume is run. This
2731 directive is not intended to be used to limit volume sizes
2732 and will not work correctly (i.e. will fail jobs) if the use
2733 duration expires while multiple simultaneous jobs are writing
2736 Please note that the value defined by this directive in the bacula-dir.conf
2737 file is the default value used when a Volume is created. Once the volume is
2738 created, changing the value in the bacula-dir.conf file will not change what
2739 is stored for the Volume. To change the value for an existing Volume you
2741 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2743 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
2744 \index[dir]{Catalog Files}
2745 \index[dir]{Directive!Catalog Files}
2746 This directive defines whether or not you want the names of the files
2747 that were saved to be put into the catalog. The default is {\bf yes}.
2748 The advantage of specifying {\bf Catalog Files = No} is that you will
2749 have a significantly smaller Catalog database. The disadvantage is that
2750 you will not be able to produce a Catalog listing of the files backed up
2751 for each Job (this is often called Browsing). Also, without the File
2752 entries in the catalog, you will not be able to use the Console {\bf
2753 restore} command nor any other command that references File entries.
2755 \label{PoolAutoPrune}
2756 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2757 \index[dir]{AutoPrune}
2758 \index[dir]{Directive!AutoPrune}
2759 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2760 greater) will automatically apply the Volume Retention period when new
2761 Volume is needed and no appendable Volumes exist in the Pool. Volume
2762 pruning causes expired Jobs (older than the {\bf Volume Retention}
2763 period) to be deleted from the Catalog and permits possible recycling of
2766 \label{VolRetention}
2767 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2768 \index[dir]{Volume Retention}
2769 \index[dir]{Directive!Volume Retention}
2770 The Volume Retention directive defines the length of time that {\bf
2771 Bacula} will keep records associated with the Volume in
2772 the Catalog database after the End time of each Job written to the
2773 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2774 {\bf yes} Bacula may prune (remove) Job records that are older than the
2775 specified Volume Retention period if it is necessary to free up a
2776 Volume. Recycling will not occur until it is absolutely necessary to
2777 free up a volume (i.e. no other writable volume exists).
2778 All File records associated with pruned Jobs are also
2779 pruned. The time may be specified as seconds, minutes, hours, days,
2780 weeks, months, quarters, or years. The {\bf Volume Retention} is
2781 applied independently of the {\bf Job Retention} and the {\bf File
2782 Retention} periods defined in the Client resource. This means that all
2783 the retentions periods are applied in turn and that the shorter period
2784 is the one that effectively takes precedence. Note, that when the {\bf
2785 Volume Retention} period has been reached, and it is necessary to obtain
2786 a new volume, Bacula will prune both the Job and the File records. This
2787 pruning could also occur during a {\bf status dir} command because it
2788 uses similar algorithms for finding the next available Volume.
2790 It is important to know that when the Volume Retention period expires,
2791 Bacula does not automatically recycle a Volume. It attempts to keep the
2792 Volume data intact as long as possible before over writing the Volume.
2794 By defining multiple Pools with different Volume Retention periods, you
2795 may effectively have a set of tapes that is recycled weekly, another
2796 Pool of tapes that is recycled monthly and so on. However, one must
2797 keep in mind that if your {\bf Volume Retention} period is too short, it
2798 may prune the last valid Full backup, and hence until the next Full
2799 backup is done, you will not have a complete backup of your system, and
2800 in addition, the next Incremental or Differential backup will be
2801 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2802 Retention} period should be at twice the interval of your Full backups.
2803 This means that if you do a Full backup once a month, the minimum Volume
2804 retention period should be two months.
2806 The default Volume retention period is 365 days, and either the default
2807 or the value defined by this directive in the bacula-dir.conf file is
2808 the default value used when a Volume is created. Once the volume is
2809 created, changing the value in the bacula-dir.conf file will not change
2810 what is stored for the Volume. To change the value for an existing
2811 Volume you must use the {\bf update} command in the Console.
2813 \item [Action On Purge = \lt{Truncate}]
2814 \index[dir]{actiononpurge}
2816 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
2817 the volume when it is purged. It is useful to prevent disk based volumes from
2818 consuming too much space.
2823 Action On Purge = Truncate
2828 \label{PoolScratchPool}
2829 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
2830 \index[dir]{ScrachPool}
2831 \index[dir]{Directive!ScrachPool}
2832 This directive permits to specify a dedicate \textsl{Scratch} for the
2833 current pool. This pool will replace the special pool named \textsl{Scrach}
2834 for volume selection. For more information about \textsl{Scratch} see
2835 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
2836 when using multiple storage sharing the same mediatype or when you want to
2837 dedicate volumes to a particular set of pool.
2839 \label{PoolRecyclePool}
2840 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2841 \index[dir]{RecyclePool}
2842 \index[dir]{Directive!RecyclePool}
2843 This directive defines to which pool
2844 the Volume will be placed (moved) when it is recycled. Without
2845 this directive, a Volume will remain in the same pool when it is
2846 recycled. With this directive, it can be moved automatically to any
2847 existing pool during a recycle. This directive is probably most
2848 useful when defined in the Scratch pool, so that volumes will
2849 be recycled back into the Scratch pool. For more on the see the
2850 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2852 Although this directive is called RecyclePool, the Volume in
2853 question is actually moved from its current pool to the one
2854 you specify on this directive when Bacula prunes the Volume and
2855 discovers that there are no records left in the catalog and hence
2856 marks it as {\bf Purged}.
2860 \item [Recycle = \lt{}yes\vb{}no\gt{}]
2861 \index[dir]{Recycle}
2862 \index[dir]{Directive!Recycle}
2863 This directive specifies whether or not Purged Volumes may be recycled.
2864 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2865 none that are appendable, it will search for and recycle (reuse) Purged
2866 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2867 deleted from the Catalog). If the Volume is recycled, all previous data
2868 written to that Volume will be overwritten. If Recycle is set to {\bf
2869 no}, the Volume will not be recycled, and hence, the data will remain
2870 valid. If you want to reuse (re-write) the Volume, and the recycle flag
2871 is no (0 in the catalog), you may manually set the recycle flag (update
2872 command) for a Volume to be reused.
2874 Please note that the value defined by this directive in the
2875 bacula-dir.conf file is the default value used when a Volume is created.
2876 Once the volume is created, changing the value in the bacula-dir.conf
2877 file will not change what is stored for the Volume. To change the value
2878 for an existing Volume you must use the {\bf update} command in the
2881 When all Job and File records have been pruned or purged from the
2882 catalog for a particular Volume, if that Volume is marked as
2883 Append, Full, Used, or Error, it will then be marked as Purged. Only
2884 Volumes marked as Purged will be considered to be converted to the
2885 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
2888 \label{RecycleOldest}
2889 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
2890 \index[dir]{Recycle Oldest Volume}
2891 \index[dir]{Directive!Recycle Oldest Volume}
2892 This directive instructs the Director to search for the oldest used
2893 Volume in the Pool when another Volume is requested by the Storage
2894 daemon and none are available. The catalog is then {\bf pruned}
2895 respecting the retention periods of all Files and Jobs written to this
2896 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
2897 Volume is recycled and will be used as the next Volume to be written.
2898 This directive respects any Job, File, or Volume retention periods that
2899 you may have specified, and as such it is {\bf much} better to use this
2900 directive than the Purge Oldest Volume.
2902 This directive can be useful if you have a fixed number of Volumes in the
2903 Pool and you want to cycle through them and you have specified the correct
2906 However, if you use this directive and have only one
2907 Volume in the Pool, you will immediately recycle your Volume if you fill
2908 it and Bacula needs another one. Thus your backup will be totally invalid.
2909 Please use this directive with care. The default is {\bf no}.
2911 \label{RecycleCurrent}
2913 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
2914 \index[dir]{Recycle Current Volume}
2915 \index[dir]{Directive!Recycle Current Volume}
2916 If Bacula needs a new Volume, this directive instructs Bacula to Prune
2917 the volume respecting the Job and File retention periods. If all Jobs
2918 are pruned (i.e. the volume is Purged), then the Volume is recycled and
2919 will be used as the next Volume to be written. This directive respects
2920 any Job, File, or Volume retention periods that you may have specified,
2921 and thus it is {\bf much} better to use it rather than the Purge Oldest
2924 This directive can be useful if you have: a fixed number of Volumes in
2925 the Pool, you want to cycle through them, and you have specified
2926 retention periods that prune Volumes before you have cycled through the
2929 However, if you use this directive and have only one Volume in the Pool,
2930 you will immediately recycle your Volume if you fill it and Bacula needs
2931 another one. Thus your backup will be totally invalid. Please use this
2932 directive with care. The default is {\bf no}.
2936 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
2937 \index[dir]{Purge Oldest Volume}
2938 \index[dir]{Directive!Purge Oldest Volume}
2939 This directive instructs the Director to search for the oldest used
2940 Volume in the Pool when another Volume is requested by the Storage
2941 daemon and none are available. The catalog is then {\bf purged}
2942 irrespective of retention periods of all Files and Jobs written to this
2943 Volume. The Volume is then recycled and will be used as the next Volume
2944 to be written. This directive overrides any Job, File, or Volume
2945 retention periods that you may have specified.
2947 This directive can be useful if you have a fixed number of Volumes in
2948 the Pool and you want to cycle through them and reusing the oldest one
2949 when all Volumes are full, but you don't want to worry about setting
2950 proper retention periods. However, by using this option you risk losing
2953 Please be aware that {\bf Purge Oldest Volume} disregards all retention
2954 periods. If you have only a single Volume defined and you turn this
2955 variable on, that Volume will always be immediately overwritten when it
2956 fills! So at a minimum, ensure that you have a decent number of Volumes
2957 in your Pool before running any jobs. If you want retention periods to
2958 apply do not use this directive. To specify a retention period, use the
2959 {\bf Volume Retention} directive (see above).
2961 We {\bf highly} recommend against using this directive, because it is
2962 sure that some day, Bacula will recycle a Volume that contains current
2963 data. The default is {\bf no}.
2965 \item [Cleaning Prefix = \lt{}string\gt{}]
2966 \index[dir]{Cleaning Prefix}
2967 \index[dir]{Directive!Cleaning Prefix}
2968 This directive defines a prefix string, which if it matches the
2969 beginning of a Volume name during labeling of a Volume, the Volume will
2970 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
2971 never attempt to use this tape. This is primarily for use with
2972 autochangers that accept barcodes where the convention is that barcodes
2973 beginning with {\bf CLN} are treated as cleaning tapes.
2976 \item [Label Format = \lt{}format\gt{}]
2977 \index[dir]{Label Format}
2978 \index[dir]{Directive!Label Format}
2979 This directive specifies the format of the labels contained in this
2980 pool. The format directive is used as a sort of template to create new
2981 Volume names during automatic Volume labeling.
2983 The {\bf format} should be specified in double quotes, and consists of
2984 letters, numbers and the special characters hyphen ({\bf -}), underscore
2985 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
2986 characters for a Volume name. The {\bf format} should be enclosed in
2989 In addition, the format may contain a number of variable expansion
2990 characters which will be expanded by a complex algorithm allowing you to
2991 create Volume names of many different formats. In all cases, the
2992 expansion process must resolve to the set of characters noted above that
2993 are legal Volume names. Generally, these variable expansion characters
2994 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
2995 specify variable expansion characters, you should always enclose the
2996 format with double quote characters ({\bf "}). For more details on
2997 variable expansion, please see the \ilink{Variable
2998 Expansion}{VarsChapter} Chapter of this manual.
3000 If no variable expansion characters are found in the string, the Volume
3001 name will be formed from the {\bf format} string appended with the
3002 a unique number that increases. If you do not remove volumes from the
3003 pool, this number should be the number of volumes plus one, but this
3004 is not guaranteed. The unique number will be edited as four
3005 digits with leading zeros. For example, with a {\bf Label Format =
3006 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3009 With the exception of Job specific variables, you can test your {\bf
3010 LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
3013 In almost all cases, you should enclose the format specification (part
3014 after the equal sign) in double quotes. Please note that this directive
3015 is deprecated and is replaced in version 1.37 and greater with a Python
3016 script for creating volume names.
3020 In order for a Pool to be used during a Backup Job, the Pool must have at
3021 least one Volume associated with it. Volumes are created for a Pool using
3022 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3023 program. In addition to adding Volumes to the Pool (i.e. putting the
3024 Volume names in the Catalog database), the physical Volume must be labeled
3025 with a valid Bacula software volume label before {\bf Bacula} will accept
3026 the Volume. This will be automatically done if you use the {\bf label}
3027 command. Bacula can automatically label Volumes if instructed to do so,
3028 but this feature is not yet fully implemented.
3030 The following is an example of a valid Pool resource definition:
3042 \subsection{The Scratch Pool}
3043 \label{TheScratchPool}
3044 \index[general]{Scratch Pool}
3045 In general, you can give your Pools any name you wish, but there is one
3046 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3047 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3048 writing and it cannot find one, it will look in the Scratch pool, and if
3049 it finds an available Volume, it will move it out of the Scratch pool into
3050 the Pool currently being used by the job.
3053 \section{The Catalog Resource}
3054 \label{CatalogResource}
3055 \index[general]{Resource!Catalog}
3056 \index[general]{Catalog Resource}
3058 The Catalog Resource defines what catalog to use for the current job.
3059 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3060 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3061 may be as many Catalogs (databases) defined as you wish. For example, you
3062 may want each Client to have its own Catalog database, or you may want
3063 backup jobs to use one database and verify or restore jobs to use another
3066 Since SQLite is compiled in, it always runs on the same machine
3067 as the Director and the database must be directly accessible (mounted) from
3068 the Director. However, since both MySQL and PostgreSQL are networked
3069 databases, they may reside either on the same machine as the Director
3070 or on a different machine on the network. See below for more details.
3075 \index[dir]{Catalog}
3076 \index[dir]{Directive!Catalog}
3077 Start of the Catalog resource. At least one Catalog resource must be
3081 \item [Name = \lt{}name\gt{}]
3083 \index[dir]{Directive!Name}
3084 The name of the Catalog. No necessary relation to the database server
3085 name. This name will be specified in the Client resource directive
3086 indicating that all catalog data for that Client is maintained in this
3087 Catalog. This directive is required.
3089 \item [password = \lt{}password\gt{}]
3090 \index[dir]{password}
3091 \index[dir]{Directive!password}
3092 This specifies the password to use when logging into the database. This
3093 directive is required.
3095 \item [DB Name = \lt{}name\gt{}]
3096 \index[dir]{DB Name}
3097 \index[dir]{Directive!DB Name}
3098 This specifies the name of the database. If you use multiple catalogs
3099 (databases), you specify which one here. If you are using an external
3100 database server rather than the internal one, you must specify a name
3101 that is known to the server (i.e. you explicitly created the Bacula
3102 tables using this name. This directive is required.
3104 \item [user = \lt{}user\gt{}]
3106 \index[dir]{Directive!user}
3107 This specifies what user name to use to log into the database. This
3108 directive is required.
3110 \item [DB Socket = \lt{}socket-name\gt{}]
3111 \index[dir]{DB Socket}
3112 \index[dir]{Directive!DB Socket}
3113 This is the name of a socket to use on the local host to connect to the
3114 database. This directive is used only by MySQL and is ignored by SQLite.
3115 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3116 will use the default socket. If the DB Socket is specified, the
3117 MySQL server must reside on the same machine as the Director.
3119 \item [DB Address = \lt{}address\gt{}]
3120 \index[dir]{DB Address}
3121 \index[dir]{Directive!DB Address}
3122 This is the host address of the database server. Normally, you would specify
3123 this instead of {\bf DB Socket} if the database server is on another machine.
3124 In that case, you will also specify {\bf DB Port}. This directive is used
3125 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3126 This directive is optional.
3128 \item [DB Port = \lt{}port\gt{}]
3129 \index[dir]{DB Port}
3130 \index[dir]{Directive!DB Port}
3131 This defines the port to be used in conjunction with {\bf DB Address} to
3132 access the database if it is on another machine. This directive is used only
3133 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3134 directive is optional.
3136 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3137 %% \index[dir]{Multiple Connections}
3138 %% \index[dir]{Directive!Multiple Connections}
3139 %% By default, this directive is set to no. In that case, each job that uses
3141 %% same Catalog will use a single connection to the catalog. It will be shared,
3142 %% and Bacula will allow only one Job at a time to communicate. If you set this
3143 %% directive to yes, Bacula will permit multiple connections to the database,
3144 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3145 %% this is no problem. For MySQL, you must be *very* careful to have the
3146 %% multi-thread version of the client library loaded on your system. When this
3147 %% directive is set yes, each Job will have a separate connection to the
3148 %% database, and the database will control the interaction between the
3150 %% Jobs. This can significantly speed up the database operations if you are
3151 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3152 %% Bacula will automatically enable transactions. This can significantly speed
3153 %% up insertion of attributes in the database either for a single Job or
3154 %% multiple simultaneous Jobs.
3156 %% This directive has not been tested. Please test carefully before running it
3157 %% in production and report back your results.
3161 The following is an example of a valid Catalog resource definition:
3170 password = "" # no password = no security
3175 or for a Catalog on another machine:
3185 DB Address = remote.acme.com
3191 \section{The Messages Resource}
3192 \label{MessagesResource2}
3193 \index[general]{Resource!Messages}
3194 \index[general]{Messages Resource}
3196 For the details of the Messages Resource, please see the
3197 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3200 \section{The Console Resource}
3201 \label{ConsoleResource1}
3202 \index[general]{Console Resource}
3203 \index[general]{Resource!Console}
3205 As of Bacula version 1.33 and higher, there are three different kinds of
3206 consoles, which the administrator or user can use to interact with the
3207 Director. These three kinds of consoles comprise three different security
3211 \item The first console type is an {\bf anonymous} or {\bf default} console,
3212 which has full privileges. There is no console resource necessary for
3213 this type since the password is specified in the Director's resource and
3214 consequently such consoles do not have a name as defined on a {\bf Name
3215 =} directive. This is the kind of console that was initially
3216 implemented in versions prior to 1.33 and remains valid. Typically you
3217 would use it only for administrators.
3219 \item The second type of console, and new to version 1.33 and higher is a
3220 "named" console defined within a Console resource in both the Director's
3221 configuration file and in the Console's configuration file. Both the
3222 names and the passwords in these two entries must match much as is the
3223 case for Client programs.
3225 This second type of console begins with absolutely no privileges except
3226 those explicitly specified in the Director's Console resource. Thus you
3227 can have multiple Consoles with different names and passwords, sort of
3228 like multiple users, each with different privileges. As a default,
3229 these consoles can do absolutely nothing -- no commands whatsoever. You
3230 give them privileges or rather access to commands and resources by
3231 specifying access control lists in the Director's Console resource. The
3232 ACLs are specified by a directive followed by a list of access names.
3233 Examples of this are shown below.
3235 \item The third type of console is similar to the above mentioned one in that
3236 it requires a Console resource definition in both the Director and the
3237 Console. In addition, if the console name, provided on the {\bf Name =}
3238 directive, is the same as a Client name, that console is permitted to
3239 use the {\bf SetIP} command to change the Address directive in the
3240 Director's client resource to the IP address of the Console. This
3241 permits portables or other machines using DHCP (non-fixed IP addresses)
3242 to "notify" the Director of their current IP address.
3245 The Console resource is optional and need not be specified. The following
3246 directives are permitted within the Director's configuration resource:
3250 \item [Name = \lt{}name\gt{}]
3252 \index[dir]{Directive!Name}
3253 The name of the console. This name must match the name specified in the
3254 Console's configuration resource (much as is the case with Client
3257 \item [Password = \lt{}password\gt{}]
3258 \index[dir]{Password}
3259 \index[dir]{Directive!Password}
3260 Specifies the password that must be supplied for a named Bacula Console
3261 to be authorized. The same password must appear in the {\bf Console}
3262 resource of the Console configuration file. For added security, the
3263 password is never actually passed across the network but rather a
3264 challenge response hash code created with the password. This directive
3265 is required. If you have either {\bf /dev/random} {\bf bc} on your
3266 machine, Bacula will generate a random password during the configuration
3267 process, otherwise it will be left blank.
3269 The password is plain text. It is not generated through any special
3270 process. However, it is preferable for security reasons to choose
3273 \item [JobACL = \lt{}name-list\gt{}]
3275 \index[dir]{Directive!JobACL}
3276 This directive is used to specify a list of Job resource names that can
3277 be accessed by the console. Without this directive, the console cannot
3278 access any of the Director's Job resources. Multiple Job resource names
3279 may be specified by separating them with commas, and/or by specifying
3280 multiple JobACL directives. For example, the directive may be specified
3285 JobACL = kernsave, "Backup client 1", "Backup client 2"
3286 JobACL = "RestoreFiles"
3291 With the above specification, the console can access the Director's resources
3292 for the four jobs named on the JobACL directives, but for no others.
3294 \item [ClientACL = \lt{}name-list\gt{}]
3295 \index[dir]{ClientACL}
3296 \index[dir]{Directive!ClientACL}
3297 This directive is used to specify a list of Client resource names that can
3299 accessed by the console.
3301 \item [StorageACL = \lt{}name-list\gt{}]
3302 \index[dir]{StorageACL}
3303 \index[dir]{Directive!StorageACL}
3304 This directive is used to specify a list of Storage resource names that can
3305 be accessed by the console.
3307 \item [ScheduleACL = \lt{}name-list\gt{}]
3308 \index[dir]{ScheduleACL}
3309 \index[dir]{Directive!ScheduleACL}
3310 This directive is used to specify a list of Schedule resource names that can
3311 be accessed by the console.
3313 \item [PoolACL = \lt{}name-list\gt{}]
3314 \index[dir]{PoolACL}
3315 \index[dir]{Directive!PoolACL}
3316 This directive is used to specify a list of Pool resource names that can be
3317 accessed by the console.
3319 \item [FileSetACL = \lt{}name-list\gt{}]
3320 \index[dir]{FileSetACL}
3321 \index[dir]{Directive!FileSetACL}
3322 This directive is used to specify a list of FileSet resource names that
3323 can be accessed by the console.
3325 \item [CatalogACL = \lt{}name-list\gt{}]
3326 \index[dir]{CatalogACL}
3327 \index[dir]{Directive!CatalogACL}
3328 This directive is used to specify a list of Catalog resource names that
3329 can be accessed by the console.
3331 \item [CommandACL = \lt{}name-list\gt{}]
3332 \index[dir]{CommandACL}
3333 \index[dir]{Directive!CommandACL}
3334 This directive is used to specify a list of of console commands that can
3335 be executed by the console.
3337 \item [WhereACL = \lt{}string\gt{}]
3338 \index[dir]{WhereACL}
3339 \index[dir]{Directive!WhereACL}
3340 This directive permits you to specify where a restricted console
3341 can restore files. If this directive is not specified, only the
3342 default restore location is permitted (normally {\bf
3343 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3344 user enters will be accepted (not very secure), any other
3345 value specified (there may be multiple WhereACL directives) will
3346 restrict the user to use that path. For example, on a Unix system,
3347 if you specify "/", the file will be restored to the original
3348 location. This directive is untested.
3352 Aside from Director resource names and console command names, the special
3353 keyword {\bf *all*} can be specified in any of the above access control lists.
3354 When this keyword is present, any resource or command name (which ever is
3355 appropriate) will be accepted. For an example configuration file, please see
3357 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3360 \section{The Counter Resource}
3361 \label{CounterResource}
3362 \index[general]{Resource!Counter}
3363 \index[general]{Counter Resource}
3365 The Counter Resource defines a counter variable that can be accessed by
3366 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3368 \ilink{LabelFormat}{Label} directive in this chapter for more
3374 \index[dir]{Counter}
3375 \index[dir]{Directive!Counter}
3376 Start of the Counter resource. Counter directives are optional.
3378 \item [Name = \lt{}name\gt{}]
3380 \index[dir]{Directive!Name}
3381 The name of the Counter. This is the name you will use in the variable
3382 expansion to reference the counter value.
3384 \item [Minimum = \lt{}integer\gt{}]
3385 \index[dir]{Minimum}
3386 \index[dir]{Directive!Minimum}
3387 This specifies the minimum value that the counter can have. It also becomes
3388 the default. If not supplied, zero is assumed.
3390 \item [Maximum = \lt{}integer\gt{}]
3391 \index[dir]{Maximum}
3392 \index[dir]{Directive!Maximum}
3393 \index[dir]{Directive!Maximum}
3394 This is the maximum value value that the counter can have. If not specified
3395 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3396 the 31 power). When the counter is incremented past this value, it is reset
3399 \item [*WrapCounter = \lt{}counter-name\gt{}]
3400 \index[dir]{*WrapCounter}
3401 \index[dir]{Directive!*WrapCounter}
3402 If this value is specified, when the counter is incremented past the
3404 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3405 is incremented. (This is not currently implemented).
3407 \item [Catalog = \lt{}catalog-name\gt{}]
3408 \index[dir]{Catalog}
3409 \index[dir]{Directive!Catalog}
3410 If this directive is specified, the counter and its values will be saved in
3411 the specified catalog. If this directive is not present, the counter will be
3412 redefined each time that Bacula is started.
3415 \section{Example Director Configuration File}
3416 \label{SampleDirectorConfiguration}
3417 \index[general]{File!Example Director Configuration}
3418 \index[general]{Example Director Configuration File}
3420 An example Director configuration file might be the following:
3425 # Default Bacula Director Configuration file
3427 # The only thing that MUST be changed is to add one or more
3428 # file or directory names in the Include directive of the
3431 # For Bacula release 1.15 (5 March 2002) -- redhat
3433 # You might also want to change the default email address
3434 # from root to your address. See the "mail" and "operator"
3435 # directives in the Messages resource.
3437 Director { # define myself
3439 QueryFile = "/home/kern/bacula/bin/query.sql"
3440 WorkingDirectory = "/home/kern/bacula/bin/working"
3441 PidDirectory = "/home/kern/bacula/bin/working"
3442 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3444 # Define the backup Job
3446 Name = "NightlySave"
3448 Level = Incremental # default
3451 Schedule = "WeeklyCycle"
3461 Where = /tmp/bacula-restores
3467 # List of files to be backed up
3471 Options { signature=SHA1}
3473 # Put your list of files here, one per line or include an
3474 # external list with:
3478 # Note: / backs up everything
3483 # When to do the backups
3485 Name = "WeeklyCycle"
3486 Run = level=Full sun at 2:05
3487 Run = level=Incremental mon-sat at 2:05
3489 # Client (File Services) to backup
3494 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3495 File Retention = 60d # sixty day file retention
3496 Job Retention = 1y # 1 year Job retention
3497 AutoPrune = yes # Auto apply retention periods
3499 # Definition of DLT tape storage device
3503 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3504 Device = "HP DLT 80" # same as Device in Storage daemon
3505 Media Type = DLT8000 # same as MediaType in Storage daemon
3507 # Definition for a DLT autochanger device
3511 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3512 Device = "Autochanger" # same as Device in Storage daemon
3513 Media Type = DLT-8000 # Different from DLTDrive
3516 # Definition of DDS tape storage device
3520 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3521 Device = SDT-10000 # same as Device in Storage daemon
3522 Media Type = DDS-4 # same as MediaType in Storage daemon
3524 # Definition of 8mm tape storage device
3528 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3529 Device = "Exabyte 8mm"
3532 # Definition of file storage device
3536 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3537 Device = FileStorage
3540 # Generic catalog service
3543 dbname = bacula; user = bacula; password = ""
3545 # Reasonable message delivery -- send most everything to
3546 # the email address and to the console
3549 mail = root@localhost = all, !skipped, !terminate
3550 operator = root@localhost = mount
3551 console = all, !skipped, !saved
3554 # Default pool definition
3562 # Restricted console used by tray-monitor to get the status of the director
3566 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3567 CommandACL = status, .status