4 \chapter{Configuring the Director}
5 \label{DirectorChapter}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
9 Of all the configuration files needed to run {\bf Bacula}, the Director's is
10 the most complicated, and the one that you will need to modify the most often
11 as you add clients or modify the FileSets.
13 For a general discussion of configuration files and resources including the
14 data types recognized by {\bf Bacula}. Please see the
15 \ilink{Configuration}{ConfigureChapter} chapter of this manual.
17 \section{Director Resource Types}
18 \index[general]{Types!Director Resource}
19 \index[general]{Director Resource Types}
21 Director resource type may be one of the following:
23 Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
24 Messages. We present them here in the most logical order for defining them:
26 Note, everything revolves around a job and is tied to a job in one
31 \ilink{Director}{DirectorResource4} -- to define the Director's
32 name and its access password used for authenticating the Console program.
33 Only a single Director resource definition may appear in the Director's
34 configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
35 machine, Bacula will generate a random password during the configuration
36 process, otherwise it will be left blank.
38 \ilink{Job}{JobResource} -- to define the backup/restore Jobs
39 and to tie together the Client, FileSet and Schedule resources to be used
40 for each Job. Normally, you will Jobs of different names corresponding
41 to each client (i.e. one Job per client, but a different one with a different name
44 \ilink{JobDefs}{JobDefsResource} -- optional resource for
45 providing defaults for Job resources.
47 \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
48 be automatically run by {\bf Bacula's} internal scheduler. You
49 may have any number of Schedules, but each job will reference only
52 \ilink{FileSet}{FileSetResource} -- to define the set of files
53 to be backed up for each Client. You may have any number of
54 FileSets but each Job will reference only one.
56 \ilink{Client}{ClientResource2} -- to define what Client is to be
57 backed up. You will generally have multiple Client definitions. Each
58 Job will reference only a single client.
60 \ilink{Storage}{StorageResource2} -- to define on what physical
61 device the Volumes should be mounted. You may have one or
62 more Storage definitions.
64 \ilink{Pool}{PoolResource} -- to define the pool of Volumes
65 that can be used for a particular Job. Most people use a
66 single default Pool. However, if you have a large number
67 of clients or volumes, you may want to have multiple Pools.
68 Pools allow you to restrict a Job (or a Client) to use
69 only a particular set of Volumes.
71 \ilink{Catalog}{CatalogResource} -- to define in what database to
72 keep the list of files and the Volume names where they are backed up.
73 Most people only use a single catalog. However, if you want to
74 scale the Director to many clients, multiple catalogs can be helpful.
75 Multiple catalogs require a bit more management because in general
76 you must know what catalog contains what data. Currently, all
77 Pools are defined in each catalog. This restriction will be removed
80 \ilink{Messages}{MessagesChapter} -- to define where error and
81 information messages are to be sent or logged. You may define
82 multiple different message resources and hence direct particular
83 classes of messages to different users or locations (files, ...).
86 \section{The Director Resource}
87 \label{DirectorResource4}
88 \index[general]{Director Resource}
89 \index[general]{Resource!Director}
91 The Director resource defines the attributes of the Directors running on the
92 network. In the current implementation, there is only a single Director
93 resource, but the final design will contain multiple Directors to maintain
94 index and media database redundancy.
100 Start of the Director resource. One and only one director resource must be
103 \item [Name = \lt{}name\gt{}]
105 \index[dir]{Directive!Name}
106 The director name used by the system administrator. This directive is
109 \item [Description = \lt{}text\gt{}]
110 \index[dir]{Description}
111 \index[dir]{Directive!Description}
112 The text field contains a description of the Director that will be displayed
113 in the graphical user interface. This directive is optional.
115 \item [Password = \lt{}UA-password\gt{}]
116 \index[dir]{Password}
117 \index[dir]{Directive!Password}
118 Specifies the password that must be supplied for the default Bacula
119 Console to be authorized. The same password must appear in the {\bf
120 Director} resource of the Console configuration file. For added
121 security, the password is never passed across the network but instead a
122 challenge response hash code created with the password. This directive
123 is required. If you have either {\bf /dev/random} or {\bf bc} on your
124 machine, Bacula will generate a random password during the configuration
125 process, otherwise it will be left blank and you must manually supply
128 The password is plain text. It is not generated through any special
129 process but as noted above, it is better to use random text for
132 \item [Messages = \lt{}Messages-resource-name\gt{}]
133 \index[dir]{Messages}
134 \index[dir]{Directive!Messages}
135 The messages resource specifies where to deliver Director messages that are
136 not associated with a specific Job. Most messages are specific to a job and
137 will be directed to the Messages resource specified by the job. However,
138 there are a few messages that can occur when no job is running. This
139 directive is required.
141 \item [Working Directory = \lt{}Directory\gt{}]
142 \index[dir]{Working Directory}
143 \index[dir]{Directive!Working Directory}
144 This directive is mandatory and specifies a directory in which the Director
145 may put its status files. This directory should be used only by Bacula but
146 may be shared by other Bacula daemons. However, please note, if this
147 directory is shared with other Bacula daemons (the File daemon and Storage
148 daemon), you must ensure that the {\bf Name} given to each daemon is
149 unique so that the temporary filenames used do not collide. By default
150 the Bacula configure process creates unique daemon names by postfixing them
151 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
152 Directory} is done when the configuration file is read so that values such
153 as {\bf \$HOME} will be properly expanded. This directive is required.
154 The working directory specified must already exist and be
155 readable and writable by the Bacula daemon referencing it.
157 If you have specified a Director user and/or a Director group on your
158 ./configure line with {\bf {-}{-}with-dir-user} and/or
159 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
160 be set to those values.
162 \item [Pid Directory = \lt{}Directory\gt{}]
163 \index[dir]{Pid Directory}
164 \index[dir]{Directive!Pid Directory}
165 This directive is mandatory and specifies a directory in which the Director
166 may put its process Id file. The process Id file is used to shutdown
167 Bacula and to prevent multiple copies of Bacula from running simultaneously.
168 Standard shell expansion of the {\bf Directory} is done when the
169 configuration file is read so that values such as {\bf \$HOME} will be
172 The PID directory specified must already exist and be
173 readable and writable by the Bacula daemon referencing it
175 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
176 not installing Bacula in the system directories, you can use the {\bf Working
177 Directory} as defined above. This directive is required.
179 \item [Scripts Directory = \lt{}Directory\gt{}]
180 \index[dir]{Scripts Directory}
181 \index[dir]{Directive!Scripts Directory}
182 This directive is optional and, if defined, specifies a directory in
183 which the Director will look for the Python startup script {\bf
184 DirStartup.py}. This directory may be shared by other Bacula daemons.
185 Standard shell expansion of the directory is done when the configuration
186 file is read so that values such as {\bf \$HOME} will be properly
189 \item [QueryFile = \lt{}Path\gt{}]
190 \index[dir]{QueryFile}
191 \index[dir]{Directive!QueryFile}
192 This directive is mandatory and specifies a directory and file in which
193 the Director can find the canned SQL statements for the {\bf Query}
194 command of the Console. Standard shell expansion of the {\bf Path} is
195 done when the configuration file is read so that values such as {\bf
196 \$HOME} will be properly expanded. This directive is required.
198 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
199 \index[dir]{Heartbeat Interval}
200 \index[dir]{Directive!Heartbeat}
201 This directive is optional and if specified will cause the Director to
202 set a keepalive interval (heartbeat) in seconds on each of the sockets
203 it opens for the Client resource. This value will override any
204 specified at the Director level. It is implemented only on systems
205 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
206 The default value is zero, which means no change is made to the socket.
209 \label{DirMaxConJobs}
210 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
211 \index[dir]{Maximum Concurrent Jobs}
212 \index[dir]{Directive!Maximum Concurrent Jobs}
213 \index[general]{Simultaneous Jobs}
214 \index[general]{Concurrent Jobs}
215 where \lt{}number\gt{} is the maximum number of total Director Jobs that
216 should run concurrently. The default is set to 1, but you may set it to a
219 The Volume format becomes more complicated with
220 multiple simultaneous jobs, consequently, restores may take longer if
221 Bacula must sort through interleaved volume blocks from multiple simultaneous
222 jobs. This can be avoided by having each simultaneous job write to
223 a different volume or by using data spooling, which will first spool the data
224 to disk simultaneously, then write one spool file at a time to the volume
225 thus avoiding excessive interleaving of the different job blocks.
227 \item [FD Connect Timeout = \lt{}time\gt{}]
228 \index[dir]{FD Connect Timeout}
229 \index[dir]{Directive!FD Connect Timeout}
230 where {\bf time} is the time that the Director should continue
231 attempting to contact the File daemon to start a job, and after which
232 the Director will cancel the job. The default is 30 minutes.
234 \item [SD Connect Timeout = \lt{}time\gt{}]
235 \index[dir]{SD Connect Timeout}
236 \index[dir]{Directive!SD Connect Timeout}
237 where {\bf time} is the time that the Director should continue
238 attempting to contact the Storage daemon to start a job, and after which
239 the Director will cancel the job. The default is 30 minutes.
241 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
242 \index[dir]{DirAddresses}
244 \index[general]{Address}
245 \index[dir]{Directive!DirAddresses}
246 Specify the ports and addresses on which the Director daemon will listen
247 for Bacula Console connections. Probably the simplest way to explain
248 this is to show an example:
253 ip = { addr = 1.2.3.4; port = 1205;}
255 addr = 1.2.3.4; port = http;}
264 ip = { addr = 1.2.3.4 }
265 ip = { addr = 201:220:222::2 }
267 addr = bluedot.thun.net
273 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
274 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
275 a symbolic name (only in the ip specification). Also, port can be specified
276 as a number or as the mnemonic value from the /etc/services file. If a port
277 is not specified, the default will be used. If an ip section is specified,
278 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
279 only IPv4 resolutions will be permitted, and likewise with ip6.
281 Please note that if you use the DirAddresses directive, you must
282 not use either a DirPort or a DirAddress directive in the same
285 \item [DirPort = \lt{}port-number\gt{}]
287 \index[dir]{Directive!DirPort}
288 Specify the port (a positive integer) on which the Director daemon will
289 listen for Bacula Console connections. This same port number must be
290 specified in the Director resource of the Console configuration file. The
291 default is 9101, so normally this directive need not be specified. This
292 directive should not be used if you specify DirAddresses (N.B plural)
295 \item [DirAddress = \lt{}IP-Address\gt{}]
296 \index[dir]{DirAddress}
297 \index[dir]{Directive!DirAddress}
298 This directive is optional, but if it is specified, it will cause the
299 Director server (for the Console program) to bind to the specified {\bf
300 IP-Address}, which is either a domain name or an IP address specified as a
301 dotted quadruple in string or quoted string format. If this directive is
302 not specified, the Director will bind to any available address (the
303 default). Note, unlike the DirAddresses specification noted above, this
304 directive only permits a single address to be specified. This directive
305 should not be used if you specify a DirAddresses (N.B. plural) directive.
307 \item [DirSourceAddress = \lt{}IP-Address\gt{}]
308 \index[fd]{DirSourceAddress}
309 \index[fd]{Directive!DirSourceAddress}
310 This record is optional, and if it is specified, it will cause the Director
311 server (when initiating connections to a storage or file daemon) to source
312 its connections from the specified address. Only a single IP address may be
313 specified. If this record is not specified, the Director server will source
314 its outgoing connections according to the system routing table (the default).
316 \item[Statistics Retention = \lt{}time\gt{}]
317 \index[dir]{StatisticsRetention}
318 \index[dir]{Directive!StatisticsRetention}
319 \label{PruneStatistics}
321 The \texttt{Statistics Retention} directive defines the length of time that
322 Bacula will keep statistics job records in the Catalog database after the
323 Job End time. (In \texttt{JobHistory} table) When this time period expires,
324 and if user runs \texttt{prune stats} command, Bacula will prune (remove)
325 Job records that are older than the specified period.
327 Theses statistics records aren't use for restore purpose, but mainly for
328 capacity planning, billings, etc. See \ilink{Statistics chapter} for
329 additional information.
331 See the \ilink{ Configuration chapter}{Time} of this manual for additional
332 details of time specification.
334 The default is 5 years.
336 \item[VerId = \lt{}string\gt{}]
337 \index[dir]{Directive!VerId}
338 where \lt{}string\gt{} is an identifier which can be used for support purpose.
339 This string is displayed using the \texttt{version} command.
341 \item[MaximumConsoleConnections = \lt{}number\gt{}]
342 \index[dir]{MaximumConsoleConnections}
343 \index[dir]{Directive!MaximumConsoleConnections}
345 where \lt{}number\gt{} is the maximum number of Console Connections that
346 could run concurrently. The default is set to 20, but you may set it to a
351 The following is an example of a valid Director resource definition:
357 WorkingDirectory = "$HOME/bacula/bin/working"
358 Password = UA_password
359 PidDirectory = "$HOME/bacula/bin/working"
360 QueryFile = "$HOME/bacula/bin/query.sql"
366 \section{The Job Resource}
368 \index[general]{Resource!Job}
369 \index[general]{Job Resource}
371 The Job resource defines a Job (Backup, Restore, ...) that Bacula must
372 perform. Each Job resource definition contains the name of a Client and
373 a FileSet to backup, the Schedule for the Job, where the data
374 are to be stored, and what media Pool can be used. In effect, each Job
375 resource must specify What, Where, How, and When or FileSet, Storage,
376 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
377 be specified for a restore job for historical reasons, but it is no longer used.
379 Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
380 job. If you want to backup multiple FileSets on the same Client or multiple
381 Clients, you must define a Job for each one.
383 Note, you define only a single Job to do the Full, Differential, and
384 Incremental backups since the different backup levels are tied together by
385 a unique Job name. Normally, you will have only one Job per Client, but
386 if a client has a really huge number of files (more than several million),
387 you might want to split it into to Jobs each with a different FileSet
388 covering only part of the total files.
390 Multiple Storage daemons are not currently supported for Jobs, so if
391 you do want to use multiple storage daemons, you will need to create
392 a different Job and ensure that for each Job that the combination of
393 Client and FileSet are unique. The Client and FileSet are what Bacula
394 uses to restore a client, so if there are multiple Jobs with the same
395 Client and FileSet or multiple Storage daemons that are used, the
396 restore will not work. This problem can be resolved by defining multiple
397 FileSet definitions (the names must be different, but the contents of
398 the FileSets may be the same).
405 \index[dir]{Directive!Job}
406 Start of the Job resource. At least one Job resource is required.
408 \item [Name = \lt{}name\gt{}]
410 \index[dir]{Directive!Name}
411 The Job name. This name can be specified on the {\bf Run} command in the
412 console program to start a job. If the name contains spaces, it must be
413 specified between quotes. It is generally a good idea to give your job the
414 same name as the Client that it will backup. This permits easy
415 identification of jobs.
417 When the job actually runs, the unique Job Name will consist of the name you
418 specify here followed by the date and time the job was scheduled for
419 execution. This directive is required.
421 \item [Enabled = \lt{}yes\vb{}no\gt{}]
423 \index[dir]{Directive!Enable}
424 This directive allows you to enable or disable automatic execution
425 via the scheduler of a Job.
427 \item [Type = \lt{}job-type\gt{}]
429 \index[dir]{Directive!Type}
430 The {\bf Type} directive specifies the Job type, which may be one of the
431 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
432 directive is required. Within a particular Job Type, there are also Levels
433 as discussed in the next item.
439 Run a backup Job. Normally you will have at least one Backup job for each
440 client you want to save. Normally, unless you turn off cataloging, most all
441 the important statistics and data concerning files backed up will be placed
446 Run a restore Job. Normally, you will specify only one Restore job
447 which acts as a sort of prototype that you will modify using the console
448 program in order to perform restores. Although certain basic
449 information from a Restore job is saved in the catalog, it is very
450 minimal compared to the information stored for a Backup job -- for
451 example, no File database entries are generated since no Files are
454 {\bf Restore} jobs cannot be
455 automatically started by the scheduler as is the case for Backup, Verify
456 and Admin jobs. To restore files, you must use the {\bf restore} command
462 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
463 contents of the catalog to the file system, or to what was backed up. In
464 addition, to verifying that a tape that was written can be read, you can
465 also use {\bf verify} as a sort of tripwire intrusion detection.
469 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
470 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
471 Although an Admin job is recorded in the catalog, very little data is saved.
476 \item [Level = \lt{}job-level\gt{}]
478 \index[dir]{Directive!Level}
479 The Level directive specifies the default Job level to be run. Each
480 different Job Type (Backup, Restore, ...) has a different set of Levels
481 that can be specified. The Level is normally overridden by a different
482 value that is specified in the {\bf Schedule} resource. This directive
483 is not required, but must be specified either by a {\bf Level} directive
484 or as an override specified in the {\bf Schedule} resource.
486 For a {\bf Backup} Job, the Level may be one of the following:
492 When the Level is set to Full all files in the FileSet whether or not
493 they have changed will be backed up.
496 \index[dir]{Incremental}
497 When the Level is set to Incremental all files specified in the FileSet
498 that have changed since the last successful backup of the the same Job
499 using the same FileSet and Client, will be backed up. If the Director
500 cannot find a previous valid Full backup then the job will be upgraded
501 into a Full backup. When the Director looks for a valid backup record
502 in the catalog database, it looks for a previous Job with:
505 \item The same Job name.
506 \item The same Client name.
507 \item The same FileSet (any change to the definition of the FileSet such as
508 adding or deleting a file in the Include or Exclude sections constitutes a
510 \item The Job was a Full, Differential, or Incremental backup.
511 \item The Job terminated normally (i.e. did not fail or was not canceled).
512 \item The Job started no longer ago than {\bf Max Full Interval}.
515 If all the above conditions do not hold, the Director will upgrade the
516 Incremental to a Full save. Otherwise, the Incremental backup will be
517 performed as requested.
519 The File daemon (Client) decides which files to backup for an
520 Incremental backup by comparing start time of the prior Job (Full,
521 Differential, or Incremental) against the time each file was last
522 "modified" (st\_mtime) and the time its attributes were last
523 "changed"(st\_ctime). If the file was modified or its attributes
524 changed on or after this start time, it will then be backed up.
526 Some virus scanning software may change st\_ctime while
527 doing the scan. For example, if the virus scanning program attempts to
528 reset the access time (st\_atime), which Bacula does not use, it will
529 cause st\_ctime to change and hence Bacula will backup the file during
530 an Incremental or Differential backup. In the case of Sophos virus
531 scanning, you can prevent it from resetting the access time (st\_atime)
532 and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
533 option. For other software, please see their manual.
535 When Bacula does an Incremental backup, all modified files that are
536 still on the system are backed up. However, any file that has been
537 deleted since the last Full backup remains in the Bacula catalog,
538 which means that if between a Full save and the time you do a
539 restore, some files are deleted, those deleted files will also be
540 restored. The deleted files will no longer appear in the catalog
541 after doing another Full save.
543 In addition, if you move a directory rather than copy it, the files in
544 it do not have their modification time (st\_mtime) or their attribute
545 change time (st\_ctime) changed. As a consequence, those files will
546 probably not be backed up by an Incremental or Differential backup which
547 depend solely on these time stamps. If you move a directory, and wish
548 it to be properly backed up, it is generally preferable to copy it, then
551 However, to manage deleted files or directories changes in the
552 catalog during an Incremental backup you can use \texttt{accurate}
553 mode. This is quite memory consuming process. See \ilink{Accurate
554 mode}{accuratemode} for more details.
557 \index[dir]{Differential}
558 When the Level is set to Differential
559 all files specified in the FileSet that have changed since the last
560 successful Full backup of the same Job will be backed up.
561 If the Director cannot find a
562 valid previous Full backup for the same Job, FileSet, and Client,
563 backup, then the Differential job will be upgraded into a Full backup.
564 When the Director looks for a valid Full backup record in the catalog
565 database, it looks for a previous Job with:
568 \item The same Job name.
569 \item The same Client name.
570 \item The same FileSet (any change to the definition of the FileSet such as
571 adding or deleting a file in the Include or Exclude sections constitutes a
573 \item The Job was a FULL backup.
574 \item The Job terminated normally (i.e. did not fail or was not canceled).
575 \item The Job started no longer ago than {\bf Max Full Interval}.
578 If all the above conditions do not hold, the Director will upgrade the
579 Differential to a Full save. Otherwise, the Differential backup will be
580 performed as requested.
582 The File daemon (Client) decides which files to backup for a
583 differential backup by comparing the start time of the prior Full backup
584 Job against the time each file was last "modified" (st\_mtime) and the
585 time its attributes were last "changed" (st\_ctime). If the file was
586 modified or its attributes were changed on or after this start time, it
587 will then be backed up. The start time used is displayed after the {\bf
588 Since} on the Job report. In rare cases, using the start time of the
589 prior backup may cause some files to be backed up twice, but it ensures
590 that no change is missed. As with the Incremental option, you should
591 ensure that the clocks on your server and client are synchronized or as
592 close as possible to avoid the possibility of a file being skipped.
593 Note, on versions 1.33 or greater Bacula automatically makes the
594 necessary adjustments to the time between the server and the client so
595 that the times Bacula uses are synchronized.
597 When Bacula does a Differential backup, all modified files that are
598 still on the system are backed up. However, any file that has been
599 deleted since the last Full backup remains in the Bacula catalog, which
600 means that if between a Full save and the time you do a restore, some
601 files are deleted, those deleted files will also be restored. The
602 deleted files will no longer appear in the catalog after doing another
603 Full save. However, to remove deleted files from the catalog during a
604 Differential backup is quite a time consuming process and not currently
605 implemented in Bacula. It is, however, a planned future feature.
607 As noted above, if you move a directory rather than copy it, the
608 files in it do not have their modification time (st\_mtime) or
609 their attribute change time (st\_ctime) changed. As a
610 consequence, those files will probably not be backed up by an
611 Incremental or Differential backup which depend solely on these
612 time stamps. If you move a directory, and wish it to be
613 properly backed up, it is generally preferable to copy it, then
614 delete the original. Alternatively, you can move the directory, then
615 use the {\bf touch} program to update the timestamps.
617 %% TODO: merge this with incremental
618 However, to manage deleted files or directories changes in the
619 catalog during an Differential backup you can use \texttt{accurate}
620 mode. This is quite memory consuming process. See \ilink{Accurate
621 mode}{accuratemode} for more details.
623 Every once and a while, someone asks why we need Differential
624 backups as long as Incremental backups pickup all changed files.
625 There are possibly many answers to this question, but the one
626 that is the most important for me is that a Differential backup
628 all the Incremental and Differential backups since the last Full backup
629 into a single Differential backup. This has two effects: 1. It gives
630 some redundancy since the old backups could be used if the merged backup
631 cannot be read. 2. More importantly, it reduces the number of Volumes
632 that are needed to do a restore effectively eliminating the need to read
633 all the volumes on which the preceding Incremental and Differential
634 backups since the last Full are done.
638 For a {\bf Restore} Job, no level needs to be specified.
640 For a {\bf Verify} Job, the Level may be one of the following:
645 \index[dir]{InitCatalog}
646 does a scan of the specified {\bf FileSet} and stores the file
647 attributes in the Catalog database. Since no file data is saved, you
648 might ask why you would want to do this. It turns out to be a very
649 simple and easy way to have a {\bf Tripwire} like feature using {\bf
650 Bacula}. In other words, it allows you to save the state of a set of
651 files defined by the {\bf FileSet} and later check to see if those files
652 have been modified or deleted and if any new files have been added.
653 This can be used to detect system intrusion. Typically you would
654 specify a {\bf FileSet} that contains the set of system files that
655 should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
656 run the {\bf InitCatalog} level verify one time when your system is
657 first setup, and then once again after each modification (upgrade) to
658 your system. Thereafter, when your want to check the state of your
659 system files, you use a {\bf Verify} {\bf level = Catalog}. This
660 compares the results of your {\bf InitCatalog} with the current state of
665 Compares the current state of the files against the state previously
666 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
667 items reported are determined by the {\bf verify} options specified on
668 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
669 FileSet} resource below for more details). Typically this command will
670 be run once a day (or night) to check for any changes to your system
673 Please note! If you run two Verify Catalog jobs on the same client at
674 the same time, the results will certainly be incorrect. This is because
675 Verify Catalog modifies the Catalog database while running in order to
678 \item [VolumeToCatalog]
679 \index[dir]{VolumeToCatalog}
680 This level causes Bacula to read the file attribute data written to the
681 Volume from the last backup Job for the job specified on the {\bf VerifyJob}
682 directive. The file attribute data are compared to the
683 values saved in the Catalog database and any differences are reported.
684 This is similar to the {\bf DiskToCatalog} level except that instead of
685 comparing the disk file attributes to the catalog database, the
686 attribute data written to the Volume is read and compared to the catalog
687 database. Although the attribute data including the signatures (MD5 or
688 SHA1) are compared, the actual file data is not compared (it is not in
691 Please note! If you run two Verify VolumeToCatalog jobs on the same
692 client at the same time, the results will certainly be incorrect. This
693 is because the Verify VolumeToCatalog modifies the Catalog database
696 \item [DiskToCatalog]
697 \index[dir]{DiskToCatalog}
698 This level causes Bacula to read the files as they currently are on
699 disk, and to compare the current file attributes with the attributes
700 saved in the catalog from the last backup for the job specified on the
701 {\bf VerifyJob} directive. This level differs from the {\bf VolumeToCatalog}
702 level described above by the fact that it doesn't compare against a
703 previous Verify job but against a previous backup. When you run this
704 level, you must supply the verify options on your Include statements.
705 Those options determine what attribute fields are compared.
707 This command can be very useful if you have disk problems because it
708 will compare the current state of your disk against the last successful
709 backup, which may be several jobs.
711 Note, the current implementation (1.32c) does not identify files that
715 \item [Accurate = \lt{}yes\vb{}no\gt{}]
716 \index[dir]{Accurate}
717 In accurate mode, the File daemon knowns exactly which files were present
718 after the last backup. So it is able to handle deleted or renamed files.
720 When restoring a FileSet for a specified date (including "most
721 recent"), Bacula is able to restore exactly the files and
722 directories that existed at the time of the last backup prior to
723 that date including ensuring that deleted files are actually deleted,
724 and renamed directories are restored properly.
726 In this mode, the File daemon must keep data concerning all files in
727 memory. So If you do not have sufficient memory, the backup may
728 either be terribly slow or fail.
730 %% $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
732 For 500.000 files (a typical desktop linux system), it will require
733 approximately 64 Megabytes of RAM on your File daemon to hold the
734 required information.
736 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
737 \index[dir]{Verify Job}
738 \index[dir]{Directive!Verify Job}
739 If you run a verify job without this directive, the last job run will be
740 compared with the catalog, which means that you must immediately follow
741 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
742 will find the last job with that name that ran. This permits you to run
743 all your backups, then run Verify jobs on those that you wish to be
744 verified (most often a {\bf VolumeToCatalog}) so that the tape just
747 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
749 \index[dir]{Directive!JobDefs}
750 If a JobDefs-Resource-Name is specified, all the values contained in the
751 named JobDefs resource will be used as the defaults for the current Job.
752 Any value that you explicitly define in the current Job resource, will
753 override any defaults specified in the JobDefs resource. The use of
754 this directive permits writing much more compact Job resources where the
755 bulk of the directives are defined in one or more JobDefs. This is
756 particularly useful if you have many similar Jobs but with minor
757 variations such as different Clients. A simple example of the use of
758 JobDefs is provided in the default bacula-dir.conf file.
760 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
761 \index[dir]{Bootstrap}
762 \index[dir]{Directive!Bootstrap}
763 The Bootstrap directive specifies a bootstrap file that, if provided,
764 will be used during {\bf Restore} Jobs and is ignored in other Job
765 types. The {\bf bootstrap} file contains the list of tapes to be used
766 in a restore Job as well as which files are to be restored.
767 Specification of this directive is optional, and if specified, it is
768 used only for a restore job. In addition, when running a Restore job
769 from the console, this value can be changed.
771 If you use the {\bf Restore} command in the Console program, to start a
772 restore job, the {\bf bootstrap} file will be created automatically from
773 the files you select to be restored.
775 For additional details of the {\bf bootstrap} file, please see
776 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
779 \label{writebootstrap}
780 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
781 \index[dir]{Write Bootstrap}
782 \index[dir]{Directive!Write Bootstrap}
783 The {\bf writebootstrap} directive specifies a file name where Bacula
784 will write a {\bf bootstrap} file for each Backup job run. This
785 directive applies only to Backup Jobs. If the Backup job is a Full
786 save, Bacula will erase any current contents of the specified file
787 before writing the bootstrap records. If the Job is an Incremental
789 save, Bacula will append the current bootstrap record to the end of the
792 Using this feature, permits you to constantly have a bootstrap file that
793 can recover the current state of your system. Normally, the file
794 specified should be a mounted drive on another machine, so that if your
795 hard disk is lost, you will immediately have a bootstrap record
796 available. Alternatively, you should copy the bootstrap file to another
797 machine after it is updated. Note, it is a good idea to write a separate
798 bootstrap file for each Job backed up including the job that backs up
799 your catalog database.
801 If the {\bf bootstrap-file-specification} begins with a vertical bar
802 (\verb+|+), Bacula will use the specification as the name of a program to which
803 it will pipe the bootstrap record. It could for example be a shell
804 script that emails you the bootstrap record.
806 On versions 1.39.22 or greater, before opening the file or executing the
807 specified command, Bacula performs
808 \ilink{character substitution}{character substitution} like in RunScript
809 directive. To automatically manage your bootstrap files, you can use
810 this in your {\bf JobDefs} resources:
813 Write Bootstrap = "%c_%n.bsr"
818 For more details on using this file, please see the chapter entitled
819 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
821 \item [Client = \lt{}client-resource-name\gt{}]
823 \index[dir]{Directive!Client}
824 The Client directive specifies the Client (File daemon) that will be used in
825 the current Job. Only a single Client may be specified in any one Job. The
826 Client runs on the machine to be backed up, and sends the requested files to
827 the Storage daemon for backup, or receives them when restoring. For
828 additional details, see the
829 \ilink{Client Resource section}{ClientResource2} of this chapter.
830 This directive is required.
832 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
834 \index[dir]{Directive!FileSet}
835 The FileSet directive specifies the FileSet that will be used in the
836 current Job. The FileSet specifies which directories (or files) are to
837 be backed up, and what options to use (e.g. compression, ...). Only a
838 single FileSet resource may be specified in any one Job. For additional
839 details, see the \ilink{FileSet Resource section}{FileSetResource} of
840 this chapter. This directive is required.
842 \item [Base = \lt{}job-resource-name, ...\gt{}]
844 \index[dir]{Directive!Base}
845 The Base directive permits to specify the list of jobs that will be used during
846 Full backup as base. This directive is optional. See the \ilink{Base Job
847 chapter}{basejobs} for more information.
849 \item [Messages = \lt{}messages-resource-name\gt{}]
850 \index[dir]{Messages}
851 \index[dir]{Directive!Messages}
852 The Messages directive defines what Messages resource should be used for
853 this job, and thus how and where the various messages are to be
854 delivered. For example, you can direct some messages to a log file, and
855 others can be sent by email. For additional details, see the
856 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
857 directive is required.
859 \item [Pool = \lt{}pool-resource-name\gt{}]
861 \index[dir]{Directive!Pool}
862 The Pool directive defines the pool of Volumes where your data can be
863 backed up. Many Bacula installations will use only the {\bf Default}
864 pool. However, if you want to specify a different set of Volumes for
865 different Clients or different Jobs, you will probably want to use
866 Pools. For additional details, see the \ilink{Pool Resource
867 section}{PoolResource} of this chapter. This directive is required.
869 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
870 \index[dir]{Full Backup Pool}
871 \index[dir]{Directive!Full Backup Pool}
872 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
873 It will override any Pool specification during a Full backup. This
874 directive is optional.
876 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
877 \index[dir]{Differential Backup Pool}
878 \index[dir]{Directive!Differential Backup Pool}
879 The {\it Differential Backup Pool} specifies a Pool to be used for
880 Differential backups. It will override any Pool specification during a
881 Differential backup. This directive is optional.
883 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
884 \index[dir]{Incremental Backup Pool}
885 \index[dir]{Directive!Incremental Backup Pool}
886 The {\it Incremental Backup Pool} specifies a Pool to be used for
887 Incremental backups. It will override any Pool specification during an
888 Incremental backup. This directive is optional.
890 \item [Schedule = \lt{}schedule-name\gt{}]
891 \index[dir]{Schedule}
892 \index[dir]{Directive!Schedule}
893 The Schedule directive defines what schedule is to be used for the Job.
894 The schedule in turn determines when the Job will be automatically
895 started and what Job level (i.e. Full, Incremental, ...) is to be run.
896 This directive is optional, and if left out, the Job can only be started
897 manually using the Console program. Although you may specify only a
898 single Schedule resource for any one job, the Schedule resource may
899 contain multiple {\bf Run} directives, which allow you to run the Job at
900 many different times, and each {\bf run} directive permits overriding
901 the default Job Level Pool, Storage, and Messages resources. This gives
902 considerable flexibility in what can be done with a single Job. For
903 additional details, see the \ilink{Schedule Resource
904 Chapter}{ScheduleResource} of this manual.
907 \item [Storage = \lt{}storage-resource-name\gt{}]
909 \index[dir]{Directive!Storage}
910 The Storage directive defines the name of the storage services where you
911 want to backup the FileSet data. For additional details, see the
912 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
913 The Storage resource may also be specified in the Job's Pool resource,
914 in which case the value in the Pool resource overrides any value
915 in the Job. This Storage resource definition is not required by either
916 the Job resource or in the Pool, but it must be specified in
917 one or the other, if not an error will result.
919 \item [Max Start Delay = \lt{}time\gt{}]
920 \index[dir]{Max Start Delay}
921 \index[dir]{Directive!Max Start Delay}
922 The time specifies the maximum delay between the scheduled time and the
923 actual start time for the Job. For example, a job can be scheduled to
924 run at 1:00am, but because other jobs are running, it may wait to run.
925 If the delay is set to 3600 (one hour) and the job has not begun to run
926 by 2:00am, the job will be canceled. This can be useful, for example,
927 to prevent jobs from running during day time hours. The default is 0
928 which indicates no limit.
930 \item [Max Run Time = \lt{}time\gt{}]
931 \index[dir]{Max Run Time}
932 \index[dir]{Directive!Max Run Time}
933 The time specifies the maximum allowed time that a job may run, counted
934 from when the job starts, ({\bf not} necessarily the same as when the
937 By default, the the watchdog thread will kill any Job that has run more
938 than 6 days. The maximum watchdog timeout is independent of MaxRunTime
939 and cannot be changed.
942 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
943 \index[dir]{Incremental Wait Run Time}
944 \index[dir]{Differential Wait Run Time}
945 \index[dir]{Directive!Differential Max Wait Time}
946 Theses directives have been deprecated in favor of
947 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
949 \item [Incremental Max Run Time = \lt{}time\gt{}]
950 \index[dir]{Incremental Max Run Time}
951 \index[dir]{Directive!Incremental Max Run Time}
952 The time specifies the maximum allowed time that an Incremental backup job may
953 run, counted from when the job starts, ({\bf not} necessarily the same as when
954 the job was scheduled).
956 \item [Differential Max Wait Time = \lt{}time\gt{}]
957 \index[dir]{Differential Max Run Time}
958 \index[dir]{Directive!Differential Max Run Time}
959 The time specifies the maximum allowed time that a Differential backup job may
960 run, counted from when the job starts, ({\bf not} necessarily the same as when
961 the job was scheduled).
963 \item [Max Run Sched Time = \lt{}time\gt{}]
964 \index[dir]{Max Run Sched Time}
965 \index[dir]{Directive!Max Run Sched Time}
967 The time specifies the maximum allowed time that a job may run, counted from
968 when the job was scheduled. This can be useful to prevent jobs from running
969 during working hours. We can see it like \texttt{Max Start Delay + Max Run
972 \item [Max Wait Time = \lt{}time\gt{}]
973 \index[dir]{Max Wait Time}
974 \index[dir]{Directive!Max Wait Time}
975 The time specifies the maximum allowed time that a job may block waiting
976 for a resource (such as waiting for a tape to be mounted, or waiting for
977 the storage or file daemons to perform their duties), counted from the
978 when the job starts, ({\bf not} necessarily the same as when the job was
979 scheduled). This directive works as expected since bacula 2.3.18.
983 \includegraphics[width=13cm]{\idir different_time.eps}
984 \caption{Job time control directives}
985 \label{fig:differenttime}
988 \item [Maximum Bandwidth = \lt{}speed\gt{}]
989 \index[dir]{Maximum Bandwidth}
990 \index[dir]{Directive!Maximum Bandwidth}
992 The speed parameter specifies the maximum allowed bandwidth that a job may
993 use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
995 \item [Max Full Interval = \lt{}time\gt{}]
996 \index[dir]{Max Full Interval}
997 \index[dir]{Directive!Max Full Interval}
998 The time specifies the maximum allowed age (counting from start time) of
999 the most recent successful Full backup that is required in order to run
1000 Incremental or Differential backup jobs. If the most recent Full backup
1001 is older than this interval, Incremental and Differential backups will be
1002 upgraded to Full backups automatically. If this directive is not present,
1003 or specified as 0, then the age of the previous Full backup is not
1006 \label{PreferMountedVolumes}
1007 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
1008 \index[dir]{Prefer Mounted Volumes}
1009 \index[dir]{Directive!Prefer Mounted Volumes}
1010 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
1011 yes), the Storage daemon is requested to select either an Autochanger or
1012 a drive with a valid Volume already mounted in preference to a drive
1013 that is not ready. This means that all jobs will attempt to append
1014 to the same Volume (providing the Volume is appropriate -- right Pool,
1015 ... for that job), unless you are using multiple pools.
1016 If no drive with a suitable Volume is available, it
1017 will select the first available drive. Note, any Volume that has
1018 been requested to be mounted, will be considered valid as a mounted
1019 volume by another job. This if multiple jobs start at the same time
1020 and they all prefer mounted volumes, the first job will request the
1021 mount, and the other jobs will use the same volume.
1023 If the directive is set to {\bf no}, the Storage daemon will prefer
1024 finding an unused drive, otherwise, each job started will append to the
1025 same Volume (assuming the Pool is the same for all jobs). Setting
1026 Prefer Mounted Volumes to no can be useful for those sites
1027 with multiple drive autochangers that prefer to maximize backup
1028 throughput at the expense of using additional drives and Volumes.
1029 This means that the job will prefer to use an unused drive rather
1030 than use a drive that is already in use.
1032 Despite the above, we recommend against setting this directive to
1034 it tends to add a lot of swapping of Volumes between the different
1035 drives and can easily lead to deadlock situations in the Storage
1036 daemon. We will accept bug reports against it, but we cannot guarantee
1037 that we will be able to fix the problem in a reasonable time.
1039 A better alternative for using multiple drives is to use multiple
1040 pools so that Bacula will be forced to mount Volumes from those Pools
1041 on different drives.
1043 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1044 \index[dir]{Prune Jobs}
1045 \index[dir]{Directive!Prune Jobs}
1046 Normally, pruning of Jobs from the Catalog is specified on a Client by
1047 Client basis in the Client resource with the {\bf AutoPrune} directive.
1048 If this directive is specified (not normally) and the value is {\bf
1049 yes}, it will override the value specified in the Client resource. The
1050 default is {\bf no}.
1053 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1054 \index[dir]{Prune Files}
1055 \index[dir]{Directive!Prune Files}
1056 Normally, pruning of Files from the Catalog is specified on a Client by
1057 Client basis in the Client resource with the {\bf AutoPrune} directive.
1058 If this directive is specified (not normally) and the value is {\bf
1059 yes}, it will override the value specified in the Client resource. The
1060 default is {\bf no}.
1062 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1063 \index[dir]{Prune Volumes}
1064 \index[dir]{Directive!Prune Volumes}
1065 Normally, pruning of Volumes from the Catalog is specified on a Pool by
1066 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1067 Note, this is different from File and Job pruning which is done on a
1068 Client by Client basis. If this directive is specified (not normally)
1069 and the value is {\bf yes}, it will override the value specified in the
1070 Pool resource. The default is {\bf no}.
1072 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1073 \index[dir]{RunScript}
1074 \index[dir]{Directive!Run Script}
1076 The RunScript directive behaves like a resource in that it
1077 requires opening and closing braces around a number of directives
1078 that make up the body of the runscript.
1080 The specified {\bf Command} (see below for details) is run as an external
1081 program prior or after the current Job. This is optional. By default, the
1082 program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1084 \textbf{Console} options are special commands that are sent to the director instead
1085 of the OS. At this time, console command ouputs are redirected to log with
1088 You can use following console command : \texttt{delete}, \texttt{disable},
1089 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1090 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1091 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1092 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1093 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1094 more information. You need to specify needed information on command line, nothing
1095 will be prompted. Example :
1098 Console = "prune files client=%c"
1099 Console = "update stats age=3"
1102 You can specify more than one Command/Console option per RunScript.
1104 You can use following options may be specified in the body
1107 \begin{tabular}{|c|c|c|l}
1108 Options & Value & Default & Information \\
1111 Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
1113 Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
1115 Runs On Client & Yes/No & {\it Yes} & Run command on client\\
1117 Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
1119 Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
1120 something different from 0 \\
1122 Command & & & Path to your script\\
1124 Console & & & Console command\\
1129 Any output sent by the command to standard output will be included in the
1130 Bacula job report. The command string must be a valid program name or name
1133 In addition, the command string is parsed then fed to the OS,
1134 which means that the path will be searched to execute your specified
1135 command, but there is no shell interpretation, as a consequence, if you
1136 invoke complicated commands or want any shell features such as redirection
1137 or piping, you must call a shell script and do it inside that script.
1139 Before submitting the specified command to the operating system, Bacula
1140 performs character substitution of the following characters:
1142 \label{character substitution}
1148 %C = If the job is a Cloned job (Only on director side)
1149 %d = Daemon's name (Such as host-dir or host-fd)
1150 %D = Director's name (Also valid on file daemon)
1151 %e = Job Exit Status
1152 %f = Job FileSet (Only on director side)
1159 %p = Pool name (Only on director side)
1162 %t = Job type (Backup, ...)
1163 %v = Volume name (Only on director side)
1164 %w = Storage name (Only on director side)
1165 %x = Spooling enabled? ("yes" or "no")
1170 Some character substitutions are not available in all situations. The Job Exit
1171 Status code \%e edits the following values:
1173 \index[dir]{Exit Status}
1180 \item Unknown term code
1183 Thus if you edit it on a command line, you will need to enclose
1184 it within some sort of quotes.
1187 You can use these following shortcuts:\\
1189 \begin{tabular}{|c|c|c|c|c|c}
1190 Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
1192 Run Before Job & & & Yes & No & Before \\
1194 Run After Job & Yes & No & & No & After \\
1196 Run After Failed Job & No & Yes & & No & After \\
1198 Client Run Before Job & & & Yes & Yes & Before \\
1200 Client Run After Job & Yes & No & & Yes & After \\
1208 Command = "/etc/init.d/apache stop"
1214 Command = "/etc/init.d/apache start"
1218 {\bf Notes about ClientRunBeforeJob}
1220 For compatibility reasons, with this shortcut, the command is executed
1221 directly when the client recieve it. And if the command is in error, other
1222 remote runscripts will be discarded. To be sure that all commands will be
1223 sent and executed, you have to use RunScript syntax.
1225 {\bf Special Windows Considerations}
1227 You can run scripts just after snapshots initializations with
1228 \textsl{AfterVSS} keyword.
1230 In addition, for a Windows client, please take
1231 note that you must ensure a correct path to your script. The script or
1232 program can be a .com, .exe or a .bat file. If you just put the program
1233 name in then Bacula will search using the same rules that cmd.exe uses
1234 (current directory, Bacula bin directory, and PATH). It will even try the
1235 different extensions in the same order as cmd.exe.
1236 The command can be anything that cmd.exe or command.com will recognize
1237 as an executable file.
1239 However, if you have slashes in the program name then Bacula figures you
1240 are fully specifying the name, so you must also explicitly add the three
1241 character extension.
1243 The command is run in a Win32 environment, so Unix like commands will not
1244 work unless you have installed and properly configured Cygwin in addition
1245 to and separately from Bacula.
1247 The System \%Path\% will be searched for the command. (under the
1248 environment variable dialog you have have both System Environment and
1249 User Environment, we believe that only the System environment will be
1250 available to bacula-fd, if it is running as a service.)
1252 System environment variables can be referenced with \%var\% and
1253 used as either part of the command name or arguments.
1255 So if you have a script in the Bacula\\bin directory then the following lines
1260 Client Run Before Job = systemstate
1262 Client Run Before Job = systemstate.bat
1264 Client Run Before Job = "systemstate"
1266 Client Run Before Job = "systemstate.bat"
1268 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1272 The outer set of quotes is removed when the configuration file is parsed.
1273 You need to escape the inner quotes so that they are there when the code
1274 that parses the command line for execution runs so it can tell what the
1280 ClientRunBeforeJob = "\"C:/Program Files/Software
1281 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1285 The special characters
1289 will need to be quoted,
1290 if they are part of a filename or argument.
1292 If someone is logged in, a blank "command" window running the commands
1293 will be present during the execution of the command.
1295 Some Suggestions from Phil Stracchino for running on Win32 machines with
1296 the native Win32 File daemon:
1299 \item You might want the ClientRunBeforeJob directive to specify a .bat
1300 file which runs the actual client-side commands, rather than trying
1301 to run (for example) regedit /e directly.
1302 \item The batch file should explicitly 'exit 0' on successful completion.
1303 \item The path to the batch file should be specified in Unix form:
1305 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1307 rather than DOS/Windows form:
1309 ClientRunBeforeJob =
1311 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1315 For Win32, please note that there are certain limitations:
1317 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1319 Lines like the above do not work because there are limitations of
1320 cmd.exe that is used to execute the command.
1321 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1322 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1323 cmd prompt and see what happens. Once the command is correct insert a
1324 backslash (\textbackslash{}) before each double quote ("), and
1325 then put quotes around the whole thing when putting it in
1326 the director's .conf file. You either need to have only one set of quotes
1327 or else use the short name and don't put quotes around the command path.
1329 Below is the output from cmd's help as it relates to the command line
1330 passed to the /c option.
1333 If /C or /K is specified, then the remainder of the command line after
1334 the switch is processed as a command line, where the following logic is
1335 used to process quote (") characters:
1339 If all of the following conditions are met, then quote characters
1340 on the command line are preserved:
1343 \item exactly two quote characters.
1344 \item no special characters between the two quote characters,
1345 where special is one of:
1349 \item there are one or more whitespace characters between the
1350 the two quote characters.
1351 \item the string between the two quote characters is the name
1352 of an executable file.
1355 \item Otherwise, old behavior is to see if the first character is
1356 a quote character and if so, strip the leading character and
1357 remove the last quote character on the command line, preserving
1358 any text after the last quote character.
1363 The following example of the use of the Client Run Before Job directive was
1364 submitted by a user:\\
1365 You could write a shell script to back up a DB2 database to a FIFO. The shell
1375 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1380 The following line in the Job resource in the bacula-dir.conf file:
1383 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1388 When the job is run, you will get messages from the output of the script
1389 stating that the backup has started. Even though the command being run is
1390 backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
1391 command, thus the backup stalls.
1393 To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
1398 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1403 It is important to redirect the input and outputs of a backgrounded command to
1404 /dev/null to prevent the script from blocking.
1406 \item [Run Before Job = \lt{}command\gt{}]
1407 \index[dir]{Run Before Job}
1408 \index[dir]{Directive!Run Before Job}
1409 \index[dir]{Directive!Run Before Job}
1410 The specified {\bf command} is run as an external program prior to running the
1411 current Job. This directive is not required, but if it is defined, and if the
1412 exit code of the program run is non-zero, the current Bacula job will be
1416 Run Before Job = "echo test"
1418 it's equivalent to :
1421 Command = "echo test"
1427 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1428 simple way to modify your schedules during a holiday. For example, suppose
1429 that you normally do Full backups on Fridays, but Thursday and Friday are
1430 holidays. To avoid having to change tapes between Thursday and Friday when
1431 no one is in the office, you can create a RunBeforeJob that returns a
1432 non-zero status on Thursday and zero on all other days. That way, the
1433 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1434 before leaving will be used.
1436 \item [Run After Job = \lt{}command\gt{}]
1437 \index[dir]{Run After Job}
1438 \index[dir]{Directive!Run After Job}
1439 The specified {\bf command} is run as an external program if the current
1440 job terminates normally (without error or without being canceled). This
1441 directive is not required. If the exit code of the program run is
1442 non-zero, Bacula will print a warning message. Before submitting the
1443 specified command to the operating system, Bacula performs character
1444 substitution as described above for the {\bf RunScript} directive.
1446 An example of the use of this directive is given in the
1447 \ilink{Tips Chapter}{JobNotification} of this manual.
1449 See the {\bf Run After Failed Job} if you
1450 want to run a script after the job has terminated with any
1453 \item [Run After Failed Job = \lt{}command\gt{}]
1454 \index[dir]{Run After Job}
1455 \index[dir]{Directive!Run After Job}
1456 The specified {\bf command} is run as an external program after the current
1457 job terminates with any error status. This directive is not required. The
1458 command string must be a valid program name or name of a shell script. If
1459 the exit code of the program run is non-zero, Bacula will print a
1460 warning message. Before submitting the specified command to the
1461 operating system, Bacula performs character substitution as described above
1462 for the {\bf RunScript} directive. Note, if you wish that your script
1463 will run regardless of the exit status of the Job, you can use this :
1466 Command = "echo test"
1470 RunsOnSuccess = yes # default, you can drop this line
1474 An example of the use of this directive is given in the
1475 \ilink{Tips Chapter}{JobNotification} of this manual.
1478 \item [Client Run Before Job = \lt{}command\gt{}]
1479 \index[dir]{Client Run Before Job}
1480 \index[dir]{Directive!Client Run Before Job}
1481 This directive is the same as {\bf Run Before Job} except that the
1482 program is run on the client machine. The same restrictions apply to
1483 Unix systems as noted above for the {\bf RunScript}.
1485 \item [Client Run After Job = \lt{}command\gt{}]
1486 \index[dir]{Client Run After Job}
1487 \index[dir]{Directive!Client Run After Job}
1488 The specified {\bf command} is run on the client machine as soon
1489 as data spooling is complete in order to allow restarting applications
1490 on the client as soon as possible. .
1492 Note, please see the notes above in {\bf RunScript}
1493 concerning Windows clients.
1495 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1496 \index[dir]{Rerun Failed Levels}
1497 \index[dir]{Directive!Rerun Failed Levels}
1498 If this directive is set to {\bf yes} (default no), and Bacula detects that
1499 a previous job at a higher level (i.e. Full or Differential) has failed,
1500 the current job level will be upgraded to the higher level. This is
1501 particularly useful for Laptops where they may often be unreachable, and if
1502 a prior Full save has failed, you wish the very next backup to be a Full
1503 save rather than whatever level it is started as.
1505 There are several points that must be taken into account when using this
1506 directive: first, a failed job is defined as one that has not terminated
1507 normally, which includes any running job of the same name (you need to
1508 ensure that two jobs of the same name do not run simultaneously);
1509 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1510 when checking for failed levels, which means that any FileSet change will
1513 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1514 \index[dir]{Spool Data}
1515 \index[dir]{Directive!Spool Data}
1517 If this directive is set to {\bf yes} (default no), the Storage daemon will
1518 be requested to spool the data for this Job to disk rather than write it
1519 directly to the Volume (normally a tape).
1521 Thus the data is written in large blocks to the Volume rather than small
1522 blocks. This directive is particularly useful when running multiple
1523 simultaneous backups to tape. Once all the data arrives or the spool
1524 files' maximum sizes are reached, the data will be despooled and written
1527 Spooling data prevents interleaving date from several job and reduces or
1528 eliminates tape drive stop and start commonly known as "shoe-shine".
1530 We don't recommend using this option if you are writing to a disk file
1531 using this option will probably just slow down the backup jobs.
1533 NOTE: When this directive is set to yes, Spool Attributes is also
1534 automatically set to yes.
1536 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1537 \index[dir]{Spool Attributes}
1538 \index[dir]{Directive!Spool Attributes}
1540 \index[general]{slow}
1541 \index[dir]{Backups!slow}
1542 \index[general]{Backups!slow}
1543 The default is set to {\bf no}, which means that the File attributes are
1544 sent by the Storage daemon to the Director as they are stored on tape.
1545 However, if you want to avoid the possibility that database updates will
1546 slow down writing to the tape, you may want to set the value to {\bf
1547 yes}, in which case the Storage daemon will buffer the File attributes
1548 and Storage coordinates to a temporary file in the Working Directory,
1549 then when writing the Job data to the tape is completed, the attributes
1550 and storage coordinates will be sent to the Director.
1552 NOTE: When Spool Data is set to yes, Spool Attributes is also
1553 automatically set to yes.
1555 \item [SpoolSize={\it bytes}]
1556 \index[dir]{SpoolSize}
1557 \index[dir]{Directive!SpoolSize}
1558 where the bytes specify the maximum spool size for this job.
1559 The default is take from Device Maximum Spool Size limit.
1560 This directive is available only in Bacula version 2.3.5 or
1564 \item [Where = \lt{}directory\gt{}]
1566 \index[dir]{Directive!Where}
1567 This directive applies only to a Restore job and specifies a prefix to
1568 the directory name of all files being restored. This permits files to
1569 be restored in a different location from which they were saved. If {\bf
1570 Where} is not specified or is set to backslash ({\bf /}), the files will
1571 be restored to their original location. By default, we have set {\bf
1572 Where} in the example configuration files to be {\bf
1573 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1576 \item [Add Prefix = \lt{}directory\gt{}]
1577 \label{confaddprefix}
1578 \index[dir]{AddPrefix}
1579 \index[dir]{Directive!AddPrefix}
1580 This directive applies only to a Restore job and specifies a prefix to the
1581 directory name of all files being restored. This will use \ilink{File
1582 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1584 \item [Add Suffix = \lt{}extention\gt{}]
1585 \index[dir]{AddSuffix}
1586 \index[dir]{Directive!AddSuffix}
1587 This directive applies only to a Restore job and specifies a suffix to all
1588 files being restored. This will use \ilink{File Relocation}{filerelocation}
1589 feature implemented in Bacula 2.1.8 or later.
1591 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1592 \texttt{/etc/passwsd.old}
1594 \item [Strip Prefix = \lt{}directory\gt{}]
1595 \index[dir]{StripPrefix}
1596 \index[dir]{Directive!StripPrefix}
1597 This directive applies only to a Restore job and specifies a prefix to remove
1598 from the directory name of all files being restored. This will use the
1599 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1602 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1605 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1613 \item [RegexWhere = \lt{}expressions\gt{}]
1614 \index[dir]{RegexWhere}
1615 \index[dir]{Directive!RegexWhere}
1616 This directive applies only to a Restore job and specifies a regex filename
1617 manipulation of all files being restored. This will use \ilink{File
1618 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1620 For more informations about how use this option, see
1621 \ilink{this}{useregexwhere}.
1623 \item [Replace = \lt{}replace-option\gt{}]
1624 \index[dir]{Replace}
1625 \index[dir]{Directive!Replace}
1626 This directive applies only to a Restore job and specifies what happens
1627 when Bacula wants to restore a file or directory that already exists.
1628 You have the following options for {\bf replace-option}:
1634 when the file to be restored already exists, it is deleted and then
1635 replaced by the copy that was backed up. This is the default value.
1638 \index[dir]{ifnewer}
1639 if the backed up file (on tape) is newer than the existing file, the
1640 existing file is deleted and replaced by the back up.
1643 \index[dir]{ifolder}
1644 if the backed up file (on tape) is older than the existing file, the
1645 existing file is deleted and replaced by the back up.
1649 if the backed up file already exists, Bacula skips restoring this file.
1652 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1653 \index[dir]{Prefix Links}
1654 \index[dir]{Directive!Prefix Links}
1655 If a {\bf Where} path prefix is specified for a recovery job, apply it
1656 to absolute links as well. The default is {\bf No}. When set to {\bf
1657 Yes} then while restoring files to an alternate directory, any absolute
1658 soft links will also be modified to point to the new alternate
1659 directory. Normally this is what is desired -- i.e. everything is self
1660 consistent. However, if you wish to later move the files to their
1661 original locations, all files linked with absolute names will be broken.
1663 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1664 \index[dir]{Maximum Concurrent Jobs}
1665 \index[dir]{Directive!Maximum Concurrent Jobs}
1666 where \lt{}number\gt{} is the maximum number of Jobs from the current
1667 Job resource that can run concurrently. Note, this directive limits
1668 only Jobs with the same name as the resource in which it appears. Any
1669 other restrictions on the maximum concurrent jobs such as in the
1670 Director, Client, or Storage resources will also apply in addition to
1671 the limit specified here. The default is set to 1, but you may set it
1672 to a larger number. We strongly recommend that you read the WARNING
1673 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1674 Director's resource.
1676 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1677 \index[dir]{Reschedule On Error}
1678 \index[dir]{Directive!Reschedule On Error}
1679 If this directive is enabled, and the job terminates in error, the job
1680 will be rescheduled as determined by the {\bf Reschedule Interval} and
1681 {\bf Reschedule Times} directives. If you cancel the job, it will not
1682 be rescheduled. The default is {\bf no} (i.e. the job will not be
1685 This specification can be useful for portables, laptops, or other
1686 machines that are not always connected to the network or switched on.
1688 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1689 \index[dir]{Reschedule Interval}
1690 \index[dir]{Directive!Reschedule Interval}
1691 If you have specified {\bf Reschedule On Error = yes} and the job
1692 terminates in error, it will be rescheduled after the interval of time
1693 specified by {\bf time-specification}. See \ilink{the time
1694 specification formats}{Time} in the Configure chapter for details of
1695 time specifications. If no interval is specified, the job will not be
1696 rescheduled on error. The default Reschedule Interval
1697 is 30 minutes (1800 seconds).
1699 \item [Reschedule Times = \lt{}count\gt{}]
1700 \index[dir]{Reschedule Times}
1701 \index[dir]{Directive!Reschedule Times}
1702 This directive specifies the maximum number of times to reschedule the
1703 job. If it is set to zero (the default) the job will be rescheduled an
1704 indefinite number of times.
1706 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1707 \index[general]{Allow Duplicate Jobs}
1709 \begin{figure}[htbp]
1711 \includegraphics[width=13cm]{\idir duplicate-real.eps}
1712 \caption{Allow Duplicate Jobs usage}
1713 \label{fig:allowduplicatejobs}
1716 A duplicate job in the sense we use it here means a second or subsequent job
1717 with the same name starts. This happens most frequently when the first job
1718 runs longer than expected because no tapes are available.
1720 If this directive is enabled duplicate jobs will be run. If
1721 the directive is set to {\bf no} (default) then only one job of a given name
1722 may run at one time, and the action that Bacula takes to ensure only
1723 one job runs is determined by the other directives (see below).
1725 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1726 are present and none of the three directives given below permit
1727 cancelling a job, then the current job (the second one started)
1730 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1731 \index[general]{Allow Higher Duplicates}
1732 This directive was implemented in version 5.0.0, but does not work
1733 as expected. If used, it should always be set to no. In later versions
1734 of Bacula the directive is disabled (disregarded).
1737 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1738 \index[general]{Cancel Lower Level Duplicates}
1739 If \textbf{Allow Duplicate Jobs} is set to \textbf{no} and this
1740 directive is set to \textbf{yes}, Bacula will choose between duplicated
1741 jobs the one with the highest level. For example, it will cancel a
1742 previous Incremental to run a Full backup. It works only for Backup
1743 jobs. The default is \texttt{no}. If the levels of the duplicated
1744 jobs are the same, nothing is done and the other
1745 Cancel XXX Duplicate directives will be examined.
1747 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1748 \index[general]{Cancel Queued Duplicates}
1749 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1750 if this directive is set to {\bf yes} any job that is
1751 already queued to run but not yet running will be canceled.
1752 The default is {\bf no}.
1754 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1755 \index[general]{Cancel Running Duplicates}
1756 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1757 if this directive is set to {\bf yes} any job that is already running
1758 will be canceled. The default is {\bf no}.
1761 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1762 %%\index[general]{Duplicate Job Proximity}
1763 %% This directive permits to determine if two jobs are really duplicated.
1764 %% If the first one is running for long time, this is probably not a good
1765 %% idea to cancel it.
1767 \item [Run = \lt{}job-name\gt{}]
1769 \index[dir]{Directive!Run}
1770 \index[dir]{Clone a Job}
1771 The Run directive (not to be confused with the Run option in a
1772 Schedule) allows you to start other jobs or to clone jobs. By using the
1773 cloning keywords (see below), you can backup
1774 the same data (or almost the same data) to two or more drives
1775 at the same time. The {\bf job-name} is normally the same name
1776 as the current Job resource (thus creating a clone). However, it
1777 may be any Job name, so one job may start other related jobs.
1779 The part after the equal sign must be enclosed in double quotes,
1780 and can contain any string or set of options (overrides) that you
1781 can specify when entering the Run command from the console. For
1782 example {\bf storage=DDS-4 ...}. In addition, there are two special
1783 keywords that permit you to clone the current job. They are {\bf level=\%l}
1784 and {\bf since=\%s}. The \%l in the level keyword permits
1785 entering the actual level of the current job and the \%s in the since
1786 keyword permits putting the same time for comparison as used on the
1787 current job. Note, in the case of the since keyword, the \%s must be
1788 enclosed in double quotes, and thus they must be preceded by a backslash
1789 since they are already inside quotes. For example:
1792 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1795 A cloned job will not start additional clones, so it is not
1796 possible to recurse.
1798 Please note that all cloned jobs, as specified in the Run directives are
1799 submitted for running before the original job is run (while it is being
1800 initialized). This means that any clone job will actually start before
1801 the original job, and may even block the original job from starting
1802 until the original job finishes unless you allow multiple simultaneous
1803 jobs. Even if you set a lower priority on the clone job, if no other
1804 jobs are running, it will start before the original job.
1806 If you are trying to prioritize jobs by using the clone feature (Run
1807 directive), you will find it much easier to do using a RunScript
1808 resource, or a RunBeforeJob directive.
1811 \item [Priority = \lt{}number\gt{}]
1812 \index[dir]{Priority}
1813 \index[dir]{Directive!Priority}
1814 This directive permits you to control the order in which your jobs will
1815 be run by specifying a positive non-zero number. The higher the number,
1816 the lower the job priority. Assuming you are not running concurrent jobs,
1817 all queued jobs of priority 1 will run before queued jobs of priority 2
1818 and so on, regardless of the original scheduling order.
1820 The priority only affects waiting jobs that are queued to run, not jobs
1821 that are already running. If one or more jobs of priority 2 are already
1822 running, and a new job is scheduled with priority 1, the currently
1823 running priority 2 jobs must complete before the priority 1 job is
1824 run, unless Allow Mixed Priority is set.
1826 The default priority is 10.
1828 If you want to run concurrent jobs you should
1829 keep these points in mind:
1832 \item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
1835 \item Bacula concurrently runs jobs of only one priority at a time. It
1836 will not simultaneously run a priority 1 and a priority 2 job.
1838 \item If Bacula is running a priority 2 job and a new priority 1 job is
1839 scheduled, it will wait until the running priority 2 job terminates even
1840 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1841 to run simultaneously.
1843 \item Suppose that bacula is running a priority 2 job and a new priority 1
1844 job is scheduled and queued waiting for the running priority 2 job to
1845 terminate. If you then start a second priority 2 job, the waiting
1846 priority 1 job will prevent the new priority 2 job from running
1847 concurrently with the running priority 2 job. That is: as long as there
1848 is a higher priority job waiting to run, no new lower priority jobs will
1849 start even if the Maximum Concurrent Jobs settings would normally allow
1850 them to run. This ensures that higher priority jobs will be run as soon
1854 If you have several jobs of different priority, it may not best to start
1855 them at exactly the same time, because Bacula must examine them one at a
1856 time. If by Bacula starts a lower priority job first, then it will run
1857 before your high priority jobs. If you experience this problem, you may
1858 avoid it by starting any higher priority jobs a few seconds before lower
1859 priority ones. This insures that Bacula will examine the jobs in the
1860 correct order, and that your priority scheme will be respected.
1862 \label{AllowMixedPriority}
1863 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1864 \index[dir]{Allow Mixed Priority}
1865 This directive is only implemented in version 2.5 and later. When
1866 set to {\bf yes} (default {\bf no}), this job may run even if lower
1867 priority jobs are already running. This means a high priority job
1868 will not have to wait for other jobs to finish before starting.
1869 The scheduler will only mix priorities when all running jobs have
1872 Note that only higher priority jobs will start early. Suppose the
1873 director will allow two concurrent jobs, and that two jobs with
1874 priority 10 are running, with two more in the queue. If a job with
1875 priority 5 is added to the queue, it will be run as soon as one of
1876 the running jobs finishes. However, new priority 10 jobs will not
1877 be run until the priority 5 job has finished.
1879 \label{WritePartAfterJob}
1880 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1881 \index[dir]{Write Part After Job}
1882 \index[dir]{Directive!Write Part After Job}
1883 This directive is only implemented in version 1.37 and later.
1884 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1885 will be created after the job is finished.
1887 It should be set to {\bf yes} when writing to devices that require mount
1888 (for example DVD), so you are sure that the current part, containing
1889 this job's data, is written to the device, and that no data is left in
1890 the temporary file on the hard disk. However, on some media, like DVD+R
1891 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1892 written. So, if you run several jobs each after another, you could set
1893 this directive to {\bf no} for all jobs, except the last one, to avoid
1894 wasting too much space, but to ensure that the data is written to the
1895 medium when all jobs are finished.
1897 This directive is ignored with tape and FIFO devices.
1901 The following is an example of a valid Job resource definition:
1908 Level = Incremental # default
1910 FileSet="Minou Full Set"
1913 Schedule = "MinouWeeklyCycle"
1919 \section{The JobDefs Resource}
1920 \label{JobDefsResource}
1921 \index[general]{JobDefs Resource}
1922 \index[general]{Resource!JobDefs}
1924 The JobDefs resource permits all the same directives that can appear in a Job
1925 resource. However, a JobDefs resource does not create a Job, rather it can be
1926 referenced within a Job to provide defaults for that Job. This permits you to
1927 concisely define several nearly identical Jobs, each one referencing a JobDefs
1928 resource which contains the defaults. Only the changes from the defaults need to
1929 be mentioned in each Job.
1931 \section{The Schedule Resource}
1932 \label{ScheduleResource}
1933 \index[general]{Resource!Schedule}
1934 \index[general]{Schedule Resource}
1936 The Schedule resource provides a means of automatically scheduling a Job as
1937 well as the ability to override the default Level, Pool, Storage and Messages
1938 resources. If a Schedule resource is not referenced in a Job, the Job can only
1939 be run manually. In general, you specify an action to be taken and when.
1944 \index[dir]{Schedule}
1945 \index[dir]{Directive!Schedule}
1946 Start of the Schedule directives. No {\bf Schedule} resource is
1947 required, but you will need at least one if you want Jobs to be
1948 automatically started.
1950 \item [Name = \lt{}name\gt{}]
1952 \index[dir]{Directive!Name}
1953 The name of the schedule being defined. The Name directive is required.
1955 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
1957 \index[dir]{Directive!Run}
1958 The Run directive defines when a Job is to be run, and what overrides if
1959 any to apply. You may specify multiple {\bf run} directives within a
1960 {\bf Schedule} resource. If you do, they will all be applied (i.e.
1961 multiple schedules). If you have two {\bf Run} directives that start at
1962 the same time, two Jobs will start at the same time (well, within one
1963 second of each other).
1965 The {\bf Job-overrides} permit overriding the Level, the Storage, the
1966 Messages, and the Pool specifications provided in the Job resource. In
1967 addition, the FullPool, the IncrementalPool, and the DifferentialPool
1968 specifications permit overriding the Pool specification according to
1969 what backup Job Level is in effect.
1971 By the use of overrides, you may customize a particular Job. For
1972 example, you may specify a Messages override for your Incremental
1973 backups that outputs messages to a log file, but for your weekly or
1974 monthly Full backups, you may send the output by email by using a
1975 different Messages override.
1977 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
1978 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
1979 or IncrementalPool, and the {\bf value} is as defined on the respective
1980 directive formats for the Job resource. You may specify multiple {\bf
1981 Job-overrides} on one {\bf Run} directive by separating them with one or
1982 more spaces or by separating them with a trailing comma. For example:
1988 \index[dir]{Directive!Level}
1989 is all files in the FileSet whether or not they have changed.
1991 \item [Level=Incremental]
1993 \index[dir]{Directive!Level}
1994 is all files that have changed since the last backup.
1998 \index[dir]{Directive!Pool}
1999 specifies to use the Pool named {\bf Weekly}.
2001 \item [Storage=DLT\_Drive]
2002 \index[dir]{Storage}
2003 \index[dir]{Directive!Storage}
2004 specifies to use {\bf DLT\_Drive} for the storage device.
2006 \item [Messages=Verbose]
2007 \index[dir]{Messages}
2008 \index[dir]{Directive!Messages}
2009 specifies to use the {\bf Verbose} message resource for the Job.
2011 \item [FullPool=Full]
2012 \index[dir]{FullPool}
2013 \index[dir]{Directive!FullPool}
2014 specifies to use the Pool named {\bf Full} if the job is a full backup, or
2016 upgraded from another type to a full backup.
2018 \item [DifferentialPool=Differential]
2019 \index[dir]{DifferentialPool}
2020 \index[dir]{Directive!DifferentialPool}
2021 specifies to use the Pool named {\bf Differential} if the job is a
2022 differential backup.
2024 \item [IncrementalPool=Incremental]
2025 \index[dir]{IncrementalPool}
2026 \index[dir]{Directive!IncrementalPool}
2027 specifies to use the Pool named {\bf Incremental} if the job is an
2031 \item [Accurate=yes\vb{}no]
2032 \index[dir]{Accurate}
2033 \index[dir]{Directive!Accurate}
2034 tells Bacula to use or not the Accurate code for the specific job. It can
2035 allow you to save memory and and CPU resources on the catalog server in some
2039 \item [WritePartAfterJob=yes\vb{}no]
2040 \index[dir]{WritePartAfterJob}
2041 \index[dir]{Directive!WritePartAfterJob}
2042 tells Bacula to request the Storage daemon to write the current part
2043 file to the device when the job is finished (see \ilink{Write Part After
2044 Job directive in the Job resource}{WritePartAfterJob}). Please note,
2045 this directive is implemented only in version 1.37 and later. The
2046 default is yes. We strongly recommend that you keep this set to yes
2047 otherwise, when the last job has finished one part will remain in the
2048 spool file and restore may or may not work.
2052 {\bf Date-time-specification} determines when the Job is to be run. The
2053 specification is a repetition, and as a default Bacula is set to run a job at
2054 the beginning of the hour of every hour of every day of every week of every
2055 month of every year. This is not normally what you want, so you must specify
2056 or limit when you want the job to run. Any specification given is assumed to
2057 be repetitive in nature and will serve to override or limit the default
2058 repetition. This is done by specifying masks or times for the hour, day of the
2059 month, day of the week, week of the month, week of the year, and month when
2060 you want the job to run. By specifying one or more of the above, you can
2061 define a schedule to repeat at almost any frequency you want.
2063 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
2064 minute} the Job is to be run. Of these four items to be specified, {\bf day}
2065 is special in that you may either specify a day of the month such as 1, 2,
2066 ... 31, or you may specify a day of the week such as Monday, Tuesday, ...
2067 Sunday. Finally, you may also specify a week qualifier to restrict the
2068 schedule to the first, second, third, fourth, or fifth week of the month.
2070 For example, if you specify only a day of the week, such as {\bf Tuesday} the
2071 Job will be run every hour of every Tuesday of every Month. That is the {\bf
2072 month} and {\bf hour} remain set to the defaults of every month and all
2075 Note, by default with no other specification, your job will run at the
2076 beginning of every hour. If you wish your job to run more than once in any
2077 given hour, you will need to specify multiple {\bf run} specifications each
2078 with a different minute.
2080 The date/time to run the Job can be specified in the following way in
2087 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
2088 second | third | fourth | fifth
2089 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
2090 sunday | monday | tuesday | wednesday |
2091 thursday | friday | saturday
2092 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2093 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
2094 aug | sep | oct | nov | dec | january |
2095 february | ... | december
2096 <daily-keyword> = daily
2097 <weekly-keyword> = weekly
2098 <monthly-keyword> = monthly
2099 <hourly-keyword> = hourly
2100 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2101 <number> = <digit> | <digit><number>
2102 <12hour> = 0 | 1 | 2 | ... 12
2103 <hour> = 0 | 1 | 2 | ... 23
2104 <minute> = 0 | 1 | 2 | ... 59
2105 <day> = 1 | 2 | ... 31
2106 <time> = <hour>:<minute> |
2107 <12hour>:<minute>am |
2109 <time-spec> = <at-keyword> <time> |
2111 <date-keyword> = <void-keyword> <weekly-keyword>
2112 <day-range> = <day>-<day>
2113 <month-range> = <month-keyword>-<month-keyword>
2114 <wday-range> = <wday-keyword>-<wday-keyword>
2115 <range> = <day-range> | <month-range> |
2117 <date> = <date-keyword> | <day> | <range>
2118 <date-spec> = <date> | <date-spec>
2119 <day-spec> = <day> | <wday-keyword> |
2120 <day> | <wday-range> |
2121 <week-keyword> <wday-keyword> |
2122 <week-keyword> <wday-range> |
2124 <month-spec> = <month-keyword> | <month-range> |
2126 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2132 Note, the Week of Year specification wnn follows the ISO standard definition
2133 of the week of the year, where Week 1 is the week in which the first Thursday
2134 of the year occurs, or alternatively, the week which contains the 4th of
2135 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2136 precedes the first ISO week (i.e. has the first few days of the year if any
2137 occur before Thursday). w00 is not defined by the ISO specification. A week
2138 starts with Monday and ends with Sunday.
2140 According to the NIST (US National Institute of Standards and Technology),
2141 12am and 12pm are ambiguous and can be defined to anything. However,
2142 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2143 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2144 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2145 am/pm). This is the definition in Bacula version 2.0.3 and later.
2147 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2148 with level full each Sunday at 2:05am and an incremental job Monday through
2149 Saturday at 2:05am is:
2154 Name = "WeeklyCycle"
2155 Run = Level=Full sun at 2:05
2156 Run = Level=Incremental mon-sat at 2:05
2161 An example of a possible monthly cycle is as follows:
2166 Name = "MonthlyCycle"
2167 Run = Level=Full Pool=Monthly 1st sun at 2:05
2168 Run = Level=Differential 2nd-5th sun at 2:05
2169 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2174 The first of every month:
2180 Run = Level=Full on 1 at 2:05
2181 Run = Level=Incremental on 2-31 at 2:05
2192 Run = Level=Full hourly at 0:05
2193 Run = Level=Full hourly at 0:15
2194 Run = Level=Full hourly at 0:25
2195 Run = Level=Full hourly at 0:35
2196 Run = Level=Full hourly at 0:45
2197 Run = Level=Full hourly at 0:55
2202 \section{Technical Notes on Schedules}
2203 \index[general]{Schedules!Technical Notes on}
2204 \index[general]{Technical Notes on Schedules}
2206 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2207 minute field to each schedule. The masks are hour, day of the month (mday),
2208 month, day of the week (wday), week of the month (wom), and week of the year
2209 (woy). The schedule is initialized to have the bits of each of these masks
2210 set, which means that at the beginning of every hour, the job will run. When
2211 you specify a month for the first time, the mask will be cleared and the bit
2212 corresponding to your selected month will be selected. If you specify a second
2213 month, the bit corresponding to it will also be added to the mask. Thus when
2214 Bacula checks the masks to see if the bits are set corresponding to the
2215 current time, your job will run only in the two months you have set. Likewise,
2216 if you set a time (hour), the hour mask will be cleared, and the hour you
2217 specify will be set in the bit mask and the minutes will be stored in the
2220 For any schedule you have defined, you can see how these bits are set by doing
2221 a {\bf show schedules} command in the Console program. Please note that the
2222 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2226 \section{The Client Resource}
2227 \label{ClientResource2}
2228 \index[general]{Resource!Client}
2229 \index[general]{Client Resource}
2231 The Client resource defines the attributes of the Clients that are served by
2232 this Director; that is the machines that are to be backed up. You will need
2233 one Client resource definition for each machine to be backed up.
2237 \item [Client (or FileDaemon)]
2238 \index[dir]{Client (or FileDaemon)}
2239 \index[dir]{Directive!Client (or FileDaemon)}
2240 Start of the Client directives.
2242 \item [Name = \lt{}name\gt{}]
2244 \index[dir]{Directive!Name}
2245 The client name which will be used in the Job resource directive or in the
2246 console run command. This directive is required.
2248 \item [Address = \lt{}address\gt{}]
2249 \index[dir]{Address}
2250 \index[dir]{Directive!FD Address}
2251 \index[dir]{File Daemon Address}
2252 \index[dir]{Client Address}
2253 Where the address is a host name, a fully qualified domain name, or a
2254 network address in dotted quad notation for a Bacula File server daemon.
2255 This directive is required.
2257 \item [FD Port = \lt{}port-number\gt{}]
2258 \index[dir]{FD Port}
2259 \index[dir]{Directive!FD Port}
2260 Where the port is a port number at which the Bacula File server daemon can
2261 be contacted. The default is 9102.
2263 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2264 \index[dir]{Catalog}
2265 \index[dir]{Directive!Catalog}
2266 This specifies the name of the catalog resource to be used for this Client.
2267 This directive is required.
2269 \item [Password = \lt{}password\gt{}]
2270 \index[dir]{Password}
2271 \index[dir]{Directive!Password}
2272 This is the password to be used when establishing a connection with the File
2273 services, so the Client configuration file on the machine to be backed up
2274 must have the same password defined for this Director. This directive is
2275 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2276 Bacula will generate a random password during the configuration process,
2277 otherwise it will be left blank.
2279 The password is plain text. It is not generated through any special
2280 process, but it is preferable for security reasons to make the text
2283 \label{FileRetention}
2284 \item [File Retention = \lt{}time-period-specification\gt{}]
2285 \label{FileRetention}
2286 \index[dir]{File Retention}
2287 \index[dir]{Directive!File Retention}
2288 The File Retention directive defines the length of time that Bacula will
2289 keep File records in the Catalog database after the End time of the
2290 Job corresponding to the File records.
2291 When this time period expires, and if
2292 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2293 that are older than the specified File Retention period. Note, this affects
2294 only records in the catalog database. It does not affect your archive
2297 File records may actually be retained for a shorter period than you specify
2298 on this directive if you specify either a shorter {\bf Job Retention} or a
2299 shorter {\bf Volume Retention} period. The shortest retention period of the
2300 three takes precedence. The time may be expressed in seconds, minutes,
2301 hours, days, weeks, months, quarters, or years. See the
2302 \ilink{ Configuration chapter}{Time} of this manual for
2303 additional details of time specification.
2305 The default is 60 days.
2307 \label{JobRetention}
2308 \item [Job Retention = \lt{}time-period-specification\gt{}]
2309 \label{JobRetention}
2310 \index[dir]{Job Retention}
2311 \index[dir]{Directive!Job Retention}
2312 The Job Retention directive defines the length of time that Bacula will keep
2313 Job records in the Catalog database after the Job End time. When
2314 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2315 Bacula will prune (remove) Job records that are older than the specified
2316 File Retention period. As with the other retention periods, this
2317 affects only records in the catalog and not data in your archive backup.
2319 If a Job record is selected for pruning, all associated File and JobMedia
2320 records will also be pruned regardless of the File Retention period set.
2321 As a consequence, you normally will set the File retention period to be
2322 less than the Job retention period. The Job retention period can actually
2323 be less than the value you specify here if you set the {\bf Volume
2324 Retention} directive in the Pool resource to a smaller duration. This is
2325 because the Job retention period and the Volume retention period are
2326 independently applied, so the smaller of the two takes precedence.
2328 The Job retention period is specified as seconds, minutes, hours, days,
2329 weeks, months, quarters, or years. See the
2330 \ilink{ Configuration chapter}{Time} of this manual for
2331 additional details of time specification.
2333 The default is 180 days.
2336 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2337 \index[dir]{AutoPrune}
2338 \index[dir]{Directive!AutoPrune}
2339 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2340 will automatically apply the File retention period and the Job retention
2341 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2342 pruning will not be done, and your Catalog will grow in size each time you
2343 run a Job. Pruning affects only information in the catalog and not data
2344 stored in the backup archives (on Volumes).
2346 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2347 \index[dir]{Maximum Concurrent Jobs}
2348 \index[dir]{Directive!Maximum Concurrent Jobs}
2349 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2350 that can run concurrently. Note, this directive limits only Jobs for Clients
2351 with the same name as the resource in which it appears. Any other
2352 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2353 Storage resources will also apply in addition to any limit specified here.
2354 The default is set to 1, but you may set it to a larger number.
2356 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2357 \index[dir]{Maximum Bandwidth Per Job}
2358 \index[dir]{Directive!Maximum Bandwidth Per Job}
2360 The speed parameter specifies the maximum allowed bandwidth that a job may use
2361 when started for this Client. The speed parameter should be specified in
2362 k/s, Kb/s, m/s or Mb/s.
2364 \item [Priority = \lt{}number\gt{}]
2365 \index[dir]{Priority}
2366 \index[dir]{Directive!Priority}
2367 The number specifies the priority of this client relative to other clients
2368 that the Director is processing simultaneously. The priority can range from
2369 1 to 1000. The clients are ordered such that the smaller number priorities
2370 are performed first (not currently implemented).
2373 The following is an example of a valid Client resource definition:
2379 FDAddress = minimatou
2381 Password = very_good
2386 \section{The Storage Resource}
2387 \label{StorageResource2}
2388 \index[general]{Resource!Storage}
2389 \index[general]{Storage Resource}
2391 The Storage resource defines which Storage daemons are available for use by
2397 \index[dir]{Storage}
2398 \index[dir]{Directive!Storage}
2399 Start of the Storage resources. At least one storage resource must be
2402 \item [Name = \lt{}name\gt{}]
2404 \index[dir]{Directive!Name}
2405 The name of the storage resource. This name appears on the Storage directive
2406 specified in the Job resource and is required.
2408 \item [Address = \lt{}address\gt{}]
2409 \index[dir]{Address}
2410 \index[dir]{Directive!SD Address}
2411 \index[dir]{Storage daemon Address}
2412 Where the address is a host name, a {\bf fully qualified domain name}, or an
2413 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2414 will be transmitted to the File daemon who will then use it to contact the
2415 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2416 the name but rather a fully qualified machine name or an IP address. This
2417 directive is required.
2419 \item [SD Port = \lt{}port\gt{}]
2420 \index[dir]{SD Port}
2421 \index[dir]{Directive!SD Port}
2422 Where port is the port to use to contact the storage daemon for information
2423 and to start jobs. This same port number must appear in the Storage resource
2424 of the Storage daemon's configuration file. The default is 9103.
2426 \item [Password = \lt{}password\gt{}]
2427 \index[dir]{Password}
2428 \index[dir]{Directive!Password}
2429 This is the password to be used when establishing a connection with the
2430 Storage services. This same password also must appear in the Director
2431 resource of the Storage daemon's configuration file. This directive is
2432 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2433 Bacula will generate a random password during the configuration process,
2434 otherwise it will be left blank.
2436 The password is plain text. It is not generated through any special
2437 process, but it is preferable for security reasons to use random text.
2439 \item [Device = \lt{}device-name\gt{}]
2441 \index[dir]{Directive!Device}
2442 This directive specifies the Storage daemon's name of the device
2443 resource to be used for the storage. If you are using an Autochanger,
2444 the name specified here should be the name of the Storage daemon's
2445 Autochanger resource rather than the name of an individual device. This
2446 name is not the physical device name, but the logical device name as
2447 defined on the {\bf Name} directive contained in the {\bf Device} or the
2448 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2449 configuration file. You can specify any name you would like (even the
2450 device name if you prefer) up to a maximum of 127 characters in length.
2451 The physical device name associated with this device is specified in the
2452 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2453 Please take care not to define two different Storage resource directives
2454 in the Director that point to the same Device in the Storage daemon.
2455 Doing so may cause the Storage daemon to block (or hang) attempting to
2456 open the same device that is already open. This directive is required.
2459 \item [Media Type = \lt{}MediaType\gt{}]
2460 \index[dir]{Media Type}
2461 \index[dir]{Directive!Media Type}
2462 This directive specifies the Media Type to be used to store the data.
2463 This is an arbitrary string of characters up to 127 maximum that you
2464 define. It can be anything you want. However, it is best to make it
2465 descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
2466 ...). In addition, it is essential that you make the {\bf Media Type}
2467 specification unique for each storage media type. If you have two DDS-4
2468 drives that have incompatible formats, or if you have a DDS-4 drive and
2469 a DDS-4 autochanger, you almost certainly should specify different {\bf
2470 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2471 associated with the Job, Bacula can decide to use any Storage daemon
2472 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2474 If you are writing to disk Volumes, you must make doubly sure that each
2475 Device resource defined in the Storage daemon (and hence in the
2476 Director's conf file) has a unique media type. Otherwise for Bacula
2477 versions 1.38 and older, your restores may not work because Bacula
2478 will assume that you can mount any Media Type with the same name on
2479 any Device associated with that Media Type. This is possible with
2480 tape drives, but with disk drives, unless you are very clever you
2481 cannot mount a Volume in any directory -- this can be done by creating
2482 an appropriate soft link.
2484 Currently Bacula permits only a single Media Type per Storage
2485 and Device definition. Consequently, if
2486 you have a drive that supports more than one Media Type, you can
2487 give a unique string to Volumes with different intrinsic Media
2488 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2489 those volumes will only be mounted on drives indicated with the
2490 dual type (DDS-3-4).
2492 If you want to tie Bacula to using a single Storage daemon or drive, you
2493 must specify a unique Media Type for that drive. This is an important
2494 point that should be carefully understood. Note, this applies equally
2495 to Disk Volumes. If you define more than one disk Device resource in
2496 your Storage daemon's conf file, the Volumes on those two devices are in
2497 fact incompatible because one can not be mounted on the other device
2498 since they are found in different directories. For this reason, you
2499 probably should use two different Media Types for your two disk Devices
2500 (even though you might think of them as both being File types). You can
2501 find more on this subject in the \ilink{Basic Volume
2502 Management}{DiskChapter} chapter of this manual.
2504 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2505 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2506 resource of the {\bf Storage daemon} configuration file. This directive
2507 is required, and it is used by the Director and the Storage daemon to
2508 ensure that a Volume automatically selected from the Pool corresponds to
2509 the physical device. If a Storage daemon handles multiple devices (e.g.
2510 will write to various file Volumes on different partitions), this
2511 directive allows you to specify exactly which device.
2513 As mentioned above, the value specified in the Director's Storage
2514 resource must agree with the value specified in the Device resource in
2515 the {\bf Storage daemon's} configuration file. It is also an additional
2516 check so that you don't try to write data for a DLT onto an 8mm device.
2518 \label{Autochanger1}
2519 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2520 \index[dir]{Autochanger}
2521 \index[dir]{Directive!Autochanger}
2522 If you specify {\bf yes} for this command (the default is {\bf no}),
2523 when you use the {\bf label} command or the {\bf add} command to create
2524 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2525 number. This simplifies creating database entries for Volumes in an
2526 autochanger. If you forget to specify the Slot, the autochanger will
2527 not be used. However, you may modify the Slot associated with a Volume
2528 at any time by using the {\bf update volume} or {\bf update slots}
2529 command in the console program. When {\bf autochanger} is enabled, the
2530 algorithm used by Bacula to search for available volumes will be
2531 modified to consider only Volumes that are known to be in the
2532 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2533 will attempt recycling, pruning, ..., and if still no volume is found,
2534 Bacula will search for any volume whether or not in the magazine. By
2535 privileging in changer volumes, this procedure minimizes operator
2536 intervention. The default is {\bf no}.
2538 For the autochanger to be used, you must also specify {\bf Autochanger =
2539 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2540 configuration file as well as other important Storage daemon
2541 configuration information. Please consult the \ilink{Using
2542 Autochangers}{AutochangersChapter} manual of this chapter for the
2543 details of using autochangers.
2545 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2546 \index[dir]{Maximum Concurrent Jobs}
2547 \index[dir]{Directive!Maximum Concurrent Jobs}
2548 where \lt{}number\gt{} is the maximum number of Jobs with the current
2549 Storage resource that can run concurrently. Note, this directive limits
2550 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2551 the maximum concurrent jobs such as in the Director, Job, or Client
2552 resources will also apply in addition to any limit specified here. The
2553 default is set to 1, but you may set it to a larger number. However, if
2554 you set the Storage daemon's number of concurrent jobs greater than one,
2555 we recommend that you read the waring documented under \ilink{Maximum
2556 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2557 turn data spooling on as documented in the \ilink{Data
2558 Spooling}{SpoolingChapter} chapter of this manual.
2560 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2561 \label{AllowCompression}
2562 \index[dir]{AllowCompression}
2563 \index[dir]{Directive!AllowCompression}
2565 This directive is optional, and if you specify {\bf No} (the default is {\bf
2566 Yes}), it will cause backups jobs running on this storage resource to run
2567 without client File Daemon compression. This effectively overrides
2568 compression options in FileSets used by jobs which use this storage
2571 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2572 \index[dir]{Heartbeat Interval}
2573 \index[dir]{Directive!Heartbeat}
2574 This directive is optional and if specified will cause the Director to
2575 set a keepalive interval (heartbeat) in seconds on each of the sockets
2576 it opens for the Storage resource. This value will override any
2577 specified at the Director level. It is implemented only on systems
2578 (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2579 The default value is zero, which means no change is made to the socket.
2583 The following is an example of a valid Storage resource definition:
2587 # Definition of tape storage device
2591 Password = storage_password # password for Storage daemon
2592 Device = "HP DLT 80" # same as Device in Storage daemon
2593 Media Type = DLT8000 # same as MediaType in Storage daemon
2598 \section{The Pool Resource}
2599 \label{PoolResource}
2600 \index[general]{Resource!Pool}
2601 \index[general]{Pool Resource}
2603 The Pool resource defines the set of storage Volumes (tapes or files) to be
2604 used by Bacula to write the data. By configuring different Pools, you can
2605 determine which set of Volumes (media) receives the backup data. This permits,
2606 for example, to store all full backup data on one set of Volumes and all
2607 incremental backups on another set of Volumes. Alternatively, you could assign
2608 a different set of Volumes to each machine that you backup. This is most
2609 easily done by defining multiple Pools.
2611 Another important aspect of a Pool is that it contains the default attributes
2612 (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
2613 Volume when it is created. This avoids the need for you to answer a large
2614 number of questions when labeling a new Volume. Each of these attributes can
2615 later be changed on a Volume by Volume basis using the {\bf update} command in
2616 the console program. Note that you must explicitly specify which Pool Bacula
2617 is to use with each Job. Bacula will not automatically search for the correct
2620 Most often in Bacula installations all backups for all machines (Clients) go
2621 to a single set of Volumes. In this case, you will probably only use the {\bf
2622 Default} Pool. If your backup strategy calls for you to mount a different tape
2623 each day, you will probably want to define a separate Pool for each day. For
2624 more information on this subject, please see the
2625 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2629 To use a Pool, there are three distinct steps. First the Pool must be defined
2630 in the Director's configuration file. Then the Pool must be written to the
2631 Catalog database. This is done automatically by the Director each time that it
2632 starts, or alternatively can be done using the {\bf create} command in the
2633 console program. Finally, if you change the Pool definition in the Director's
2634 configuration file and restart Bacula, the pool will be updated alternatively
2635 you can use the {\bf update pool} console command to refresh the database
2636 image. It is this database image rather than the Director's resource image
2637 that is used for the default Volume attributes. Note, for the pool to be
2638 automatically created or updated, it must be explicitly referenced by a Job
2641 Next the physical media must be labeled. The labeling can either be done with
2642 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2643 program. The preferred method is to use the {\bf label} command in the {\bf
2646 Finally, you must add Volume names (and their attributes) to the Pool. For
2647 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2648 archive device specified for the job (i.e. if you are going to back up to a
2649 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2650 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2651 are backing up to files. When running a Job, you must explicitly specify which
2652 Pool to use. Bacula will then automatically select the next Volume to use from
2653 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2654 from the Pool is identical to that required by the Storage resource you have
2655 specified for the Job.
2657 If you use the {\bf label} command in the console program to label the
2658 Volumes, they will automatically be added to the Pool, so this last step is
2659 not normally required.
2661 It is also possible to add Volumes to the database without explicitly labeling
2662 the physical volume. This is done with the {\bf add} console command.
2664 As previously mentioned, each time Bacula starts, it scans all the Pools
2665 associated with each Catalog, and if the database record does not already
2666 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2667 probably should do an {\bf update pool} if you change the Pool definition, but
2668 currently, you must do this manually using the {\bf update pool} command in
2669 the Console program.
2671 The Pool Resource defined in the Director's configuration file
2672 (bacula-dir.conf) may contain the following directives:
2678 \index[dir]{Directive!Pool}
2679 Start of the Pool resource. There must be at least one Pool resource
2683 \item [Name = \lt{}name\gt{}]
2685 \index[dir]{Directive!Name}
2686 The name of the pool. For most applications, you will use the default
2687 pool name {\bf Default}. This directive is required.
2690 \item [Maximum Volumes = \lt{}number\gt{}]
2691 \index[dir]{Maximum Volumes}
2692 \index[dir]{Directive!Maximum Volumes}
2693 This directive specifies the maximum number of volumes (tapes or files)
2694 contained in the pool. This directive is optional, if omitted or set to
2695 zero, any number of volumes will be permitted. In general, this
2696 directive is useful for Autochangers where there is a fixed number of
2697 Volumes, or for File storage where you wish to ensure that the backups
2698 made to disk files do not become too numerous or consume too much space.
2700 \item [Pool Type = \lt{}type\gt{}]
2701 \index[dir]{Pool Type}
2702 \index[dir]{Directive!Pool Type}
2703 This directive defines the pool type, which corresponds to the type of
2704 Job being run. It is required and may be one of the following:
2714 Note, only Backup is current implemented.
2716 \item [Storage = \lt{}storage-resource-name\gt{}]
2717 \index[dir]{Storage}
2718 \index[dir]{Directive!Storage}
2719 The Storage directive defines the name of the storage services where you
2720 want to backup the FileSet data. For additional details, see the
2721 \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
2722 The Storage resource may also be specified in the Job resource,
2723 but the value, if any, in the Pool resource overrides any value
2724 in the Job. This Storage resource definition is not required by either
2725 the Job resource or in the Pool, but it must be specified in
2726 one or the other. If not configuration error will result.
2728 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2729 \index[dir]{Use Volume Once}
2730 \index[dir]{Directive!Use Volume Once}
2731 This directive if set to {\bf yes} specifies that each volume is to be
2732 used only once. This is most useful when the Media is a file and you
2733 want a new file for each backup that is done. The default is {\bf no}
2734 (i.e. use volume any number of times). This directive will most likely
2735 be phased out (deprecated), so you are recommended to use {\bf Maximum
2736 Volume Jobs = 1} instead.
2738 The value defined by this directive in the bacula-dir.conf file is the
2739 default value used when a Volume is created. Once the volume is
2740 created, changing the value in the bacula-dir.conf file will not change
2741 what is stored for the Volume. To change the value for an existing
2742 Volume you must use the {\bf update} command in the Console.
2744 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2745 using this directive with multiple simultaneous jobs.
2747 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2748 \index[dir]{Maximum Volume Jobs}
2749 \index[dir]{Directive!Maximum Volume Jobs}
2750 This directive specifies the maximum number of Jobs that can be written
2751 to the Volume. If you specify zero (the default), there is no limit.
2752 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2753 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2754 is marked {\bf Used} it can no longer be used for appending Jobs, much
2755 like the {\bf Full} status but it can be recycled if recycling is
2756 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2757 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2759 The value defined by this directive in the bacula-dir.conf
2760 file is the default value used when a Volume is created. Once the volume is
2761 created, changing the value in the bacula-dir.conf file will not change what
2762 is stored for the Volume. To change the value for an existing Volume you
2763 must use the {\bf update} command in the Console.
2765 If you are running multiple simultaneous jobs, this directive may not
2766 work correctly because when a drive is reserved for a job, this
2767 directive is not taken into account, so multiple jobs may try to
2768 start writing to the Volume. At some point, when the Media record is
2769 updated, multiple simultaneous jobs may fail since the Volume can no
2772 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2773 \index[dir]{Maximum Volume Files}
2774 \index[dir]{Directive!Maximum Volume Files}
2775 This directive specifies the maximum number of files that can be written
2776 to the Volume. If you specify zero (the default), there is no limit.
2777 Otherwise, when the number of files written to the Volume equals {\bf
2778 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2779 is marked {\bf Used} it can no longer be used for appending Jobs, much
2780 like the {\bf Full} status but it can be recycled if recycling is
2781 enabled and thus used again. This value is checked and the {\bf Used}
2782 status is set only at the end of a job that writes to the particular
2785 The value defined by this directive in the bacula-dir.conf file is the
2786 default value used when a Volume is created. Once the volume is
2787 created, changing the value in the bacula-dir.conf file will not change
2788 what is stored for the Volume. To change the value for an existing
2789 Volume you must use the {\bf update} command in the Console.
2791 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2792 \index[dir]{Maximum Volume Bytes}
2793 \index[dir]{Directive!Maximum Volume Bytes}
2794 This directive specifies the maximum number of bytes that can be written
2795 to the Volume. If you specify zero (the default), there is no limit
2796 except the physical size of the Volume. Otherwise, when the number of
2797 bytes written to the Volume equals {\bf size} the Volume will be marked
2798 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2799 used for appending Jobs, much like the {\bf Full} status but it can be
2800 recycled if recycling is enabled, and thus the Volume can be re-used
2801 after recycling. This value is checked and the {\bf Used} status set
2802 while the job is writing to the particular volume.
2804 This directive is particularly useful for restricting the size
2805 of disk volumes, and will work correctly even in the case of
2806 multiple simultaneous jobs writing to the volume.
2808 The value defined by this directive in the bacula-dir.conf file is the
2809 default value used when a Volume is created. Once the volume is
2810 created, changing the value in the bacula-dir.conf file will not change
2811 what is stored for the Volume. To change the value for an existing
2812 Volume you must use the {\bf update} command in the Console.
2814 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2815 \index[dir]{Volume Use Duration}
2816 \index[dir]{Directive!Volume Use Duration}
2817 The Volume Use Duration directive defines the time period that the
2818 Volume can be written beginning from the time of first data write to the
2819 Volume. If the time-period specified is zero (the default), the Volume
2820 can be written indefinitely. Otherwise, the next time a job
2821 runs that wants to access this Volume, and the time period from the
2822 first write to the volume (the first Job written) exceeds the
2823 time-period-specification, the Volume will be marked {\bf Used}, which
2824 means that no more Jobs can be appended to the Volume, but it may be
2825 recycled if recycling is enabled. Using the command {\bf
2826 status dir} applies algorithms similar to running jobs, so
2827 during such a command, the Volume status may also be changed.
2829 recycled, it will be available for use again.
2831 You might use this directive, for example, if you have a Volume used for
2832 Incremental backups, and Volumes used for Weekly Full backups. Once the
2833 Full backup is done, you will want to use a different Incremental
2834 Volume. This can be accomplished by setting the Volume Use Duration for
2835 the Incremental Volume to six days. I.e. it will be used for the 6
2836 days following a Full save, then a different Incremental volume will be
2837 used. Be careful about setting the duration to short periods such as 23
2838 hours, or you might experience problems of Bacula waiting for a tape
2839 over the weekend only to complete the backups Monday morning when an
2840 operator mounts a new tape.
2842 The use duration is checked and the {\bf Used} status is set only at the
2843 end of a job that writes to the particular volume, which means that even
2844 though the use duration may have expired, the catalog entry will not be
2845 updated until the next job that uses this volume is run. This
2846 directive is not intended to be used to limit volume sizes
2847 and will not work correctly (i.e. will fail jobs) if the use
2848 duration expires while multiple simultaneous jobs are writing
2851 Please note that the value defined by this directive in the bacula-dir.conf
2852 file is the default value used when a Volume is created. Once the volume is
2853 created, changing the value in the bacula-dir.conf file will not change what
2854 is stored for the Volume. To change the value for an existing Volume you
2856 \ilink{\bf update volume}{UpdateCommand} command in the Console.
2858 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
2859 \index[dir]{Catalog Files}
2860 \index[dir]{Directive!Catalog Files}
2861 This directive defines whether or not you want the names of the files
2862 that were saved to be put into the catalog. The default is {\bf yes}.
2863 The advantage of specifying {\bf Catalog Files = No} is that you will
2864 have a significantly smaller Catalog database. The disadvantage is that
2865 you will not be able to produce a Catalog listing of the files backed up
2866 for each Job (this is often called Browsing). Also, without the File
2867 entries in the catalog, you will not be able to use the Console {\bf
2868 restore} command nor any other command that references File entries.
2870 \label{PoolAutoPrune}
2871 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2872 \index[dir]{AutoPrune}
2873 \index[dir]{Directive!AutoPrune}
2874 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
2875 greater) will automatically apply the Volume Retention period when new
2876 Volume is needed and no appendable Volumes exist in the Pool. Volume
2877 pruning causes expired Jobs (older than the {\bf Volume Retention}
2878 period) to be deleted from the Catalog and permits possible recycling of
2881 \label{VolRetention}
2882 \item [Volume Retention = \lt{}time-period-specification\gt{}]
2883 \index[dir]{Volume Retention}
2884 \index[dir]{Directive!Volume Retention}
2885 The Volume Retention directive defines the length of time that {\bf
2886 Bacula} will keep records associated with the Volume in
2887 the Catalog database after the End time of each Job written to the
2888 Volume. When this time period expires, and if {\bf AutoPrune} is set to
2889 {\bf yes} Bacula may prune (remove) Job records that are older than the
2890 specified Volume Retention period if it is necessary to free up a
2891 Volume. Recycling will not occur until it is absolutely necessary to
2892 free up a volume (i.e. no other writable volume exists).
2893 All File records associated with pruned Jobs are also
2894 pruned. The time may be specified as seconds, minutes, hours, days,
2895 weeks, months, quarters, or years. The {\bf Volume Retention} is
2896 applied independently of the {\bf Job Retention} and the {\bf File
2897 Retention} periods defined in the Client resource. This means that all
2898 the retentions periods are applied in turn and that the shorter period
2899 is the one that effectively takes precedence. Note, that when the {\bf
2900 Volume Retention} period has been reached, and it is necessary to obtain
2901 a new volume, Bacula will prune both the Job and the File records. This
2902 pruning could also occur during a {\bf status dir} command because it
2903 uses similar algorithms for finding the next available Volume.
2905 It is important to know that when the Volume Retention period expires,
2906 Bacula does not automatically recycle a Volume. It attempts to keep the
2907 Volume data intact as long as possible before over writing the Volume.
2909 By defining multiple Pools with different Volume Retention periods, you
2910 may effectively have a set of tapes that is recycled weekly, another
2911 Pool of tapes that is recycled monthly and so on. However, one must
2912 keep in mind that if your {\bf Volume Retention} period is too short, it
2913 may prune the last valid Full backup, and hence until the next Full
2914 backup is done, you will not have a complete backup of your system, and
2915 in addition, the next Incremental or Differential backup will be
2916 promoted to a Full backup. As a consequence, the minimum {\bf Volume
2917 Retention} period should be at twice the interval of your Full backups.
2918 This means that if you do a Full backup once a month, the minimum Volume
2919 retention period should be two months.
2921 The default Volume retention period is 365 days, and either the default
2922 or the value defined by this directive in the bacula-dir.conf file is
2923 the default value used when a Volume is created. Once the volume is
2924 created, changing the value in the bacula-dir.conf file will not change
2925 what is stored for the Volume. To change the value for an existing
2926 Volume you must use the {\bf update} command in the Console.
2928 \item [Action On Purge = \lt{Truncate}]
2929 \index[dir]{actiononpurge}
2931 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
2932 volume when it is purged with the \texttt{purge volume action=truncate}
2933 command. It is useful to prevent disk based volumes from consuming too much
2939 Action On Purge = Truncate
2944 You can schedule the truncate operation at the end of your CatalogBackup job
2945 like in this example:
2949 Name = CatalogBackup
2954 Console = "purge volume action=all allpools storage=File"
2959 \label{PoolScratchPool}
2960 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
2961 \index[dir]{ScrachPool}
2962 \index[dir]{Directive!ScrachPool}
2963 This directive permits to specify a dedicate \textsl{Scratch} for the
2964 current pool. This pool will replace the special pool named \textsl{Scrach}
2965 for volume selection. For more information about \textsl{Scratch} see
2966 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
2967 when using multiple storage sharing the same mediatype or when you want to
2968 dedicate volumes to a particular set of pool.
2970 \label{PoolRecyclePool}
2971 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
2972 \index[dir]{RecyclePool}
2973 \index[dir]{Directive!RecyclePool}
2974 This directive defines to which pool
2975 the Volume will be placed (moved) when it is recycled. Without
2976 this directive, a Volume will remain in the same pool when it is
2977 recycled. With this directive, it can be moved automatically to any
2978 existing pool during a recycle. This directive is probably most
2979 useful when defined in the Scratch pool, so that volumes will
2980 be recycled back into the Scratch pool. For more on the see the
2981 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
2983 Although this directive is called RecyclePool, the Volume in
2984 question is actually moved from its current pool to the one
2985 you specify on this directive when Bacula prunes the Volume and
2986 discovers that there are no records left in the catalog and hence
2987 marks it as {\bf Purged}.
2991 \item [Recycle = \lt{}yes\vb{}no\gt{}]
2992 \index[dir]{Recycle}
2993 \index[dir]{Directive!Recycle}
2994 This directive specifies whether or not Purged Volumes may be recycled.
2995 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
2996 none that are appendable, it will search for and recycle (reuse) Purged
2997 Volumes (i.e. volumes with all the Jobs and Files expired and thus
2998 deleted from the Catalog). If the Volume is recycled, all previous data
2999 written to that Volume will be overwritten. If Recycle is set to {\bf
3000 no}, the Volume will not be recycled, and hence, the data will remain
3001 valid. If you want to reuse (re-write) the Volume, and the recycle flag
3002 is no (0 in the catalog), you may manually set the recycle flag (update
3003 command) for a Volume to be reused.
3005 Please note that the value defined by this directive in the
3006 bacula-dir.conf file is the default value used when a Volume is created.
3007 Once the volume is created, changing the value in the bacula-dir.conf
3008 file will not change what is stored for the Volume. To change the value
3009 for an existing Volume you must use the {\bf update} command in the
3012 When all Job and File records have been pruned or purged from the
3013 catalog for a particular Volume, if that Volume is marked as
3014 Append, Full, Used, or Error, it will then be marked as Purged. Only
3015 Volumes marked as Purged will be considered to be converted to the
3016 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
3019 \label{RecycleOldest}
3020 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
3021 \index[dir]{Recycle Oldest Volume}
3022 \index[dir]{Directive!Recycle Oldest Volume}
3023 This directive instructs the Director to search for the oldest used
3024 Volume in the Pool when another Volume is requested by the Storage
3025 daemon and none are available. The catalog is then {\bf pruned}
3026 respecting the retention periods of all Files and Jobs written to this
3027 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
3028 Volume is recycled and will be used as the next Volume to be written.
3029 This directive respects any Job, File, or Volume retention periods that
3030 you may have specified, and as such it is {\bf much} better to use this
3031 directive than the Purge Oldest Volume.
3033 This directive can be useful if you have a fixed number of Volumes in the
3034 Pool and you want to cycle through them and you have specified the correct
3037 However, if you use this directive and have only one
3038 Volume in the Pool, you will immediately recycle your Volume if you fill
3039 it and Bacula needs another one. Thus your backup will be totally invalid.
3040 Please use this directive with care. The default is {\bf no}.
3042 \label{RecycleCurrent}
3044 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3045 \index[dir]{Recycle Current Volume}
3046 \index[dir]{Directive!Recycle Current Volume}
3047 If Bacula needs a new Volume, this directive instructs Bacula to Prune
3048 the volume respecting the Job and File retention periods. If all Jobs
3049 are pruned (i.e. the volume is Purged), then the Volume is recycled and
3050 will be used as the next Volume to be written. This directive respects
3051 any Job, File, or Volume retention periods that you may have specified,
3052 and thus it is {\bf much} better to use it rather than the Purge Oldest
3055 This directive can be useful if you have: a fixed number of Volumes in
3056 the Pool, you want to cycle through them, and you have specified
3057 retention periods that prune Volumes before you have cycled through the
3060 However, if you use this directive and have only one Volume in the Pool,
3061 you will immediately recycle your Volume if you fill it and Bacula needs
3062 another one. Thus your backup will be totally invalid. Please use this
3063 directive with care. The default is {\bf no}.
3067 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3068 \index[dir]{Purge Oldest Volume}
3069 \index[dir]{Directive!Purge Oldest Volume}
3070 This directive instructs the Director to search for the oldest used
3071 Volume in the Pool when another Volume is requested by the Storage
3072 daemon and none are available. The catalog is then {\bf purged}
3073 irrespective of retention periods of all Files and Jobs written to this
3074 Volume. The Volume is then recycled and will be used as the next Volume
3075 to be written. This directive overrides any Job, File, or Volume
3076 retention periods that you may have specified.
3078 This directive can be useful if you have a fixed number of Volumes in
3079 the Pool and you want to cycle through them and reusing the oldest one
3080 when all Volumes are full, but you don't want to worry about setting
3081 proper retention periods. However, by using this option you risk losing
3084 Please be aware that {\bf Purge Oldest Volume} disregards all retention
3085 periods. If you have only a single Volume defined and you turn this
3086 variable on, that Volume will always be immediately overwritten when it
3087 fills! So at a minimum, ensure that you have a decent number of Volumes
3088 in your Pool before running any jobs. If you want retention periods to
3089 apply do not use this directive. To specify a retention period, use the
3090 {\bf Volume Retention} directive (see above).
3092 We {\bf highly} recommend against using this directive, because it is
3093 sure that some day, Bacula will recycle a Volume that contains current
3094 data. The default is {\bf no}.
3096 \item [File Retention = \lt{}time-period-specification\gt{}]
3097 \index[dir]{File Retention}
3098 \index[dir]{Directive!File Retention}
3099 The File Retention directive defines the length of time that Bacula will
3100 keep File records in the Catalog database after the End time of the
3101 Job corresponding to the File records.
3103 This directive takes precedence over Client directives of the same name. For
3104 example, you can decide to increase Retention times for Archive or OffSite
3107 Note, this affects only records in the catalog database. It does not affect
3108 your archive backups.
3110 For more information see Client documentation about
3111 \ilink{FileRetention}{FileRetention}
3113 \item [Job Retention = \lt{}time-period-specification\gt{}]
3114 \index[dir]{Job Retention}
3115 \index[dir]{Directive!Job Retention}
3117 The Job Retention directive defines the length of time that Bacula will keep
3118 Job records in the Catalog database after the Job End time. As with the
3119 other retention periods, this affects only records in the catalog and not
3120 data in your archive backup.
3122 This directive takes precedence over Client directives of the same name.
3123 For example, you can decide to increase Retention times for Archive or
3126 For more information see Client side documentation
3127 \ilink{JobRetention}{JobRetention}
3129 \item [Cleaning Prefix = \lt{}string\gt{}]
3130 \index[dir]{Cleaning Prefix}
3131 \index[dir]{Directive!Cleaning Prefix}
3132 This directive defines a prefix string, which if it matches the
3133 beginning of a Volume name during labeling of a Volume, the Volume will
3134 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3135 never attempt to use this tape. This is primarily for use with
3136 autochangers that accept barcodes where the convention is that barcodes
3137 beginning with {\bf CLN} are treated as cleaning tapes.
3140 \item [Label Format = \lt{}format\gt{}]
3141 \index[dir]{Label Format}
3142 \index[dir]{Directive!Label Format}
3143 This directive specifies the format of the labels contained in this
3144 pool. The format directive is used as a sort of template to create new
3145 Volume names during automatic Volume labeling.
3147 The {\bf format} should be specified in double quotes, and consists of
3148 letters, numbers and the special characters hyphen ({\bf -}), underscore
3149 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3150 characters for a Volume name. The {\bf format} should be enclosed in
3153 In addition, the format may contain a number of variable expansion
3154 characters which will be expanded by a complex algorithm allowing you to
3155 create Volume names of many different formats. In all cases, the
3156 expansion process must resolve to the set of characters noted above that
3157 are legal Volume names. Generally, these variable expansion characters
3158 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
3159 specify variable expansion characters, you should always enclose the
3160 format with double quote characters ({\bf "}). For more details on
3161 variable expansion, please see the \ilink{Variable
3162 Expansion}{VarsChapter} Chapter of this manual.
3164 If no variable expansion characters are found in the string, the Volume
3165 name will be formed from the {\bf format} string appended with the
3166 a unique number that increases. If you do not remove volumes from the
3167 pool, this number should be the number of volumes plus one, but this
3168 is not guaranteed. The unique number will be edited as four
3169 digits with leading zeros. For example, with a {\bf Label Format =
3170 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3173 With the exception of Job specific variables, you can test your {\bf
3174 LabelFormat} by using the \ilink{var command}{var} the Console Chapter
3177 In almost all cases, you should enclose the format specification (part
3178 after the equal sign) in double quotes. Please note that this directive
3179 is deprecated and is replaced in version 1.37 and greater with a Python
3180 script for creating volume names.
3184 In order for a Pool to be used during a Backup Job, the Pool must have at
3185 least one Volume associated with it. Volumes are created for a Pool using
3186 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3187 program. In addition to adding Volumes to the Pool (i.e. putting the
3188 Volume names in the Catalog database), the physical Volume must be labeled
3189 with a valid Bacula software volume label before {\bf Bacula} will accept
3190 the Volume. This will be automatically done if you use the {\bf label}
3191 command. Bacula can automatically label Volumes if instructed to do so,
3192 but this feature is not yet fully implemented.
3194 The following is an example of a valid Pool resource definition:
3206 \subsection{The Scratch Pool}
3207 \label{TheScratchPool}
3208 \index[general]{Scratch Pool}
3209 In general, you can give your Pools any name you wish, but there is one
3210 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3211 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3212 writing and it cannot find one, it will look in the Scratch pool, and if
3213 it finds an available Volume, it will move it out of the Scratch pool into
3214 the Pool currently being used by the job.
3217 \section{The Catalog Resource}
3218 \label{CatalogResource}
3219 \index[general]{Resource!Catalog}
3220 \index[general]{Catalog Resource}
3222 The Catalog Resource defines what catalog to use for the current job.
3223 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3224 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3225 may be as many Catalogs (databases) defined as you wish. For example, you
3226 may want each Client to have its own Catalog database, or you may want
3227 backup jobs to use one database and verify or restore jobs to use another
3230 Since SQLite is compiled in, it always runs on the same machine
3231 as the Director and the database must be directly accessible (mounted) from
3232 the Director. However, since both MySQL and PostgreSQL are networked
3233 databases, they may reside either on the same machine as the Director
3234 or on a different machine on the network. See below for more details.
3239 \index[dir]{Catalog}
3240 \index[dir]{Directive!Catalog}
3241 Start of the Catalog resource. At least one Catalog resource must be
3245 \item [Name = \lt{}name\gt{}]
3247 \index[dir]{Directive!Name}
3248 The name of the Catalog. No necessary relation to the database server
3249 name. This name will be specified in the Client resource directive
3250 indicating that all catalog data for that Client is maintained in this
3251 Catalog. This directive is required.
3253 \item [password = \lt{}password\gt{}]
3254 \index[dir]{password}
3255 \index[dir]{Directive!password}
3256 This specifies the password to use when logging into the database. This
3257 directive is required.
3259 \item [DB Name = \lt{}name\gt{}]
3260 \index[dir]{DB Name}
3261 \index[dir]{Directive!DB Name}
3262 This specifies the name of the database. If you use multiple catalogs
3263 (databases), you specify which one here. If you are using an external
3264 database server rather than the internal one, you must specify a name
3265 that is known to the server (i.e. you explicitly created the Bacula
3266 tables using this name. This directive is required.
3268 \item [user = \lt{}user\gt{}]
3270 \index[dir]{Directive!user}
3271 This specifies what user name to use to log into the database. This
3272 directive is required.
3274 \item [DB Socket = \lt{}socket-name\gt{}]
3275 \index[dir]{DB Socket}
3276 \index[dir]{Directive!DB Socket}
3277 This is the name of a socket to use on the local host to connect to the
3278 database. This directive is used only by MySQL and is ignored by SQLite.
3279 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3280 will use the default socket. If the DB Socket is specified, the
3281 MySQL server must reside on the same machine as the Director.
3283 \item [DB Address = \lt{}address\gt{}]
3284 \index[dir]{DB Address}
3285 \index[dir]{Directive!DB Address}
3286 This is the host address of the database server. Normally, you would specify
3287 this instead of {\bf DB Socket} if the database server is on another machine.
3288 In that case, you will also specify {\bf DB Port}. This directive is used
3289 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3290 This directive is optional.
3292 \item [DB Port = \lt{}port\gt{}]
3293 \index[dir]{DB Port}
3294 \index[dir]{Directive!DB Port}
3295 This defines the port to be used in conjunction with {\bf DB Address} to
3296 access the database if it is on another machine. This directive is used only
3297 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3298 directive is optional.
3300 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3301 %% \index[dir]{Multiple Connections}
3302 %% \index[dir]{Directive!Multiple Connections}
3303 %% By default, this directive is set to no. In that case, each job that uses
3305 %% same Catalog will use a single connection to the catalog. It will be shared,
3306 %% and Bacula will allow only one Job at a time to communicate. If you set this
3307 %% directive to yes, Bacula will permit multiple connections to the database,
3308 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3309 %% this is no problem. For MySQL, you must be *very* careful to have the
3310 %% multi-thread version of the client library loaded on your system. When this
3311 %% directive is set yes, each Job will have a separate connection to the
3312 %% database, and the database will control the interaction between the
3314 %% Jobs. This can significantly speed up the database operations if you are
3315 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3316 %% Bacula will automatically enable transactions. This can significantly speed
3317 %% up insertion of attributes in the database either for a single Job or
3318 %% multiple simultaneous Jobs.
3320 %% This directive has not been tested. Please test carefully before running it
3321 %% in production and report back your results.
3325 The following is an example of a valid Catalog resource definition:
3334 password = "" # no password = no security
3339 or for a Catalog on another machine:
3349 DB Address = remote.acme.com
3355 \section{The Messages Resource}
3356 \label{MessagesResource2}
3357 \index[general]{Resource!Messages}
3358 \index[general]{Messages Resource}
3360 For the details of the Messages Resource, please see the
3361 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3364 \section{The Console Resource}
3365 \label{ConsoleResource1}
3366 \index[general]{Console Resource}
3367 \index[general]{Resource!Console}
3369 As of Bacula version 1.33 and higher, there are three different kinds of
3370 consoles, which the administrator or user can use to interact with the
3371 Director. These three kinds of consoles comprise three different security
3375 \item The first console type is an {\bf anonymous} or {\bf default} console,
3376 which has full privileges. There is no console resource necessary for
3377 this type since the password is specified in the Director's resource and
3378 consequently such consoles do not have a name as defined on a {\bf Name
3379 =} directive. This is the kind of console that was initially
3380 implemented in versions prior to 1.33 and remains valid. Typically you
3381 would use it only for administrators.
3383 \item The second type of console, and new to version 1.33 and higher is a
3384 "named" console defined within a Console resource in both the Director's
3385 configuration file and in the Console's configuration file. Both the
3386 names and the passwords in these two entries must match much as is the
3387 case for Client programs.
3389 This second type of console begins with absolutely no privileges except
3390 those explicitly specified in the Director's Console resource. Thus you
3391 can have multiple Consoles with different names and passwords, sort of
3392 like multiple users, each with different privileges. As a default,
3393 these consoles can do absolutely nothing -- no commands whatsoever. You
3394 give them privileges or rather access to commands and resources by
3395 specifying access control lists in the Director's Console resource. The
3396 ACLs are specified by a directive followed by a list of access names.
3397 Examples of this are shown below.
3399 \item The third type of console is similar to the above mentioned one in that
3400 it requires a Console resource definition in both the Director and the
3401 Console. In addition, if the console name, provided on the {\bf Name =}
3402 directive, is the same as a Client name, that console is permitted to
3403 use the {\bf SetIP} command to change the Address directive in the
3404 Director's client resource to the IP address of the Console. This
3405 permits portables or other machines using DHCP (non-fixed IP addresses)
3406 to "notify" the Director of their current IP address.
3409 The Console resource is optional and need not be specified. The following
3410 directives are permitted within the Director's configuration resource:
3414 \item [Name = \lt{}name\gt{}]
3416 \index[dir]{Directive!Name}
3417 The name of the console. This name must match the name specified in the
3418 Console's configuration resource (much as is the case with Client
3421 \item [Password = \lt{}password\gt{}]
3422 \index[dir]{Password}
3423 \index[dir]{Directive!Password}
3424 Specifies the password that must be supplied for a named Bacula Console
3425 to be authorized. The same password must appear in the {\bf Console}
3426 resource of the Console configuration file. For added security, the
3427 password is never actually passed across the network but rather a
3428 challenge response hash code created with the password. This directive
3429 is required. If you have either {\bf /dev/random} {\bf bc} on your
3430 machine, Bacula will generate a random password during the configuration
3431 process, otherwise it will be left blank.
3433 The password is plain text. It is not generated through any special
3434 process. However, it is preferable for security reasons to choose
3437 \item [JobACL = \lt{}name-list\gt{}]
3439 \index[dir]{Directive!JobACL}
3440 This directive is used to specify a list of Job resource names that can
3441 be accessed by the console. Without this directive, the console cannot
3442 access any of the Director's Job resources. Multiple Job resource names
3443 may be specified by separating them with commas, and/or by specifying
3444 multiple JobACL directives. For example, the directive may be specified
3449 JobACL = kernsave, "Backup client 1", "Backup client 2"
3450 JobACL = "RestoreFiles"
3455 With the above specification, the console can access the Director's resources
3456 for the four jobs named on the JobACL directives, but for no others.
3458 \item [ClientACL = \lt{}name-list\gt{}]
3459 \index[dir]{ClientACL}
3460 \index[dir]{Directive!ClientACL}
3461 This directive is used to specify a list of Client resource names that can
3463 accessed by the console.
3465 \item [StorageACL = \lt{}name-list\gt{}]
3466 \index[dir]{StorageACL}
3467 \index[dir]{Directive!StorageACL}
3468 This directive is used to specify a list of Storage resource names that can
3469 be accessed by the console.
3471 \item [ScheduleACL = \lt{}name-list\gt{}]
3472 \index[dir]{ScheduleACL}
3473 \index[dir]{Directive!ScheduleACL}
3474 This directive is used to specify a list of Schedule resource names that can
3475 be accessed by the console.
3477 \item [PoolACL = \lt{}name-list\gt{}]
3478 \index[dir]{PoolACL}
3479 \index[dir]{Directive!PoolACL}
3480 This directive is used to specify a list of Pool resource names that can be
3481 accessed by the console.
3483 \item [FileSetACL = \lt{}name-list\gt{}]
3484 \index[dir]{FileSetACL}
3485 \index[dir]{Directive!FileSetACL}
3486 This directive is used to specify a list of FileSet resource names that
3487 can be accessed by the console.
3489 \item [CatalogACL = \lt{}name-list\gt{}]
3490 \index[dir]{CatalogACL}
3491 \index[dir]{Directive!CatalogACL}
3492 This directive is used to specify a list of Catalog resource names that
3493 can be accessed by the console.
3495 \item [CommandACL = \lt{}name-list\gt{}]
3496 \index[dir]{CommandACL}
3497 \index[dir]{Directive!CommandACL}
3498 This directive is used to specify a list of of console commands that can
3499 be executed by the console.
3501 \item [WhereACL = \lt{}string\gt{}]
3502 \index[dir]{WhereACL}
3503 \index[dir]{Directive!WhereACL}
3504 This directive permits you to specify where a restricted console
3505 can restore files. If this directive is not specified, only the
3506 default restore location is permitted (normally {\bf
3507 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3508 user enters will be accepted (not very secure), any other
3509 value specified (there may be multiple WhereACL directives) will
3510 restrict the user to use that path. For example, on a Unix system,
3511 if you specify "/", the file will be restored to the original
3512 location. This directive is untested.
3516 Aside from Director resource names and console command names, the special
3517 keyword {\bf *all*} can be specified in any of the above access control lists.
3518 When this keyword is present, any resource or command name (which ever is
3519 appropriate) will be accepted. For an example configuration file, please see
3521 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3524 \section{The Counter Resource}
3525 \label{CounterResource}
3526 \index[general]{Resource!Counter}
3527 \index[general]{Counter Resource}
3529 The Counter Resource defines a counter variable that can be accessed by
3530 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3532 \ilink{LabelFormat}{Label} directive in this chapter for more
3538 \index[dir]{Counter}
3539 \index[dir]{Directive!Counter}
3540 Start of the Counter resource. Counter directives are optional.
3542 \item [Name = \lt{}name\gt{}]
3544 \index[dir]{Directive!Name}
3545 The name of the Counter. This is the name you will use in the variable
3546 expansion to reference the counter value.
3548 \item [Minimum = \lt{}integer\gt{}]
3549 \index[dir]{Minimum}
3550 \index[dir]{Directive!Minimum}
3551 This specifies the minimum value that the counter can have. It also becomes
3552 the default. If not supplied, zero is assumed.
3554 \item [Maximum = \lt{}integer\gt{}]
3555 \index[dir]{Maximum}
3556 \index[dir]{Directive!Maximum}
3557 \index[dir]{Directive!Maximum}
3558 This is the maximum value value that the counter can have. If not specified
3559 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3560 the 31 power). When the counter is incremented past this value, it is reset
3563 \item [*WrapCounter = \lt{}counter-name\gt{}]
3564 \index[dir]{*WrapCounter}
3565 \index[dir]{Directive!*WrapCounter}
3566 If this value is specified, when the counter is incremented past the
3568 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3569 is incremented. (This is not currently implemented).
3571 \item [Catalog = \lt{}catalog-name\gt{}]
3572 \index[dir]{Catalog}
3573 \index[dir]{Directive!Catalog}
3574 If this directive is specified, the counter and its values will be saved in
3575 the specified catalog. If this directive is not present, the counter will be
3576 redefined each time that Bacula is started.
3579 \section{Example Director Configuration File}
3580 \label{SampleDirectorConfiguration}
3581 \index[general]{File!Example Director Configuration}
3582 \index[general]{Example Director Configuration File}
3584 An example Director configuration file might be the following:
3589 # Default Bacula Director Configuration file
3591 # The only thing that MUST be changed is to add one or more
3592 # file or directory names in the Include directive of the
3595 # For Bacula release 1.15 (5 March 2002) -- redhat
3597 # You might also want to change the default email address
3598 # from root to your address. See the "mail" and "operator"
3599 # directives in the Messages resource.
3601 Director { # define myself
3603 QueryFile = "/home/kern/bacula/bin/query.sql"
3604 WorkingDirectory = "/home/kern/bacula/bin/working"
3605 PidDirectory = "/home/kern/bacula/bin/working"
3606 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3608 # Define the backup Job
3610 Name = "NightlySave"
3612 Level = Incremental # default
3615 Schedule = "WeeklyCycle"
3625 Where = /tmp/bacula-restores
3631 # List of files to be backed up
3635 Options { signature=SHA1}
3637 # Put your list of files here, one per line or include an
3638 # external list with:
3642 # Note: / backs up everything
3647 # When to do the backups
3649 Name = "WeeklyCycle"
3650 Run = level=Full sun at 2:05
3651 Run = level=Incremental mon-sat at 2:05
3653 # Client (File Services) to backup
3658 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3659 File Retention = 60d # sixty day file retention
3660 Job Retention = 1y # 1 year Job retention
3661 AutoPrune = yes # Auto apply retention periods
3663 # Definition of DLT tape storage device
3667 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3668 Device = "HP DLT 80" # same as Device in Storage daemon
3669 Media Type = DLT8000 # same as MediaType in Storage daemon
3671 # Definition for a DLT autochanger device
3675 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3676 Device = "Autochanger" # same as Device in Storage daemon
3677 Media Type = DLT-8000 # Different from DLTDrive
3680 # Definition of DDS tape storage device
3684 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3685 Device = SDT-10000 # same as Device in Storage daemon
3686 Media Type = DDS-4 # same as MediaType in Storage daemon
3688 # Definition of 8mm tape storage device
3692 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3693 Device = "Exabyte 8mm"
3696 # Definition of file storage device
3700 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3701 Device = FileStorage
3704 # Generic catalog service
3707 dbname = bacula; user = bacula; password = ""
3709 # Reasonable message delivery -- send most everything to
3710 # the email address and to the console
3713 mail = root@localhost = all, !skipped, !terminate
3714 operator = root@localhost = mount
3715 console = all, !skipped, !saved
3718 # Default pool definition
3726 # Restricted console used by tray-monitor to get the status of the director
3730 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3731 CommandACL = status, .status