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}{DirectorResource} -- 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}{StorageResource} -- 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, \ldots{}).
86 \label{DirectorResource}
87 \section{The Director Resource}
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 \label{Director:Name}
104 \item [Name = \lt{}name\gt{}]
106 \index[dir]{Directive!Name}
107 The director name used by the system administrator. This directive is
110 \label{Director:Description}
111 \item [Description = \lt{}text\gt{}]
112 \index[dir]{Description}
113 \index[dir]{Directive!Description}
114 The text field contains a description of the Director that will be displayed
115 in the graphical user interface. This directive is optional.
117 \label{Director:Password}
118 \item [Password = \lt{}UA-password\gt{}]
119 \index[dir]{Password}
120 \index[dir]{Directive!Password}
121 Specifies the password that must be supplied for the default Bacula
122 Console to be authorized. The same password must appear in the {\bf
123 Director} resource of the Console configuration file. For added
124 security, the password is never passed across the network but instead a
125 challenge response hash code created with the password. This directive
126 is required. If you have either {\bf /dev/random} or {\bf bc} on your
127 machine, Bacula will generate a random password during the configuration
128 process, otherwise it will be left blank and you must manually supply
131 The password is plain text. It is not generated through any special
132 process but as noted above, it is better to use random text for
135 \label{Director:Messages}
136 \item [Messages = \lt{}Messages-resource-name\gt{}]
137 \index[dir]{Directive!Messages}
138 The messages resource specifies where to deliver Director messages that are
139 not associated with a specific Job. Most messages are specific to a job and
140 will be directed to the Messages resource specified by the job. However,
141 there are a few messages that can occur when no job is running. This
142 directive is required.
144 \label{Director:WorkingDirectory}
145 \item [Working Directory = \lt{}Directory\gt{}]
146 \index[dir]{Working Directory}
147 \index[dir]{Directive!Working Directory}
148 This directive is mandatory and specifies a directory in which the Director
149 may put its status files. This directory should be used only by Bacula but
150 may be shared by other Bacula daemons. However, please note, if this
151 directory is shared with other Bacula daemons (the File daemon and Storage
152 daemon), you must ensure that the {\bf Name} given to each daemon is
153 unique so that the temporary filenames used do not collide. By default
154 the Bacula configure process creates unique daemon names by postfixing them
155 with -dir, -fd, and -sd. Standard shell expansion of the {\bf
156 Directory} is done when the configuration file is read so that values such
157 as {\bf \$HOME} will be properly expanded. This directive is required.
158 The working directory specified must already exist and be
159 readable and writable by the Bacula daemon referencing it.
161 If you have specified a Director user and/or a Director group on your
162 ./configure line with {\bf {-}{-}with-dir-user} and/or
163 {\bf {-}{-}with-dir-group} the Working Directory owner and group will
164 be set to those values.
166 \label{Director:PidDirectory}
167 \item [Pid Directory = \lt{}Directory\gt{}]
168 \index[dir]{Pid Directory}
169 \index[dir]{Directive!Pid Directory}
170 This directive is mandatory and specifies a directory in which the Director
171 may put its process Id file. The process Id file is used to shutdown
172 Bacula and to prevent multiple copies of Bacula from running simultaneously.
173 Standard shell expansion of the {\bf Directory} is done when the
174 configuration file is read so that values such as {\bf \$HOME} will be
177 The PID directory specified must already exist and be
178 readable and writable by the Bacula daemon referencing it
180 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
181 not installing Bacula in the system directories, you can use the {\bf Working
182 Directory} as defined above. This directive is required.
184 \label{Director:ScriptsDirectory}
185 \item [Scripts Directory = \lt{}Directory\gt{}]
186 \index[dir]{Scripts Directory}
187 \index[dir]{Directive!Scripts Directory}
188 This directive is optional and, if defined, specifies a directory in
189 which the Director will look for the Python startup script {\bf
190 DirStartup.py}. This directory may be shared by other Bacula daemons.
191 Standard shell expansion of the directory is done when the configuration
192 file is read so that values such as {\bf \$HOME} will be properly
195 \label{Director:QueryFile}
196 \item [QueryFile = \lt{}Path\gt{}]
197 \index[dir]{QueryFile}
198 \index[dir]{Directive!QueryFile}
199 This directive is mandatory and specifies a directory and file in which
200 the Director can find the canned SQL statements for the {\bf Query}
201 command of the Console. Standard shell expansion of the {\bf Path} is
202 done when the configuration file is read so that values such as {\bf
203 \$HOME} will be properly expanded. This directive is required.
205 \label{Director:HeartbeatInterval}
206 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
207 \index[dir]{Heartbeat Interval}
208 \index[dir]{Directive!Heartbeat}
209 This directive is optional and if specified will cause the Director to
210 set a keepalive interval (heartbeat) in seconds on each of the sockets
211 it opens for the Client resource. This value will override any
212 specified at the Director level. It is implemented only on systems
213 (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
214 The default value is zero, which means no change is made to the socket.
216 \label{DirMaxConJobs}
218 \label{Director:MaximumConcurrentJobs}
219 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
220 \index[dir]{Maximum Concurrent Jobs}
221 \index[dir]{Directive!Maximum Concurrent Jobs}
222 \index[general]{Simultaneous Jobs}
223 \index[general]{Concurrent Jobs}
224 where \lt{}number\gt{} is the maximum number of total Director Jobs that
225 should run concurrently. The default is set to 1, but you may set it to a
228 The Volume format becomes more complicated with
229 multiple simultaneous jobs, consequently, restores may take longer if
230 Bacula must sort through interleaved volume blocks from multiple simultaneous
231 jobs. This can be avoided by having each simultaneous job write to
232 a different volume or by using data spooling, which will first spool the data
233 to disk simultaneously, then write one spool file at a time to the volume
234 thus avoiding excessive interleaving of the different job blocks.
236 \label{Director:FdConnectTimeout}
237 \item [FD Connect Timeout = \lt{}time\gt{}]
238 \index[dir]{FD Connect Timeout}
239 \index[dir]{Directive!FD Connect Timeout}
240 where {\bf time} is the time that the Director should continue
241 attempting to contact the File daemon to start a job, and after which
242 the Director will cancel the job. The default is 30 minutes.
244 \label{Director:SdConnectTimeout}
245 \item [SD Connect Timeout = \lt{}time\gt{}]
246 \index[dir]{SD Connect Timeout}
247 \index[dir]{Directive!SD Connect Timeout}
248 where {\bf time} is the time that the Director should continue
249 attempting to contact the Storage daemon to start a job, and after which
250 the Director will cancel the job. The default is 30 minutes.
252 \label{Director:DirAddresses}
253 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
254 \index[dir]{DirAddresses}
256 \index[general]{Address}
257 \index[dir]{Directive!DirAddresses}
258 Specify the ports and addresses on which the Director daemon will listen
259 for Bacula Console connections. Probably the simplest way to explain
260 this is to show an example:
265 ip = { addr = 1.2.3.4; port = 1205;}
267 addr = 1.2.3.4; port = http;}
276 ip = { addr = 1.2.3.4 }
277 ip = { addr = 201:220:222::2 }
279 addr = bluedot.thun.net
285 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
286 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
287 a symbolic name (only in the ip specification). Also, port can be specified
288 as a number or as the mnemonic value from the /etc/services file. If a port
289 is not specified, the default will be used. If an ip section is specified,
290 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
291 only IPv4 resolutions will be permitted, and likewise with ip6.
293 Please note that if you use the DirAddresses directive, you must
294 not use either a DirPort or a DirAddress directive in the same
297 \label{Director:DirPort}
298 \item [DirPort = \lt{}port-number\gt{}]
300 \index[dir]{Directive!DirPort}
301 Specify the port (a positive integer) on which the Director daemon will
302 listen for Bacula Console connections. This same port number must be
303 specified in the Director resource of the Console configuration file. The
304 default is 9101, so normally this directive need not be specified. This
305 directive should not be used if you specify DirAddresses (N.B plural)
308 \label{Director:DirAddress}
309 \item [DirAddress = \lt{}IP-Address\gt{}]
310 \index[dir]{DirAddress}
311 \index[dir]{Directive!DirAddress}
312 This directive is optional, but if it is specified, it will cause the
313 Director server (for the Console program) to bind to the specified {\bf
314 IP-Address}, which is either a domain name or an IP address specified as a
315 dotted quadruple in string or quoted string format. If this directive is
316 not specified, the Director will bind to any available address (the
317 default). Note, unlike the DirAddresses specification noted above, this
318 directive only permits a single address to be specified. This directive
319 should not be used if you specify a DirAddresses (N.B. plural) directive.
321 \label{Director:DirSourceAddress}
322 \item [DirSourceAddress = \lt{}IP-Address\gt{}]
323 \index[fd]{DirSourceAddress}
324 \index[fd]{Directive!DirSourceAddress}
325 This record is optional, and if it is specified, it will cause the Director
326 server (when initiating connections to a storage or file daemon) to source
327 its connections from the specified address. Only a single IP address may be
328 specified. If this record is not specified, the Director server will source
329 its outgoing connections according to the system routing table (the default).
332 \label{Director:StatisticsRetention}
333 \item[Statistics Retention = \lt{}time\gt{}]
334 \index[dir]{StatisticsRetention}
335 \label{PruneStatistics}
336 \index[dir]{Directive!StatisticsRetention}
338 The \texttt{Statistics Retention} directive defines the length of time that
339 Bacula will keep statistics job records in the Catalog database after the
340 Job End time. (In \texttt{JobHistory} table) When this time period expires,
341 and if user runs \texttt{prune stats} command, Bacula will prune (remove)
342 Job records that are older than the specified period.
344 Theses statistics records aren't use for restore purpose, but mainly for
345 capacity planning, billings, etc. See \ilink{Statistics chapter}{UseBaculaCatalogToExtractInformationChapter} for
346 additional information.
348 See the \ilink{ Configuration chapter}{Time} of this manual for additional
349 details of time specification.
351 The default is 5 years.
353 \label{Director:VerId}
354 \item[VerId = \lt{}string\gt{}]
355 \index[dir]{Directive!VerId}
356 where \lt{}string\gt{} is an identifier which can be used for support purpose.
357 This string is displayed using the \texttt{version} command.
359 \label{Director:MaximumConsoleConnections}
360 \item[MaximumConsoleConnections = \lt{}number\gt{}]
361 \index[dir]{MaximumConsoleConnections}
362 \index[dir]{Directive!MaximumConsoleConnections}
364 where \lt{}number\gt{} is the maximum number of Console Connections that
365 could run concurrently. The default is set to 20, but you may set it to a
368 \label{Director:MaximumReloadRequests}
369 \item[MaximumReloadRequests = \lt{}number\gt{}]
370 \index[dir]{MaximumReloadRequests}
371 \index[dir]{Directive!MaximumReloadRequests}
374 Where \lt{}number\gt{} is the maximum number of \texttt{reload} command that
375 can be done while jobs are running. The default is set to 32 and is usually
378 % \label{Director:SharedStorage}
379 %\item[SharedStorage = \lt{}yes\vb{}no\gt{}]
380 % \index[dir]{SharedStorage}
381 % \index[dir]{Directive!SharedStorage}
383 % The \texttt{Shared Storage} directive is a Bacula Enterprise feature that
384 % allows you to share volumes between different Storage resources. This
385 % directive should be used \textbf{only} if all \texttt{Media Type} are
386 % correctly set across all Devices.
388 % The \texttt{Shared Storage} directive should be used when using the SAN
389 % Shared Storage plugin or when accessing from the Director Storage resources
390 % directly to Devices of an Autochanger.
392 % When sharing volumes between different Storage resources, you will
393 % need also to use the \texttt{reset-storageid} script before using the
394 % \texttt{update slots} command. This script can be scheduled once a day in
398 % $ /opt/bacula/scripts/reset-storageid MediaType StorageName
400 % * update slots storage=StorageName drive=0
403 % Please contact Bacula Systems support to get help on this advanced
408 The following is an example of a valid Director resource definition:
414 WorkingDirectory = "$HOME/bacula/bin/working"
415 Password = UA_password
416 PidDirectory = "$HOME/bacula/bin/working"
417 QueryFile = "$HOME/bacula/bin/query.sql"
420 \end{lstlisting} %% $
424 \section{The Job Resource}
425 \index[general]{Resource!Job}
426 \index[general]{Job Resource}
428 The Job resource defines a Job (Backup, Restore, \ldots{}) that Bacula must
429 perform. Each Job resource definition contains the name of a Client and
430 a FileSet to backup, the Schedule for the Job, where the data
431 are to be stored, and what media Pool can be used. In effect, each Job
432 resource must specify What, Where, How, and When or FileSet, Storage,
433 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
434 be specified for a restore job for historical reasons, but it is no longer used.
436 Only a single type ({\bf Backup}, {\bf Restore}, \ldots{}) can be specified for any
437 job. If you want to backup multiple FileSets on the same Client or multiple
438 Clients, you must define a Job for each one.
440 Note, you define only a single Job to do the Full, Differential, and
441 Incremental backups since the different backup levels are tied together by
442 a unique Job name. Normally, you will have only one Job per Client, but
443 if a client has a really huge number of files (more than several million),
444 you might want to split it into to Jobs each with a different FileSet
445 covering only part of the total files.
447 Multiple Storage daemons are not currently supported for Jobs, so if
448 you do want to use multiple storage daemons, you will need to create
449 a different Job and ensure that for each Job that the combination of
450 Client and FileSet are unique. The Client and FileSet are what Bacula
451 uses to restore a client, so if there are multiple Jobs with the same
452 Client and FileSet or multiple Storage daemons that are used, the
453 restore will not work. This problem can be resolved by defining multiple
454 FileSet definitions (the names must be different, but the contents of
455 the FileSets may be the same).
462 \index[dir]{Directive!Job}
463 Start of the Job resource. At least one Job resource is required.
466 \item [Name = \lt{}name\gt{}]
468 \index[dir]{Directive!Name}
469 The Job name. This name can be specified on the {\bf Run} command in the
470 console program to start a job. If the name contains spaces, it must be
471 specified between quotes. It is generally a good idea to give your job the
472 same name as the Client that it will backup. This permits easy
473 identification of jobs.
475 When the job actually runs, the unique Job Name will consist of the name you
476 specify here followed by the date and time the job was scheduled for
477 execution. This directive is required.
480 \item [Enabled = \lt{}yes\vb{}no\gt{}]
482 \index[dir]{Directive!Enable}
483 This directive allows you to enable or disable automatic execution
484 via the scheduler of a Job.
487 \item [Type = \lt{}job-type\gt{}]
489 \index[dir]{Directive!Type}
490 The {\bf Type} directive specifies the Job type, which may be one of the
491 following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
492 directive is required. Within a particular Job Type, there are also Levels
493 as discussed in the next item.
499 Run a backup Job. Normally you will have at least one Backup job for each
500 client you want to save. Normally, unless you turn off cataloging, most all
501 the important statistics and data concerning files backed up will be placed
506 Run a restore Job. Normally, you will specify only one Restore job
507 which acts as a sort of prototype that you will modify using the console
508 program in order to perform restores. Although certain basic
509 information from a Restore job is saved in the catalog, it is very
510 minimal compared to the information stored for a Backup job -- for
511 example, no File database entries are generated since no Files are
514 {\bf Restore} jobs cannot be
515 automatically started by the scheduler as is the case for Backup, Verify
516 and Admin jobs. To restore files, you must use the {\bf restore} command
522 Run a verify Job. In general, {\bf verify} jobs permit you to compare the
523 contents of the catalog to the file system, or to what was backed up. In
524 addition, to verifying that a tape that was written can be read, you can
525 also use {\bf verify} as a sort of tripwire intrusion detection.
529 Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
530 pruning, if you do not want to do it at the end of each {\bf Backup} Job.
531 Although an Admin job is recorded in the catalog, very little data is saved.
537 \item [Level = \lt{}job-level\gt{}]
539 \index[dir]{Directive!Level}
540 The Level directive specifies the default Job level to be run. Each
541 different Job Type (Backup, Restore, \ldots{}) has a different set of Levels
542 that can be specified. The Level is normally overridden by a different
543 value that is specified in the {\bf Schedule} resource. This directive
544 is not required, but must be specified either by a {\bf Level} directive
545 or as an override specified in the {\bf Schedule} resource.
547 For a {\bf Backup} Job, the Level may be one of the following:
553 When the Level is set to Full all files in the FileSet whether or not
554 they have changed will be backed up.
557 \index[dir]{Incremental}
558 When the Level is set to Incremental all files specified in the FileSet
559 that have changed since the last successful backup of the the same Job
560 using the same FileSet and Client, will be backed up. If the Director
561 cannot find a previous valid Full backup then the job will be upgraded
562 into a Full backup. When the Director looks for a valid backup record
563 in the catalog database, it looks for a previous Job with:
566 \item The same Job name.
567 \item The same Client name.
568 \item The same FileSet (any change to the definition of the FileSet such as
569 adding or deleting a file in the Include or Exclude sections constitutes a
571 \item The Job was a Full, Differential, or Incremental backup.
572 \item The Job terminated normally (i.e. did not fail or was not canceled).
573 \item The Job started no longer ago than {\bf Max Full Interval}.
576 If all the above conditions do not hold, the Director will upgrade the
577 Incremental to a Full save. Otherwise, the Incremental backup will be
578 performed as requested.
580 The File daemon (Client) decides which files to backup for an
581 Incremental backup by comparing start time of the prior Job (Full,
582 Differential, or Incremental) against the time each file was last
583 ``modified'' (st\_mtime) and the time its attributes were last
584 ``changed''(st\_ctime). If the file was modified or its attributes
585 changed on or after this start time, it will then be backed up.
587 Some virus scanning software may change st\_ctime while
588 doing the scan. For example, if the virus scanning program attempts to
589 reset the access time (st\_atime), which Bacula does not use, it will
590 cause st\_ctime to change and hence Bacula will backup the file during
591 an Incremental or Differential backup. In the case of Sophos virus
592 scanning, you can prevent it from resetting the access time (st\_atime)
593 and hence changing st\_ctime by using the {\bf \lstinline:--:no-reset-atime}
594 option. For other software, please see their manual.
596 When Bacula does an Incremental backup, all modified files that are
597 still on the system are backed up. However, any file that has been
598 deleted since the last Full backup remains in the Bacula catalog,
599 which means that if between a Full save and the time you do a
600 restore, some files are deleted, those deleted files will also be
601 restored. The deleted files will no longer appear in the catalog
602 after doing another Full save.
604 In addition, if you move a directory rather than copy it, the files in
605 it do not have their modification time (st\_mtime) or their attribute
606 change time (st\_ctime) changed. As a consequence, those files will
607 probably not be backed up by an Incremental or Differential backup which
608 depend solely on these time stamps. If you move a directory, and wish
609 it to be properly backed up, it is generally preferable to copy it, then
612 However, to manage deleted files or directories changes in the
613 catalog during an Incremental backup you can use \texttt{accurate}
614 mode. This is quite memory consuming process. See \ilink{Accurate
615 mode}{accuratemode} for more details.
618 \index[dir]{Differential}
619 When the Level is set to Differential
620 all files specified in the FileSet that have changed since the last
621 successful Full backup of the same Job will be backed up.
622 If the Director cannot find a
623 valid previous Full backup for the same Job, FileSet, and Client,
624 backup, then the Differential job will be upgraded into a Full backup.
625 When the Director looks for a valid Full backup record in the catalog
626 database, it looks for a previous Job with:
629 \item The same Job name.
630 \item The same Client name.
631 \item The same FileSet (any change to the definition of the FileSet such as
632 adding or deleting a file in the Include or Exclude sections constitutes a
634 \item The Job was a FULL backup.
635 \item The Job terminated normally (i.e. did not fail or was not canceled).
636 \item The Job started no longer ago than {\bf Max Full Interval}.
639 If all the above conditions do not hold, the Director will upgrade the
640 Differential to a Full save. Otherwise, the Differential backup will be
641 performed as requested.
643 The File daemon (Client) decides which files to backup for a
644 differential backup by comparing the start time of the prior Full backup
645 Job against the time each file was last ``modified'' (st\_mtime) and the
646 time its attributes were last ``changed'' (st\_ctime). If the file was
647 modified or its attributes were changed on or after this start time, it
648 will then be backed up. The start time used is displayed after the {\bf
649 Since} on the Job report. In rare cases, using the start time of the
650 prior backup may cause some files to be backed up twice, but it ensures
651 that no change is missed. As with the Incremental option, you should
652 ensure that the clocks on your server and client are synchronized or as
653 close as possible to avoid the possibility of a file being skipped.
654 Note, on versions 1.33 or greater Bacula automatically makes the
655 necessary adjustments to the time between the server and the client so
656 that the times Bacula uses are synchronized.
658 When Bacula does a Differential backup, all modified files that are
659 still on the system are backed up. However, any file that has been
660 deleted since the last Full backup remains in the Bacula catalog, which
661 means that if between a Full save and the time you do a restore, some
662 files are deleted, those deleted files will also be restored. The
663 deleted files will no longer appear in the catalog after doing another
664 Full save. However, to remove deleted files from the catalog during a
665 Differential backup is quite a time consuming process and not currently
666 implemented in Bacula. It is, however, a planned future feature.
668 As noted above, if you move a directory rather than copy it, the
669 files in it do not have their modification time (st\_mtime) or
670 their attribute change time (st\_ctime) changed. As a
671 consequence, those files will probably not be backed up by an
672 Incremental or Differential backup which depend solely on these
673 time stamps. If you move a directory, and wish it to be
674 properly backed up, it is generally preferable to copy it, then
675 delete the original. Alternatively, you can move the directory, then
676 use the {\bf touch} program to update the timestamps.
678 %% TODO: merge this with incremental
679 However, to manage deleted files or directories changes in the
680 catalog during an Differential backup you can use \texttt{accurate}
681 mode. This is quite memory consuming process. See \ilink{Accurate
682 mode}{accuratemode} for more details.
684 Every once and a while, someone asks why we need Differential
685 backups as long as Incremental backups pickup all changed files.
686 There are possibly many answers to this question, but the one
687 that is the most important for me is that a Differential backup
689 all the Incremental and Differential backups since the last Full backup
690 into a single Differential backup. This has two effects: 1. It gives
691 some redundancy since the old backups could be used if the merged backup
692 cannot be read. 2. More importantly, it reduces the number of Volumes
693 that are needed to do a restore effectively eliminating the need to read
694 all the volumes on which the preceding Incremental and Differential
695 backups since the last Full are done.
699 For a {\bf Restore} Job, no level needs to be specified.
701 For a {\bf Verify} Job, the Level may be one of the following:
706 \index[dir]{InitCatalog}
707 does a scan of the specified {\bf FileSet} and stores the file
708 attributes in the Catalog database. Since no file data is saved, you
709 might ask why you would want to do this. It turns out to be a very
710 simple and easy way to have a {\bf Tripwire} like feature using {\bf
711 Bacula}. In other words, it allows you to save the state of a set of
712 files defined by the {\bf FileSet} and later check to see if those files
713 have been modified or deleted and if any new files have been added.
714 This can be used to detect system intrusion. Typically you would
715 specify a {\bf FileSet} that contains the set of system files that
716 should not change (e.g. /sbin, /boot, /lib, /bin, \ldots{}). Normally, you
717 run the {\bf InitCatalog} level verify one time when your system is
718 first setup, and then once again after each modification (upgrade) to
719 your system. Thereafter, when your want to check the state of your
720 system files, you use a {\bf Verify} {\bf level = Catalog}. This
721 compares the results of your {\bf InitCatalog} with the current state of
726 Compares the current state of the files against the state previously
727 saved during an {\bf InitCatalog}. Any discrepancies are reported. The
728 items reported are determined by the {\bf verify} options specified on
729 the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
730 FileSet} resource below for more details). Typically this command will
731 be run once a day (or night) to check for any changes to your system
734 Please note! If you run two Verify Catalog jobs on the same client at
735 the same time, the results will certainly be incorrect. This is because
736 Verify Catalog modifies the Catalog database while running in order to
739 \item [VolumeToCatalog]
740 \index[dir]{VolumeToCatalog}
741 This level causes Bacula to read the file attribute data written to the
742 Volume from the last backup Job for the job specified on the {\bf VerifyJob}
743 directive. The file attribute data are compared to the
744 values saved in the Catalog database and any differences are reported.
745 This is similar to the {\bf DiskToCatalog} level except that instead of
746 comparing the disk file attributes to the catalog database, the
747 attribute data written to the Volume is read and compared to the catalog
748 database. Although the attribute data including the signatures (MD5 or
749 SHA1) are compared, the actual file data is not compared (it is not in
752 Please note! If you run two Verify VolumeToCatalog jobs on the same
753 client at the same time, the results will certainly be incorrect. This
754 is because the Verify VolumeToCatalog modifies the Catalog database
757 \item [DiskToCatalog]
758 \index[dir]{DiskToCatalog}
759 This level causes Bacula to read the files as they currently are on
760 disk, and to compare the current file attributes with the attributes
761 saved in the catalog from the last backup for the job specified on the
762 {\bf VerifyJob} directive. This level differs from the {\bf VolumeToCatalog}
763 level described above by the fact that it doesn't compare against a
764 previous Verify job but against a previous backup. When you run this
765 level, you must supply the verify options on your Include statements.
766 Those options determine what attribute fields are compared.
768 This command can be very useful if you have disk problems because it
769 will compare the current state of your disk against the last successful
770 backup, which may be several jobs.
772 Note, the current implementation (1.32c) does not identify files that
777 \item [Accurate = \lt{}yes\vb{}no\gt{}]
778 \index[dir]{Accurate}
779 In accurate mode, the File daemon knowns exactly which files were present
780 after the last backup. So it is able to handle deleted or renamed files.
782 When restoring a FileSet for a specified date (including ``most
783 recent''), Bacula is able to restore exactly the files and
784 directories that existed at the time of the last backup prior to
785 that date including ensuring that deleted files are actually deleted,
786 and renamed directories are restored properly.
788 In this mode, the File daemon must keep data concerning all files in
789 memory. So If you do not have sufficient memory, the backup may
790 either be terribly slow or fail.
792 %% $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
794 For 500.000 files (a typical desktop linux system), it will require
795 approximately 64 Megabytes of RAM on your File daemon to hold the
796 required information.
798 \label{Job:VerifyJob}
799 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
800 \index[dir]{Verify Job}
801 \index[dir]{Directive!Verify Job}
802 If you run a verify job without this directive, the last job run will be
803 compared with the catalog, which means that you must immediately follow
804 a backup by a verify command. If you specify a {\bf Verify Job} Bacula
805 will find the last job with that name that ran. This permits you to run
806 all your backups, then run Verify jobs on those that you wish to be
807 verified (most often a {\bf VolumeToCatalog}) so that the tape just
811 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
813 \index[dir]{Directive!JobDefs}
814 If a JobDefs-Resource-Name is specified, all the values contained in the
815 named JobDefs resource will be used as the defaults for the current Job.
816 Any value that you explicitly define in the current Job resource, will
817 override any defaults specified in the JobDefs resource. The use of
818 this directive permits writing much more compact Job resources where the
819 bulk of the directives are defined in one or more JobDefs. This is
820 particularly useful if you have many similar Jobs but with minor
821 variations such as different Clients. A simple example of the use of
822 JobDefs is provided in the default bacula-dir.conf file.
824 \label{Job:Bootstrap}
825 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
826 \index[dir]{Bootstrap}
827 \index[dir]{Directive!Bootstrap}
828 The Bootstrap directive specifies a bootstrap file that, if provided,
829 will be used during {\bf Restore} Jobs and is ignored in other Job
830 types. The {\bf bootstrap} file contains the list of tapes to be used
831 in a restore Job as well as which files are to be restored.
832 Specification of this directive is optional, and if specified, it is
833 used only for a restore job. In addition, when running a Restore job
834 from the console, this value can be changed.
836 If you use the {\bf Restore} command in the Console program, to start a
837 restore job, the {\bf bootstrap} file will be created automatically from
838 the files you select to be restored.
840 For additional details of the {\bf bootstrap} file, please see
841 \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
843 \label{writebootstrap}
845 \label{Job:WriteBootstrap}
846 \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
847 \index[dir]{Write Bootstrap}
848 \index[dir]{Directive!Write Bootstrap}
849 The {\bf writebootstrap} directive specifies a file name where Bacula
850 will write a {\bf bootstrap} file for each Backup job run. This
851 directive applies only to Backup Jobs. If the Backup job is a Full
852 save, Bacula will erase any current contents of the specified file
853 before writing the bootstrap records. If the Job is an Incremental
855 save, Bacula will append the current bootstrap record to the end of the
858 Using this feature, permits you to constantly have a bootstrap file that
859 can recover the current state of your system. Normally, the file
860 specified should be a mounted drive on another machine, so that if your
861 hard disk is lost, you will immediately have a bootstrap record
862 available. Alternatively, you should copy the bootstrap file to another
863 machine after it is updated. Note, it is a good idea to write a separate
864 bootstrap file for each Job backed up including the job that backs up
865 your catalog database.
867 If the {\bf bootstrap-file-specification} begins with a vertical bar
868 (\lstinline+|+), Bacula will use the specification as the name of a program to which
869 it will pipe the bootstrap record. It could for example be a shell
870 script that emails you the bootstrap record.
872 On versions 1.39.22 or greater, before opening the file or executing the
873 specified command, Bacula performs
874 \ilink{character substitution}{character substitution} like in RunScript
875 directive. To automatically manage your bootstrap files, you can use
876 this in your {\bf JobDefs} resources:
879 Write Bootstrap = "%c_%n.bsr"
884 For more details on using this file, please see the chapter entitled
885 \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
888 \item [Client = \lt{}client-resource-name\gt{}]
890 \index[dir]{Directive!Client}
891 The Client directive specifies the Client (File daemon) that will be used in
892 the current Job. Only a single Client may be specified in any one Job. The
893 Client runs on the machine to be backed up, and sends the requested files to
894 the Storage daemon for backup, or receives them when restoring. For
895 additional details, see the
896 \ilink{Client Resource section}{ClientResource} of this chapter.
897 This directive is required.
900 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
902 \index[dir]{Directive!FileSet}
903 The FileSet directive specifies the FileSet that will be used in the
904 current Job. The FileSet specifies which directories (or files) are to
905 be backed up, and what options to use (e.g. compression, \ldots{}). Only a
906 single FileSet resource may be specified in any one Job. For additional
907 details, see the \ilink{FileSet Resource section}{FileSetResource} of
908 this chapter. This directive is required.
911 \item [Base = \lt{}job-resource-name, \ldots{}\gt{}]
913 \index[dir]{Directive!Base}
914 The Base directive permits to specify the list of jobs that will be used during
915 Full backup as base. This directive is optional. See the \ilink{Base Job
916 chapter}{basejobs} for more information.
919 \item [Messages = \lt{}messages-resource-name\gt{}]
920 \index[dir]{Messages}
921 \index[dir]{Directive!Messages}
922 The Messages directive defines what Messages resource should be used for
923 this job, and thus how and where the various messages are to be
924 delivered. For example, you can direct some messages to a log file, and
925 others can be sent by email. For additional details, see the
926 \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
927 directive is required.
930 \item [Pool = \lt{}pool-resource-name\gt{}]
932 \index[dir]{Directive!Pool}
933 The Pool directive defines the pool of Volumes where your data can be
934 backed up. Many Bacula installations will use only the {\bf Default}
935 pool. However, if you want to specify a different set of Volumes for
936 different Clients or different Jobs, you will probably want to use
937 Pools. For additional details, see the \ilink{Pool Resource
938 section}{PoolResource} of this chapter. This directive is required.
940 \label{Job:FullBackupPool}
941 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
942 \index[dir]{Full Backup Pool}
943 \index[dir]{Directive!Full Backup Pool}
944 The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
945 It will override any Pool specification during a Full backup. This
946 directive is optional.
948 \label{Job:DifferentialBackupPool}
949 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
950 \index[dir]{Differential Backup Pool}
951 \index[dir]{Directive!Differential Backup Pool}
952 The {\it Differential Backup Pool} specifies a Pool to be used for
953 Differential backups. It will override any Pool specification during a
954 Differential backup. This directive is optional.
956 \label{Job:IncrementalBackupPool}
957 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
958 \index[dir]{Incremental Backup Pool}
959 \index[dir]{Directive!Incremental Backup Pool}
960 The {\it Incremental Backup Pool} specifies a Pool to be used for
961 Incremental backups. It will override any Pool specification during an
962 Incremental backup. This directive is optional.
965 \item [Schedule = \lt{}schedule-name\gt{}]
966 \index[dir]{Schedule}
967 \index[dir]{Directive!Schedule}
968 The Schedule directive defines what schedule is to be used for the Job.
969 The schedule in turn determines when the Job will be automatically
970 started and what Job level (i.e. Full, Incremental, \ldots{}) is to be run.
971 This directive is optional, and if left out, the Job can only be started
972 manually using the Console program. Although you may specify only a
973 single Schedule resource for any one job, the Schedule resource may
974 contain multiple {\bf Run} directives, which allow you to run the Job at
975 many different times, and each {\bf run} directive permits overriding
976 the default Job Level Pool, Storage, and Messages resources. This gives
977 considerable flexibility in what can be done with a single Job. For
978 additional details, see the \ilink{Schedule Resource
979 Chapter}{ScheduleResource} of this manual.
983 \item [Storage = \lt{}storage-resource-name\gt{}]
985 \index[dir]{Directive!Storage}
986 The Storage directive defines the name of the storage services where you
987 want to backup the FileSet data. For additional details, see the
988 \ilink{Storage Resource Chapter}{StorageResource} of this manual.
989 The Storage resource may also be specified in the Job's Pool resource,
990 in which case the value in the Pool resource overrides any value
991 in the Job. This Storage resource definition is not required by either
992 the Job resource or in the Pool, but it must be specified in
993 one or the other, if not an error will result.
995 \label{Job:MaxStartDelay}
996 \item [Max Start Delay = \lt{}time\gt{}]
997 \index[dir]{Max Start Delay}
998 \index[dir]{Directive!Max Start Delay}
999 The time specifies the maximum delay between the scheduled time and the
1000 actual start time for the Job. For example, a job can be scheduled to
1001 run at 1:00am, but because other jobs are running, it may wait to run.
1002 If the delay is set to 3600 (one hour) and the job has not begun to run
1003 by 2:00am, the job will be canceled. This can be useful, for example,
1004 to prevent jobs from running during day time hours. The default is 0
1005 which indicates no limit.
1007 \label{Job:MaxRunTime}
1008 \item [Max Run Time = \lt{}time\gt{}]
1009 \index[dir]{Max Run Time}
1010 \index[dir]{Directive!Max Run Time}
1011 The time specifies the maximum allowed time that a job may run, counted
1012 from when the job starts, ({\bf not} necessarily the same as when the
1015 By default, the the watchdog thread will kill any Job that has run more
1016 than 6 days. The maximum watchdog timeout is independent of MaxRunTime
1017 and cannot be changed.
1020 \label{Job:IncrementalWaitRunTime}
1021 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
1022 \index[dir]{Incremental Wait Run Time}
1023 \index[dir]{Differential Wait Run Time}
1024 \index[dir]{Directive!Differential Max Wait Time}
1025 Theses directives have been deprecated in favor of
1026 \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
1028 \label{Job:IncrementalMaxRunTime}
1029 \item [Incremental Max Run Time = \lt{}time\gt{}]
1030 \index[dir]{Incremental Max Run Time}
1031 \index[dir]{Directive!Incremental Max Run Time}
1032 The time specifies the maximum allowed time that an Incremental backup job may
1033 run, counted from when the job starts, ({\bf not} necessarily the same as when
1034 the job was scheduled).
1036 \label{Job:DifferentialMaxRunTime}
1037 \item [Differential Max Wait Time = \lt{}time\gt{}]
1038 \index[dir]{Differential Max Run Time}
1039 \index[dir]{Directive!Differential Max Run Time}
1040 The time specifies the maximum allowed time that a Differential backup job may
1041 run, counted from when the job starts, ({\bf not} necessarily the same as when
1042 the job was scheduled).
1044 \label{Job:MaxRunSchedTime}
1045 \item [Max Run Sched Time = \lt{}time\gt{}]
1046 \index[dir]{Max Run Sched Time}
1047 \index[dir]{Directive!Max Run Sched Time}
1049 The time specifies the maximum allowed time that a job may run, counted from
1050 when the job was scheduled. This can be useful to prevent jobs from running
1051 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1054 \label{Job:MaxWaitTime}
1055 \item [Max Wait Time = \lt{}time\gt{}]
1056 \index[dir]{Max Wait Time}
1057 \index[dir]{Directive!Max Wait Time}
1058 The time specifies the maximum allowed time that a job may block waiting
1059 for a resource (such as waiting for a tape to be mounted, or waiting for
1060 the storage or file daemons to perform their duties), counted from the
1061 when the job starts, ({\bf not} necessarily the same as when the job was
1062 scheduled). This directive works as expected since bacula 2.3.18.
1064 \bsysimageH{different_time}{Job time control directives}{fig:differenttime}
1065 %% \begin{figure}[htbp]
1067 %% \includegraphics[width=13cm]{\idir different_time}
1068 %% \label{fig:differenttime}
1069 %% \caption{Job time control directives}
1072 \label{Job:MaximumBandwidth}
1073 \item [Maximum Bandwidth = \lt{}speed\gt{}]
1074 \index[dir]{Maximum Bandwidth}
1075 \index[dir]{Directive!Maximum Bandwidth}
1077 The speed parameter specifies the maximum allowed bandwidth that a job may
1078 use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
1080 \label{Job:MaxFullInterval}
1081 \item [Max Full Interval = \lt{}time\gt{}]
1082 \index[dir]{Max Full Interval}
1083 \index[dir]{Directive!Max Full Interval}
1084 The time specifies the maximum allowed age (counting from start time) of
1085 the most recent successful Full backup that is required in order to run
1086 Incremental or Differential backup jobs. If the most recent Full backup
1087 is older than this interval, Incremental and Differential backups will be
1088 upgraded to Full backups automatically. If this directive is not present,
1089 or specified as 0, then the age of the previous Full backup is not
1091 \label{PreferMountedVolumes}
1093 \label{Job:PreferMountedVolumes}
1094 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
1095 \index[dir]{Prefer Mounted Volumes}
1096 \index[dir]{Directive!Prefer Mounted Volumes}
1097 If the Prefer Mounted Volumes directive is set to {\bf yes} (default
1098 yes), the Storage daemon is requested to select either an Autochanger or
1099 a drive with a valid Volume already mounted in preference to a drive
1100 that is not ready. This means that all jobs will attempt to append
1101 to the same Volume (providing the Volume is appropriate -- right Pool,
1102 \ldots{} for that job), unless you are using multiple pools.
1103 If no drive with a suitable Volume is available, it
1104 will select the first available drive. Note, any Volume that has
1105 been requested to be mounted, will be considered valid as a mounted
1106 volume by another job. This if multiple jobs start at the same time
1107 and they all prefer mounted volumes, the first job will request the
1108 mount, and the other jobs will use the same volume.
1110 If the directive is set to {\bf no}, the Storage daemon will prefer
1111 finding an unused drive, otherwise, each job started will append to the
1112 same Volume (assuming the Pool is the same for all jobs). Setting
1113 Prefer Mounted Volumes to no can be useful for those sites
1114 with multiple drive autochangers that prefer to maximize backup
1115 throughput at the expense of using additional drives and Volumes.
1116 This means that the job will prefer to use an unused drive rather
1117 than use a drive that is already in use.
1119 Despite the above, we recommend against setting this directive to
1121 it tends to add a lot of swapping of Volumes between the different
1122 drives and can easily lead to deadlock situations in the Storage
1123 daemon. We will accept bug reports against it, but we cannot guarantee
1124 that we will be able to fix the problem in a reasonable time.
1126 A better alternative for using multiple drives is to use multiple
1127 pools so that Bacula will be forced to mount Volumes from those Pools
1128 on different drives.
1130 \label{Job:PruneJobs}
1131 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1132 \index[dir]{Prune Jobs}
1133 \index[dir]{Directive!Prune Jobs}
1134 Normally, pruning of Jobs from the Catalog is specified on a Client by
1135 Client basis in the Client resource with the {\bf AutoPrune} directive.
1136 If this directive is specified (not normally) and the value is {\bf
1137 yes}, it will override the value specified in the Client resource. The
1138 default is {\bf no}.
1141 \label{Job:PruneFiles}
1142 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1143 \index[dir]{Prune Files}
1144 \index[dir]{Directive!Prune Files}
1145 Normally, pruning of Files from the Catalog is specified on a Client by
1146 Client basis in the Client resource with the {\bf AutoPrune} directive.
1147 If this directive is specified (not normally) and the value is {\bf
1148 yes}, it will override the value specified in the Client resource. The
1149 default is {\bf no}.
1151 \label{Job:PruneVolumes}
1152 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1153 \index[dir]{Prune Volumes}
1154 \index[dir]{Directive!Prune Volumes}
1155 Normally, pruning of Volumes from the Catalog is specified on a Pool by
1156 Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1157 Note, this is different from File and Job pruning which is done on a
1158 Client by Client basis. If this directive is specified (not normally)
1159 and the value is {\bf yes}, it will override the value specified in the
1160 Pool resource. The default is {\bf no}.
1162 \label{Job:RunScript}
1163 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1164 \index[dir]{RunScript}
1165 \index[dir]{Directive!Run Script}
1167 The RunScript directive behaves like a resource in that it
1168 requires opening and closing braces around a number of directives
1169 that make up the body of the runscript.
1171 The specified {\bf Command} (see below for details) is run as an external
1172 program prior or after the current Job. This is optional. By default, the
1173 program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1175 \textbf{Console} options are special commands that are sent to the director instead
1176 of the OS. At this time, console command ouputs are redirected to log with
1179 You can use following console command : \texttt{delete}, \texttt{disable},
1180 \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1181 \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1182 \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1183 \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1184 \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}. See console chapter for
1185 more information. You need to specify needed information on command line, nothing
1186 will be prompted. Example :
1189 Console = "prune files client=%c"
1190 Console = "update stats age=3"
1193 You can specify more than one Command/Console option per RunScript.
1195 You can use following options may be specified in the body
1197 \LTXtable{0.95\linewidth}{table_runscript}
1199 Any output sent by the command to standard output will be included in the
1200 Bacula job report. The command string must be a valid program name or name
1203 In addition, the command string is parsed then fed to the OS,
1204 which means that the path will be searched to execute your specified
1205 command, but there is no shell interpretation, as a consequence, if you
1206 invoke complicated commands or want any shell features such as redirection
1207 or piping, you must call a shell script and do it inside that script.
1209 Before submitting the specified command to the operating system, Bacula
1210 performs character substitution of the following characters:
1211 \label{character substitution}
1218 %d = Daemon's name (Such as host-dir or host-fd)
1219 %D = Director's name (Also valid on file daemon)
1220 %e = Job Exit Status
1221 %f = Job FileSet (Only on director side)
1228 %p = Pool name (Only on director side)
1230 %t = Job type (Backup, ...)
1231 %v = Volume name (Only on director side)
1232 %w = Storage name (Only on director side)
1233 %x = Spooling enabled? ("yes" or "no")
1238 Some character substitutions are not available in all situations. The Job Exit
1239 Status code \%e edits the following values:
1242 \index[dir]{Exit Status}
1249 \item Unknown term code
1252 Thus if you edit it on a command line, you will need to enclose
1253 it within some sort of quotes.
1256 You can use these following shortcuts:\\
1258 \LTXtable{0.95\linewidth}{table_runscriptshortcuts}
1264 Command = "/etc/init.d/apache stop"
1270 Command = "/etc/init.d/apache start"
1274 {\bf Notes about ClientRunBeforeJob}
1276 For compatibility reasons, with this shortcut, the command is executed
1277 directly when the client recieve it. And if the command is in error, other
1278 remote runscripts will be discarded. To be sure that all commands will be
1279 sent and executed, you have to use RunScript syntax.
1281 {\bf Special Windows Considerations}
1283 You can run scripts just after snapshots initializations with
1284 \textsl{AfterVSS} keyword.
1286 In addition, for a Windows client, please take
1287 note that you must ensure a correct path to your script. The script or
1288 program can be a .com, .exe or a .bat file. If you just put the program
1289 name in then Bacula will search using the same rules that cmd.exe uses
1290 (current directory, Bacula bin directory, and PATH). It will even try the
1291 different extensions in the same order as cmd.exe.
1292 The command can be anything that cmd.exe or command.com will recognize
1293 as an executable file.
1295 However, if you have slashes in the program name then Bacula figures you
1296 are fully specifying the name, so you must also explicitly add the three
1297 character extension.
1299 The command is run in a Win32 environment, so Unix like commands will not
1300 work unless you have installed and properly configured Cygwin in addition
1301 to and separately from Bacula.
1303 The System \%Path\% will be searched for the command. (under the
1304 environment variable dialog you have have both System Environment and
1305 User Environment, we believe that only the System environment will be
1306 available to bacula-fd, if it is running as a service.)
1308 System environment variables can be referenced with \%var\% and
1309 used as either part of the command name or arguments.
1311 So if you have a script in the Bacula\\bin directory then the following lines
1316 Client Run Before Job = systemstate
1318 Client Run Before Job = systemstate.bat
1320 Client Run Before Job = "systemstate"
1322 Client Run Before Job = "systemstate.bat"
1324 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1328 The outer set of quotes is removed when the configuration file is parsed.
1329 You need to escape the inner quotes so that they are there when the code
1330 that parses the command line for execution runs so it can tell what the
1336 ClientRunBeforeJob = "\"C:/Program Files/Software
1337 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1341 The special characters
1345 will need to be quoted,
1346 if they are part of a filename or argument.
1348 If someone is logged in, a blank ``command'' window running the commands
1349 will be present during the execution of the command.
1351 Some Suggestions from Phil Stracchino for running on Win32 machines with
1352 the native Win32 File daemon:
1355 \item You might want the ClientRunBeforeJob directive to specify a .bat
1356 file which runs the actual client-side commands, rather than trying
1357 to run (for example) regedit /e directly.
1358 \item The batch file should explicitly 'exit 0' on successful completion.
1359 \item The path to the batch file should be specified in Unix form:
1361 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1363 rather than DOS/Windows form:
1365 ClientRunBeforeJob =
1367 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1371 For Win32, please note that there are certain limitations:
1373 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1375 Lines like the above do not work because there are limitations of
1376 cmd.exe that is used to execute the command.
1377 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1378 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1379 cmd prompt and see what happens. Once the command is correct insert a
1380 backslash (\textbackslash{}) before each double quote ("), and
1381 then put quotes around the whole thing when putting it in
1382 the director's .conf file. You either need to have only one set of quotes
1383 or else use the short name and don't put quotes around the command path.
1385 Below is the output from cmd's help as it relates to the command line
1386 passed to the /c option.
1389 If /C or /K is specified, then the remainder of the command line after
1390 the switch is processed as a command line, where the following logic is
1391 used to process quote (") characters:
1395 If all of the following conditions are met, then quote characters
1396 on the command line are preserved:
1399 \item exactly two quote characters.
1400 \item no special characters between the two quote characters,
1401 where special is one of:
1405 \item there are one or more whitespace characters between the
1406 the two quote characters.
1407 \item the string between the two quote characters is the name
1408 of an executable file.
1411 \item Otherwise, old behavior is to see if the first character is
1412 a quote character and if so, strip the leading character and
1413 remove the last quote character on the command line, preserving
1414 any text after the last quote character.
1419 The following example of the use of the Client Run Before Job directive was
1420 submitted by a user:\\
1421 You could write a shell script to back up a DB2 database to a FIFO. The shell
1431 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1436 The following line in the Job resource in the bacula-dir.conf file:
1439 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1444 When the job is run, you will get messages from the output of the script
1445 stating that the backup has started. Even though the command being run is
1446 backgrounded with \&, the job will block until the ``db2 BACKUP DATABASE''
1447 command, thus the backup stalls.
1449 To remedy this situation, the ``db2 BACKUP DATABASE'' line should be changed to
1454 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1459 It is important to redirect the input and outputs of a backgrounded command to
1460 /dev/null to prevent the script from blocking.
1462 \label{Job:RunBeforeJob}
1463 \item [Run Before Job = \lt{}command\gt{}]
1464 \index[dir]{Run Before Job}
1465 \index[dir]{Directive!Run Before Job}
1466 \index[dir]{Directive!Run Before Job}
1467 The specified {\bf command} is run as an external program prior to running the
1468 current Job. This directive is not required, but if it is defined, and if the
1469 exit code of the program run is non-zero, the current Bacula job will be
1473 Run Before Job = "echo test"
1475 it's equivalent to :
1478 Command = "echo test"
1484 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1485 simple way to modify your schedules during a holiday. For example, suppose
1486 that you normally do Full backups on Fridays, but Thursday and Friday are
1487 holidays. To avoid having to change tapes between Thursday and Friday when
1488 no one is in the office, you can create a RunBeforeJob that returns a
1489 non-zero status on Thursday and zero on all other days. That way, the
1490 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1491 before leaving will be used.
1493 \label{Job:RunAfterJob}
1494 \item [Run After Job = \lt{}command\gt{}]
1495 \index[dir]{Run After Job}
1496 \index[dir]{Directive!Run After Job}
1497 The specified {\bf command} is run as an external program if the current
1498 job terminates normally (without error or without being canceled). This
1499 directive is not required. If the exit code of the program run is
1500 non-zero, Bacula will print a warning message. Before submitting the
1501 specified command to the operating system, Bacula performs character
1502 substitution as described above for the {\bf RunScript} directive.
1504 An example of the use of this directive is given in the
1505 \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1507 See the {\bf Run After Failed Job} if you
1508 want to run a script after the job has terminated with any
1511 \label{Job:RunAfterJob}
1512 \item [Run After Failed Job = \lt{}command\gt{}]
1513 \index[dir]{Run After Job}
1514 \index[dir]{Directive!Run After Job}
1515 The specified {\bf command} is run as an external program after the current
1516 job terminates with any error status. This directive is not required. The
1517 command string must be a valid program name or name of a shell script. If
1518 the exit code of the program run is non-zero, Bacula will print a
1519 warning message. Before submitting the specified command to the
1520 operating system, Bacula performs character substitution as described above
1521 for the {\bf RunScript} directive. Note, if you wish that your script
1522 will run regardless of the exit status of the Job, you can use this :
1525 Command = "echo test"
1529 RunsOnSuccess = yes # default, you can drop this line
1533 An example of the use of this directive is given in the
1534 \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1537 \label{Job:ClientRunBeforeJob}
1538 \item [Client Run Before Job = \lt{}command\gt{}]
1539 \index[dir]{Client Run Before Job}
1540 \index[dir]{Directive!Client Run Before Job}
1541 This directive is the same as {\bf Run Before Job} except that the
1542 program is run on the client machine. The same restrictions apply to
1543 Unix systems as noted above for the {\bf RunScript}.
1545 \label{Job:ClientRunAfterJob}
1546 \item [Client Run After Job = \lt{}command\gt{}]
1547 \index[dir]{Client Run After Job}
1548 \index[dir]{Directive!Client Run After Job}
1549 The specified {\bf command} is run on the client machine as soon
1550 as data spooling is complete in order to allow restarting applications
1551 on the client as soon as possible. .
1553 Note, please see the notes above in {\bf RunScript}
1554 concerning Windows clients.
1556 \label{Job:RerunFailedLevels}
1557 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1558 \index[dir]{Rerun Failed Levels}
1559 \index[dir]{Directive!Rerun Failed Levels}
1560 If this directive is set to {\bf yes} (default no), and Bacula detects that
1561 a previous job at a higher level (i.e. Full or Differential) has failed,
1562 the current job level will be upgraded to the higher level. This is
1563 particularly useful for Laptops where they may often be unreachable, and if
1564 a prior Full save has failed, you wish the very next backup to be a Full
1565 save rather than whatever level it is started as.
1567 There are several points that must be taken into account when using this
1568 directive: first, a failed job is defined as one that has not terminated
1569 normally, which includes any running job of the same name (you need to
1570 ensure that two jobs of the same name do not run simultaneously);
1571 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1572 when checking for failed levels, which means that any FileSet change will
1575 \label{Job:SpoolData}
1576 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1577 \index[dir]{Spool Data}
1578 \index[dir]{Directive!Spool Data}
1580 If this directive is set to {\bf yes} (default no), the Storage daemon will
1581 be requested to spool the data for this Job to disk rather than write it
1582 directly to the Volume (normally a tape).
1584 Thus the data is written in large blocks to the Volume rather than small
1585 blocks. This directive is particularly useful when running multiple
1586 simultaneous backups to tape. Once all the data arrives or the spool
1587 files' maximum sizes are reached, the data will be despooled and written
1590 Spooling data prevents interleaving date from several job and reduces or
1591 eliminates tape drive stop and start commonly known as ``shoe-shine''.
1593 We don't recommend using this option if you are writing to a disk file
1594 using this option will probably just slow down the backup jobs.
1596 NOTE: When this directive is set to yes, Spool Attributes is also
1597 automatically set to yes.
1599 \label{Job:SpoolData}
1600 \item [SpoolData=yes\vb{}no]
1601 \index[dir]{SpoolData}
1602 \index[dir]{Directive!SpoolData}
1603 tells Bacula to request the Storage daemon to spool data to a disk file
1604 before writing it to the Volume (normally a tape).
1606 \label{Job:SpoolAttributes}
1607 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1608 \index[dir]{Spool Attributes}
1609 \index[dir]{Directive!Spool Attributes}
1611 \index[general]{slow}
1612 \index[dir]{Backups!slow}
1613 \index[general]{Backups!slow}
1614 The default is set to {\bf no}, which means that the File attributes are
1615 sent by the Storage daemon to the Director as they are stored on tape.
1616 However, if you want to avoid the possibility that database updates will
1617 slow down writing to the tape, you may want to set the value to {\bf
1618 yes}, in which case the Storage daemon will buffer the File attributes
1619 and Storage coordinates to a temporary file in the Working Directory,
1620 then when writing the Job data to the tape is completed, the attributes
1621 and storage coordinates will be sent to the Director.
1623 NOTE: When Spool Data is set to yes, Spool Attributes is also
1624 automatically set to yes.
1626 \label{Job:SpoolSize}
1627 \item [SpoolSize={\it bytes}]
1628 \index[dir]{SpoolSize}
1629 \index[dir]{Directive!SpoolSize}
1630 where the bytes specify the maximum spool size for this job.
1631 The default is take from Device Maximum Spool Size limit.
1632 This directive is available only in Bacula version 2.3.5 or
1637 \item [Where = \lt{}directory\gt{}]
1639 \index[dir]{Directive!Where}
1640 This directive applies only to a Restore job and specifies a prefix to
1641 the directory name of all files being restored. This permits files to
1642 be restored in a different location from which they were saved. If {\bf
1643 Where} is not specified or is set to backslash ({\bf /}), the files will
1644 be restored to their original location. By default, we have set {\bf
1645 Where} in the example configuration files to be {\bf
1646 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1649 \label{confaddprefix}
1650 \label{Job:AddPrefix}
1651 \item [Add Prefix = \lt{}directory\gt{}]
1652 \index[dir]{AddPrefix}
1653 \index[dir]{Directive!AddPrefix}
1654 This directive applies only to a Restore job and specifies a prefix to the
1655 directory name of all files being restored. This will use \ilink{File
1656 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1658 \label{Job:AddSuffix}
1659 \item [Add Suffix = \lt{}extention\gt{}]
1660 \index[dir]{AddSuffix}
1661 \index[dir]{Directive!AddSuffix}
1662 This directive applies only to a Restore job and specifies a suffix to all
1663 files being restored. This will use \ilink{File Relocation}{filerelocation}
1664 feature implemented in Bacula 2.1.8 or later.
1666 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1667 \texttt{/etc/passwsd.old}
1669 \label{Job:StripPrefix}
1670 \item [Strip Prefix = \lt{}directory\gt{}]
1671 \index[dir]{StripPrefix}
1672 \index[dir]{Directive!StripPrefix}
1673 This directive applies only to a Restore job and specifies a prefix to remove
1674 from the directory name of all files being restored. This will use the
1675 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1678 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1681 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1689 \label{Job:RegexWhere}
1690 \item [RegexWhere = \lt{}expressions\gt{}]
1691 \index[dir]{RegexWhere}
1692 \index[dir]{Directive!RegexWhere}
1693 This directive applies only to a Restore job and specifies a regex filename
1694 manipulation of all files being restored. This will use \ilink{File
1695 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1697 For more informations about how use this option, see
1698 \ilink{this}{useregexwhere}.
1701 \item [Replace = \lt{}replace-option\gt{}]
1702 \index[dir]{Replace}
1703 \index[dir]{Directive!Replace}
1704 This directive applies only to a Restore job and specifies what happens
1705 when Bacula wants to restore a file or directory that already exists.
1706 You have the following options for {\bf replace-option}:
1712 when the file to be restored already exists, it is deleted and then
1713 replaced by the copy that was backed up. This is the default value.
1716 \index[dir]{ifnewer}
1717 if the backed up file (on tape) is newer than the existing file, the
1718 existing file is deleted and replaced by the back up.
1721 \index[dir]{ifolder}
1722 if the backed up file (on tape) is older than the existing file, the
1723 existing file is deleted and replaced by the back up.
1727 if the backed up file already exists, Bacula skips restoring this file.
1730 \label{Job:PrefixLinks}
1731 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1732 \index[dir]{Prefix Links}
1733 \index[dir]{Directive!Prefix Links}
1734 If a {\bf Where} path prefix is specified for a recovery job, apply it
1735 to absolute links as well. The default is {\bf No}. When set to {\bf
1736 Yes} then while restoring files to an alternate directory, any absolute
1737 soft links will also be modified to point to the new alternate
1738 directory. Normally this is what is desired -- i.e. everything is self
1739 consistent. However, if you wish to later move the files to their
1740 original locations, all files linked with absolute names will be broken.
1742 \label{Job:MaximumConcurrentJobs}
1743 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1744 \index[dir]{Maximum Concurrent Jobs}
1745 \index[dir]{Directive!Maximum Concurrent Jobs}
1746 where \lt{}number\gt{} is the maximum number of Jobs from the current
1747 Job resource that can run concurrently. Note, this directive limits
1748 only Jobs with the same name as the resource in which it appears. Any
1749 other restrictions on the maximum concurrent jobs such as in the
1750 Director, Client, or Storage resources will also apply in addition to
1751 the limit specified here. The default is set to 1, but you may set it
1752 to a larger number. We strongly recommend that you read the WARNING
1753 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1754 Director's resource.
1756 \label{Job:RescheduleOnError}
1757 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1758 \index[dir]{Reschedule On Error}
1759 \index[dir]{Directive!Reschedule On Error}
1760 If this directive is enabled, and the job terminates in error, the job
1761 will be rescheduled as determined by the {\bf Reschedule Interval} and
1762 {\bf Reschedule Times} directives. If you cancel the job, it will not
1763 be rescheduled. The default is {\bf no} (i.e. the job will not be
1766 This specification can be useful for portables, laptops, or other
1767 machines that are not always connected to the network or switched on.
1769 \label{Job:RescheduleInterval}
1770 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1771 \index[dir]{Reschedule Interval}
1772 \index[dir]{Directive!Reschedule Interval}
1773 If you have specified {\bf Reschedule On Error = yes} and the job
1774 terminates in error, it will be rescheduled after the interval of time
1775 specified by {\bf time-specification}. See \ilink{the time
1776 specification formats}{Time} in the Configure chapter for details of
1777 time specifications. If no interval is specified, the job will not be
1778 rescheduled on error.
1780 \label{Job:RescheduleTimes}
1781 \item [Reschedule Times = \lt{}count\gt{}]
1782 \index[dir]{Reschedule Times}
1783 \index[dir]{Directive!Reschedule Times}
1784 This directive specifies the maximum number of times to reschedule the
1785 job. If it is set to zero (the default) the job will be rescheduled an
1786 indefinite number of times.
1788 \label{Job:AllowDuplicateJobs}
1789 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1790 \index[general]{Allow Duplicate Jobs}
1792 %\begin{figure}[htbp]
1794 % \includegraphics[width=13cm]{\idir duplicate-real}
1795 % \label{fig:allowduplicatejobs}
1796 % \caption{Allow Duplicate Jobs usage}
1798 \bsysimageH{duplicate-real}{Allow Duplicate Jobs usage}{fig:allowduplicatejobs}
1800 A duplicate job in the sense we use it here means a second or subsequent job
1801 with the same name starts. This happens most frequently when the first job
1802 runs longer than expected because no tapes are available.
1804 If this directive is enabled duplicate jobs will be run. If
1805 the directive is set to {\bf no} (default) then only one job of a given name
1806 may run at one time, and the action that Bacula takes to ensure only
1807 one job runs is determined by the other directives (see below).
1809 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1810 are present and none of the three directives given below permit
1811 cancelling a job, then the current job (the second one started)
1814 \label{Job:AllowHigherDuplicates}
1815 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1816 \index[general]{Allow Higher Duplicates}
1817 This directive was implemented in version 5.0.0, but does not work
1818 as expected. If used, it should always be set to no. In later versions
1819 of Bacula the directive is disabled (disregarded).
1822 \label{Job:CancelLowerLevelDuplicates}
1823 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1824 \index[general]{Cancel Lower Level Duplicates}
1825 If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
1826 directive is set to \textbf{yes}, Bacula will choose between duplicated
1827 jobs the one with the highest level. For example, it will cancel a
1828 previous Incremental to run a Full backup. It works only for Backup
1829 jobs. The default is \texttt{no}. If the levels of the duplicated
1830 jobs are the same, nothing is done and the other
1831 Cancel XXX Duplicate directives will be examined.
1833 \label{Job:CancelQueuedDuplicates}
1834 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1835 \index[general]{Cancel Queued Duplicates}
1836 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1837 if this directive is set to {\bf yes} any job that is
1838 already queued to run but not yet running will be canceled.
1839 The default is {\bf no}.
1841 \label{Job:CancelRunningDuplicates}
1842 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1843 \index[general]{Cancel Running Duplicates}
1844 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1845 if this directive is set to {\bf yes} any job that is already running
1846 will be canceled. The default is {\bf no}.
1849 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1850 %%\index[general]{Duplicate Job Proximity}
1851 %% This directive permits to determine if two jobs are really duplicated.
1852 %% If the first one is running for long time, this is probably not a good
1853 %% idea to cancel it.
1856 \item [Run = \lt{}job-name\gt{}]
1858 \index[dir]{Directive!Run}
1859 \index[dir]{Clone a Job}
1860 The Run directive (not to be confused with the Run option in a
1861 Schedule) allows you to start other jobs or to clone jobs. By using the
1862 cloning keywords (see below), you can backup
1863 the same data (or almost the same data) to two or more drives
1864 at the same time. The {\bf job-name} is normally the same name
1865 as the current Job resource (thus creating a clone). However, it
1866 may be any Job name, so one job may start other related jobs.
1868 The part after the equal sign must be enclosed in double quotes,
1869 and can contain any string or set of options (overrides) that you
1870 can specify when entering the Run command from the console. For
1871 example {\bf storage=DDS-4 \ldots{}}. In addition, there are two special
1872 keywords that permit you to clone the current job. They are {\bf level=\%l}
1873 and {\bf since=\%s}. The \%l in the level keyword permits
1874 entering the actual level of the current job and the \%s in the since
1875 keyword permits putting the same time for comparison as used on the
1876 current job. Note, in the case of the since keyword, the \%s must be
1877 enclosed in double quotes, and thus they must be preceded by a backslash
1878 since they are already inside quotes. For example:
1881 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1884 A cloned job will not start additional clones, so it is not
1885 possible to recurse.
1887 Please note that all cloned jobs, as specified in the Run directives are
1888 submitted for running before the original job is run (while it is being
1889 initialized). This means that any clone job will actually start before
1890 the original job, and may even block the original job from starting
1891 until the original job finishes unless you allow multiple simultaneous
1892 jobs. Even if you set a lower priority on the clone job, if no other
1893 jobs are running, it will start before the original job.
1895 If you are trying to prioritize jobs by using the clone feature (Run
1896 directive), you will find it much easier to do using a RunScript
1897 resource, or a RunBeforeJob directive.
1900 \label{Job:Priority}
1901 \item [Priority = \lt{}number\gt{}]
1902 \index[dir]{Priority}
1903 \index[dir]{Directive!Priority}
1904 This directive permits you to control the order in which your jobs will
1905 be run by specifying a positive non-zero number. The higher the number,
1906 the lower the job priority. Assuming you are not running concurrent jobs,
1907 all queued jobs of priority 1 will run before queued jobs of priority 2
1908 and so on, regardless of the original scheduling order.
1910 The priority only affects waiting jobs that are queued to run, not jobs
1911 that are already running. If one or more jobs of priority 2 are already
1912 running, and a new job is scheduled with priority 1, the currently
1913 running priority 2 jobs must complete before the priority 1 job is
1914 run, unless Allow Mixed Priority is set.
1916 The default priority is 10.
1918 If you want to run concurrent jobs you should
1919 keep these points in mind:
1922 \item See \bsysxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup
1923 concurrent jobs in the \problemsman{}.
1925 \item Bacula concurrently runs jobs of only one priority at a time. It
1926 will not simultaneously run a priority 1 and a priority 2 job.
1928 \item If Bacula is running a priority 2 job and a new priority 1 job is
1929 scheduled, it will wait until the running priority 2 job terminates even
1930 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1931 to run simultaneously.
1933 \item Suppose that bacula is running a priority 2 job and a new priority 1
1934 job is scheduled and queued waiting for the running priority 2 job to
1935 terminate. If you then start a second priority 2 job, the waiting
1936 priority 1 job will prevent the new priority 2 job from running
1937 concurrently with the running priority 2 job. That is: as long as there
1938 is a higher priority job waiting to run, no new lower priority jobs will
1939 start even if the Maximum Concurrent Jobs settings would normally allow
1940 them to run. This ensures that higher priority jobs will be run as soon
1944 If you have several jobs of different priority, it may not best to start
1945 them at exactly the same time, because Bacula must examine them one at a
1946 time. If by Bacula starts a lower priority job first, then it will run
1947 before your high priority jobs. If you experience this problem, you may
1948 avoid it by starting any higher priority jobs a few seconds before lower
1949 priority ones. This insures that Bacula will examine the jobs in the
1950 correct order, and that your priority scheme will be respected.
1951 \label{AllowMixedPriority}
1953 \label{Job:AllowMixedPriority}
1954 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1955 \index[dir]{Allow Mixed Priority}
1956 This directive is only implemented in version 2.5 and later. When
1957 set to {\bf yes} (default {\bf no}), this job may run even if lower
1958 priority jobs are already running. This means a high priority job
1959 will not have to wait for other jobs to finish before starting.
1960 The scheduler will only mix priorities when all running jobs have
1963 Note that only higher priority jobs will start early. Suppose the
1964 director will allow two concurrent jobs, and that two jobs with
1965 priority 10 are running, with two more in the queue. If a job with
1966 priority 5 is added to the queue, it will be run as soon as one of
1967 the running jobs finishes. However, new priority 10 jobs will not
1968 be run until the priority 5 job has finished.
1969 \label{WritePartAfterJob}
1971 \label{Job:WritePartAfterJob}
1972 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1973 \index[dir]{Write Part After Job}
1974 \index[dir]{Directive!Write Part After Job}
1975 This directive is only implemented in version 1.37 and later.
1976 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1977 will be created after the job is finished.
1979 It should be set to {\bf yes} when writing to devices that require mount
1980 (for example DVD), so you are sure that the current part, containing
1981 this job's data, is written to the device, and that no data is left in
1982 the temporary file on the hard disk. However, on some media, like DVD+R
1983 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1984 written. So, if you run several jobs each after another, you could set
1985 this directive to {\bf no} for all jobs, except the last one, to avoid
1986 wasting too much space, but to ensure that the data is written to the
1987 medium when all jobs are finished.
1989 This directive is ignored with tape and FIFO devices.
1993 The following is an example of a valid Job resource definition:
2000 Level = Incremental # default
2002 FileSet="Minou Full Set"
2005 Schedule = "MinouWeeklyCycle"
2011 \label{JobDefsResource}
2012 \section{The JobDefs Resource}
2013 \index[general]{JobDefs Resource}
2014 \index[general]{Resource!JobDefs}
2016 The JobDefs resource permits all the same directives that can appear in a Job
2017 resource. However, a JobDefs resource does not create a Job, rather it can be
2018 referenced within a Job to provide defaults for that Job. This permits you to
2019 concisely define several nearly identical Jobs, each one referencing a JobDefs
2020 resource which contains the defaults. Only the changes from the defaults need to
2021 be mentioned in each Job.
2023 \label{ScheduleResource}
2024 \section{The Schedule Resource}
2025 \index[general]{Resource!Schedule}
2026 \index[general]{Schedule Resource}
2028 The Schedule resource provides a means of automatically scheduling a Job as
2029 well as the ability to override the default Level, Pool, Storage and Messages
2030 resources. If a Schedule resource is not referenced in a Job, the Job can only
2031 be run manually. In general, you specify an action to be taken and when.
2036 \index[dir]{Schedule}
2037 \index[dir]{Directive!Schedule}
2038 Start of the Schedule directives. No {\bf Schedule} resource is
2039 required, but you will need at least one if you want Jobs to be
2040 automatically started.
2042 \label{Schdedule:Name}
2043 \item [Name = \lt{}name\gt{}]
2045 \index[dir]{Directive!Name}
2046 The name of the schedule being defined. The Name directive is required.
2048 \label{Schdedule:Run}
2049 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
2051 \index[dir]{Directive!Run}
2052 The Run directive defines when a Job is to be run, and what overrides if
2053 any to apply. You may specify multiple {\bf run} directives within a
2054 {\bf Schedule} resource. If you do, they will all be applied (i.e.
2055 multiple schedules). If you have two {\bf Run} directives that start at
2056 the same time, two Jobs will start at the same time (well, within one
2057 second of each other).
2059 The {\bf Job-overrides} permit overriding the Level, the Storage, the
2060 Messages, and the Pool specifications provided in the Job resource. In
2061 addition, the FullPool, the IncrementalPool, and the DifferentialPool
2062 specifications permit overriding the Pool specification according to
2063 what backup Job Level is in effect.
2065 By the use of overrides, you may customize a particular Job. For
2066 example, you may specify a Messages override for your Incremental
2067 backups that outputs messages to a log file, but for your weekly or
2068 monthly Full backups, you may send the output by email by using a
2069 different Messages override.
2071 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
2072 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
2073 or IncrementalPool, and the {\bf value} is as defined on the respective
2074 directive formats for the Job resource. You may specify multiple {\bf
2075 Job-overrides} on one {\bf Run} directive by separating them with one or
2076 more spaces or by separating them with a trailing comma. For example:
2082 \index[dir]{Directive!Level}
2083 is all files in the FileSet whether or not they have changed.
2085 \item [Level=Incremental]
2087 \index[dir]{Directive!Level}
2088 is all files that have changed since the last backup.
2092 \index[dir]{Directive!Pool}
2093 specifies to use the Pool named {\bf Weekly}.
2095 \item [Storage=DLT\_Drive]
2096 \index[dir]{Storage}
2097 \index[dir]{Directive!Storage}
2098 specifies to use {\bf DLT\_Drive} for the storage device.
2100 \item [Messages=Verbose]
2101 \index[dir]{Messages}
2102 \index[dir]{Directive!Messages}
2103 specifies to use the {\bf Verbose} message resource for the Job.
2105 \item [FullPool=Full]
2106 \index[dir]{FullPool}
2107 \index[dir]{Directive!FullPool}
2108 specifies to use the Pool named {\bf Full} if the job is a full backup, or
2110 upgraded from another type to a full backup.
2112 \item [DifferentialPool=Differential]
2113 \index[dir]{DifferentialPool}
2114 \index[dir]{Directive!DifferentialPool}
2115 specifies to use the Pool named {\bf Differential} if the job is a
2116 differential backup.
2118 \item [IncrementalPool=Incremental]
2119 \index[dir]{IncrementalPool}
2120 \index[dir]{Directive!IncrementalPool}
2121 specifies to use the Pool named {\bf Incremental} if the job is an
2125 \item [WritePartAfterJob=yes\vb{}no]
2126 \index[dir]{WritePartAfterJob}
2127 \index[dir]{Directive!WritePartAfterJob}
2128 tells Bacula to request the Storage daemon to write the current part
2129 file to the device when the job is finished (see \ilink{Write Part After
2130 Job directive in the Job resource}{WritePartAfterJob}). Please note,
2131 this directive is implemented only in version 1.37 and later. The
2132 default is yes. We strongly recommend that you keep this set to yes
2133 otherwise, when the last job has finished one part will remain in the
2134 spool file and restore may or may not work.
2138 {\bf Date-time-specification} determines when the Job is to be run. The
2139 specification is a repetition, and as a default Bacula is set to run a job at
2140 the beginning of the hour of every hour of every day of every week of every
2141 month of every year. This is not normally what you want, so you must specify
2142 or limit when you want the job to run. Any specification given is assumed to
2143 be repetitive in nature and will serve to override or limit the default
2144 repetition. This is done by specifying masks or times for the hour, day of the
2145 month, day of the week, week of the month, week of the year, and month when
2146 you want the job to run. By specifying one or more of the above, you can
2147 define a schedule to repeat at almost any frequency you want.
2149 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
2150 minute} the Job is to be run. Of these four items to be specified, {\bf day}
2151 is special in that you may either specify a day of the month such as 1, 2,
2152 \ldots{} 31, or you may specify a day of the week such as Monday, Tuesday, \ldots{}
2153 Sunday. Finally, you may also specify a week qualifier to restrict the
2154 schedule to the first, second, third, fourth, or fifth week of the month.
2156 For example, if you specify only a day of the week, such as {\bf Tuesday} the
2157 Job will be run every hour of every Tuesday of every Month. That is the {\bf
2158 month} and {\bf hour} remain set to the defaults of every month and all
2161 Note, by default with no other specification, your job will run at the
2162 beginning of every hour. If you wish your job to run more than once in any
2163 given hour, you will need to specify multiple {\bf run} specifications each
2164 with a different minute.
2166 The date/time to run the Job can be specified in the following way in
2173 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
2174 second | third | fourth | fifth
2175 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
2176 sunday | monday | tuesday | wednesday |
2177 thursday | friday | saturday
2178 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2179 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
2180 aug | sep | oct | nov | dec | january |
2181 february | ... | december
2182 <daily-keyword> = daily
2183 <weekly-keyword> = weekly
2184 <monthly-keyword> = monthly
2185 <hourly-keyword> = hourly
2186 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2187 <number> = <digit> | <digit><number>
2188 <12hour> = 0 | 1 | 2 | ... 12
2189 <hour> = 0 | 1 | 2 | ... 23
2190 <minute> = 0 | 1 | 2 | ... 59
2191 <day> = 1 | 2 | ... 31
2192 <time> = <hour>:<minute> |
2193 <12hour>:<minute>am |
2195 <time-spec> = <at-keyword> <time> |
2197 <date-keyword> = <void-keyword> <weekly-keyword>
2198 <day-range> = <day>-<day>
2199 <month-range> = <month-keyword>-<month-keyword>
2200 <wday-range> = <wday-keyword>-<wday-keyword>
2201 <range> = <day-range> | <month-range> |
2203 <date> = <date-keyword> | <day> | <range>
2204 <date-spec> = <date> | <date-spec>
2205 <day-spec> = <day> | <wday-keyword> |
2206 <day> | <wday-range> |
2207 <week-keyword> <wday-keyword> |
2208 <week-keyword> <wday-range> |
2210 <month-spec> = <month-keyword> | <month-range> |
2212 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2218 Note, the Week of Year specification wnn follows the ISO standard definition
2219 of the week of the year, where Week 1 is the week in which the first Thursday
2220 of the year occurs, or alternatively, the week which contains the 4th of
2221 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2222 precedes the first ISO week (i.e. has the first few days of the year if any
2223 occur before Thursday). w00 is not defined by the ISO specification. A week
2224 starts with Monday and ends with Sunday.
2226 According to the NIST (US National Institute of Standards and Technology),
2227 12am and 12pm are ambiguous and can be defined to anything. However,
2228 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2229 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2230 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2231 am/pm). This is the definition in Bacula version 2.0.3 and later.
2233 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2234 with level full each Sunday at 2:05am and an incremental job Monday through
2235 Saturday at 2:05am is:
2240 Name = "WeeklyCycle"
2241 Run = Level=Full sun at 2:05
2242 Run = Level=Incremental mon-sat at 2:05
2247 An example of a possible monthly cycle is as follows:
2252 Name = "MonthlyCycle"
2253 Run = Level=Full Pool=Monthly 1st sun at 2:05
2254 Run = Level=Differential 2nd-5th sun at 2:05
2255 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2260 The first of every month:
2266 Run = Level=Full on 1 at 2:05
2267 Run = Level=Incremental on 2-31 at 2:05
2278 Run = Level=Full hourly at 0:05
2279 Run = Level=Full hourly at 0:15
2280 Run = Level=Full hourly at 0:25
2281 Run = Level=Full hourly at 0:35
2282 Run = Level=Full hourly at 0:45
2283 Run = Level=Full hourly at 0:55
2288 \section{Technical Notes on Schedules}
2289 \index[general]{Schedules!Technical Notes on}
2290 \index[general]{Technical Notes on Schedules}
2292 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2293 minute field to each schedule. The masks are hour, day of the month (mday),
2294 month, day of the week (wday), week of the month (wom), and week of the year
2295 (woy). The schedule is initialized to have the bits of each of these masks
2296 set, which means that at the beginning of every hour, the job will run. When
2297 you specify a month for the first time, the mask will be cleared and the bit
2298 corresponding to your selected month will be selected. If you specify a second
2299 month, the bit corresponding to it will also be added to the mask. Thus when
2300 Bacula checks the masks to see if the bits are set corresponding to the
2301 current time, your job will run only in the two months you have set. Likewise,
2302 if you set a time (hour), the hour mask will be cleared, and the hour you
2303 specify will be set in the bit mask and the minutes will be stored in the
2306 For any schedule you have defined, you can see how these bits are set by doing
2307 a {\bf show schedules} command in the Console program. Please note that the
2308 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2313 \label{ClientResource}
2314 \section{The Client Resource}
2315 \index[general]{Resource!Client}
2316 \index[general]{Client Resource}
2318 The Client resource defines the attributes of the Clients that are served by
2319 this Director; that is the machines that are to be backed up. You will need
2320 one Client resource definition for each machine to be backed up.
2324 \item [Client (or FileDaemon)]
2325 \index[dir]{Client (or FileDaemon)}
2326 \index[dir]{Directive!Client (or FileDaemon)}
2327 Start of the Client directives.
2330 \item [Name = \lt{}name\gt{}]
2332 \index[dir]{Directive!Name}
2333 The client name which will be used in the Job resource directive or in the
2334 console run command. This directive is required.
2336 \label{Client:Address}
2337 \item [Address = \lt{}address\gt{}]
2338 \index[dir]{Address}
2339 \index[dir]{Directive!FD Address}
2340 \index[dir]{File Daemon Address}
2341 \index[dir]{Client Address}
2342 Where the address is a host name, a fully qualified domain name, or a
2343 network address in dotted quad notation for a Bacula File server daemon.
2344 This directive is required.
2346 \label{Client:FdPort}
2347 \item [FD Port = \lt{}port-number\gt{}]
2348 \index[dir]{FD Port}
2349 \index[dir]{Directive!FD Port}
2350 Where the port is a port number at which the Bacula File server daemon can
2351 be contacted. The default is 9102.
2353 \label{Client:Catalog}
2354 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2355 \index[dir]{Catalog}
2356 \index[dir]{Directive!Catalog}
2357 This specifies the name of the catalog resource to be used for this Client.
2358 This directive is required.
2360 \label{Client:Password}
2361 \item [Password = \lt{}password\gt{}]
2362 \index[dir]{Password}
2363 \index[dir]{Directive!Password}
2364 This is the password to be used when establishing a connection with the File
2365 services, so the Client configuration file on the machine to be backed up
2366 must have the same password defined for this Director. This directive is
2367 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2368 Bacula will generate a random password during the configuration process,
2369 otherwise it will be left blank.
2371 The password is plain text. It is not generated through any special
2372 process, but it is preferable for security reasons to make the text
2374 \label{FileRetention}
2376 \label{FileRetention}
2377 \label{Client:FileRetention}
2378 \item [File Retention = \lt{}time-period-specification\gt{}]
2379 \index[dir]{File Retention}
2380 \index[dir]{Directive!File Retention}
2381 The File Retention directive defines the length of time that Bacula will
2382 keep File records in the Catalog database after the End time of the
2383 Job corresponding to the File records.
2384 When this time period expires, and if
2385 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2386 that are older than the specified File Retention period. Note, this affects
2387 only records in the catalog database. It does not affect your archive
2390 File records may actually be retained for a shorter period than you specify
2391 on this directive if you specify either a shorter {\bf Job Retention} or a
2392 shorter {\bf Volume Retention} period. The shortest retention period of the
2393 three takes precedence. The time may be expressed in seconds, minutes,
2394 hours, days, weeks, months, quarters, or years. See the
2395 \ilink{ Configuration chapter}{Time} of this manual for
2396 additional details of time specification.
2398 The default is 60 days.
2400 \label{JobRetention}
2401 \label{Client:JobRetention}
2402 \item [Job Retention = \lt{}time-period-specification\gt{}]
2403 \index[dir]{Job Retention}
2404 \index[dir]{Directive!Job Retention}
2405 The Job Retention directive defines the length of time that Bacula will keep
2406 Job records in the Catalog database after the Job End time. When
2407 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2408 Bacula will prune (remove) Job records that are older than the specified
2409 File Retention period. As with the other retention periods, this
2410 affects only records in the catalog and not data in your archive backup.
2412 If a Job record is selected for pruning, all associated File and JobMedia
2413 records will also be pruned regardless of the File Retention period set.
2414 As a consequence, you normally will set the File retention period to be
2415 less than the Job retention period. The Job retention period can actually
2416 be less than the value you specify here if you set the {\bf Volume
2417 Retention} directive in the Pool resource to a smaller duration. This is
2418 because the Job retention period and the Volume retention period are
2419 independently applied, so the smaller of the two takes precedence.
2421 The Job retention period is specified as seconds, minutes, hours, days,
2422 weeks, months, quarters, or years. See the
2423 \ilink{ Configuration chapter}{Time} of this manual for
2424 additional details of time specification.
2426 The default is 180 days.
2429 \label{Client:AutoPrune}
2430 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2431 \index[dir]{AutoPrune}
2432 \index[dir]{Directive!AutoPrune}
2433 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2434 will automatically apply the File retention period and the Job retention
2435 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2436 pruning will not be done, and your Catalog will grow in size each time you
2437 run a Job. Pruning affects only information in the catalog and not data
2438 stored in the backup archives (on Volumes).
2440 \label{Client:MaximumConcurrentJobs}
2441 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2442 \index[dir]{Maximum Concurrent Jobs}
2443 \index[dir]{Directive!Maximum Concurrent Jobs}
2444 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2445 that can run concurrently. Note, this directive limits only Jobs for Clients
2446 with the same name as the resource in which it appears. Any other
2447 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2448 Storage resources will also apply in addition to any limit specified here.
2449 The default is set to 1, but you may set it to a larger number.
2451 \label{Client:MaximumBandwidthPerJob}
2452 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2453 \index[dir]{Maximum Bandwidth Per Job}
2454 \index[dir]{Directive!Maximum Bandwidth Per Job}
2456 The speed parameter specifies the maximum allowed bandwidth that a job may use
2457 when started for this Client. The speed parameter should be specified in
2458 k/s, Kb/s, m/s or Mb/s.
2460 % \item [FD Storage Address = \lt{}address\gt{}]
2461 % \index[dir]{FDStorageAddress}
2462 % \index[dir]{Directive!FD Storage Address}
2463 % \index[dir]{Storage daemon Address}
2465 % Where the address is a host name, a {\bf fully qualified domain name}, or an
2466 % {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2467 % will be transmitted to the File daemon instead of the Storage
2468 % \texttt{Address} who will then use it to contact the Storage daemon. This
2469 % directive can be used in NAT environment where the configuration of the
2470 % Client resolver is not possible. Note that using this directive will not allow
2471 % to use multiple Storage Daemon for Backup/Restore jobs.
2473 % \begin{figure}[htbp]
2475 % \includegraphics[width=10cm]{\idir BackupOverWan1}
2476 % \caption{Backup over WAN using FD Storage Address}
2479 \label{Client:Priority}
2480 \item [Priority = \lt{}number\gt{}]
2481 \index[dir]{Priority}
2482 \index[dir]{Directive!Priority}
2483 The number specifies the priority of this client relative to other clients
2484 that the Director is processing simultaneously. The priority can range from
2485 1 to 1000. The clients are ordered such that the smaller number priorities
2486 are performed first (not currently implemented).
2489 The following is an example of a valid Client resource definition:
2495 FDAddress = minimatou
2497 Password = very_good
2502 \label{StorageResource}
2503 \section{The Storage Resource}
2504 \index[general]{Resource!Storage}
2505 \index[general]{Storage Resource}
2507 The Storage resource defines which Storage daemons are available for use by
2513 \index[dir]{Storage}
2514 \index[dir]{Directive!Storage}
2515 Start of the Storage resources. At least one storage resource must be
2518 \label{Storage:Name}
2519 \item [Name = \lt{}name\gt{}]
2521 \index[dir]{Directive!Name}
2522 The name of the storage resource. This name appears on the Storage directive
2523 specified in the Job resource and is required.
2525 \label{Storage:Address}
2526 \item [Address = \lt{}address\gt{}]
2527 \index[dir]{Address}
2528 \index[dir]{Directive!SD Address}
2529 \index[dir]{Storage daemon Address}
2530 Where the address is a host name, a {\bf fully qualified domain name}, or an
2531 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2532 will be transmitted to the File daemon who will then use it to contact the
2533 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2534 the name but rather a fully qualified machine name or an IP address. This
2535 directive is required.
2537 \label{Storage:FDStorageAddress}
2538 \item [FD Storage Address = \lt{}address\gt{}]
2539 \index[dir]{FDStorageAddress}
2540 \index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
2541 Address} Where the address is a host name, a {\bf fully qualified domain
2542 name}, or an {\bf IP address}. Please note that the \lt{}address\gt{} as
2543 specified here will be transmitted to the File daemon instead of the
2544 \texttt{Address} who will then use it to contact the Storage daemon. This
2545 directive can be used in NAT environment where the configuration of the
2546 Client resolver is not possible.
2548 \bsysimageH{BackupOverWan1}{Backup over WAN using FD Storage Address}{figdirdconf:backupwan}
2549 %% \begin{figure}[htbp]
2551 %% \includegraphics[width=10cm]{\idir BackupOverWan1}
2552 %% \caption{Backup over WAN using FD Storage Address}
2555 \label{Storage:SdPort}
2556 \item [SD Port = \lt{}port\gt{}]
2557 \index[dir]{SD Port}
2558 \index[dir]{Directive!SD Port}
2559 Where port is the port to use to contact the storage daemon for information
2560 and to start jobs. This same port number must appear in the Storage resource
2561 of the Storage daemon's configuration file. The default is 9103.
2563 \label{Storage:Password}
2564 \item [Password = \lt{}password\gt{}]
2565 \index[dir]{Password}
2566 \index[dir]{Directive!Password}
2567 This is the password to be used when establishing a connection with the
2568 Storage services. This same password also must appear in the Director
2569 resource of the Storage daemon's configuration file. This directive is
2570 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2571 Bacula will generate a random password during the configuration process,
2572 otherwise it will be left blank.
2574 The password is plain text. It is not generated through any special
2575 process, but it is preferable for security reasons to use random text.
2577 \label{Storage:Device}
2578 \item [Device = \lt{}device-name\gt{}]
2580 \index[dir]{Directive!Device}
2581 This directive specifies the Storage daemon's name of the device
2582 resource to be used for the storage. If you are using an Autochanger,
2583 the name specified here should be the name of the Storage daemon's
2584 Autochanger resource rather than the name of an individual device. This
2585 name is not the physical device name, but the logical device name as
2586 defined on the {\bf Name} directive contained in the {\bf Device} or the
2587 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2588 configuration file. You can specify any name you would like (even the
2589 device name if you prefer) up to a maximum of 127 characters in length.
2590 The physical device name associated with this device is specified in the
2591 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2592 Please take care not to define two different Storage resource directives
2593 in the Director that point to the same Device in the Storage daemon.
2594 Doing so may cause the Storage daemon to block (or hang) attempting to
2595 open the same device that is already open. This directive is required.
2598 \label{Storage:MediaType}
2599 \item [Media Type = \lt{}MediaType\gt{}]
2600 \index[dir]{Media Type}
2601 \index[dir]{Directive!Media Type}
2602 This directive specifies the Media Type to be used to store the data.
2603 This is an arbitrary string of characters up to 127 maximum that you
2604 define. It can be anything you want. However, it is best to make it
2605 descriptive of the storage media (e.g. File, DAT, ``HP DLT8000'', 8mm,
2606 \ldots{}). In addition, it is essential that you make the {\bf Media Type}
2607 specification unique for each storage media type. If you have two DDS-4
2608 drives that have incompatible formats, or if you have a DDS-4 drive and
2609 a DDS-4 autochanger, you almost certainly should specify different {\bf
2610 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2611 associated with the Job, Bacula can decide to use any Storage daemon
2612 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2614 If you are writing to disk Volumes, you must make doubly sure that each
2615 Device resource defined in the Storage daemon (and hence in the
2616 Director's conf file) has a unique media type. Otherwise for Bacula
2617 versions 1.38 and older, your restores may not work because Bacula
2618 will assume that you can mount any Media Type with the same name on
2619 any Device associated with that Media Type. This is possible with
2620 tape drives, but with disk drives, unless you are very clever you
2621 cannot mount a Volume in any directory -- this can be done by creating
2622 an appropriate soft link.
2624 Currently Bacula permits only a single Media Type per Storage
2625 and Device definition. Consequently, if
2626 you have a drive that supports more than one Media Type, you can
2627 give a unique string to Volumes with different intrinsic Media
2628 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2629 those volumes will only be mounted on drives indicated with the
2630 dual type (DDS-3-4).
2632 If you want to tie Bacula to using a single Storage daemon or drive, you
2633 must specify a unique Media Type for that drive. This is an important
2634 point that should be carefully understood. Note, this applies equally
2635 to Disk Volumes. If you define more than one disk Device resource in
2636 your Storage daemon's conf file, the Volumes on those two devices are in
2637 fact incompatible because one can not be mounted on the other device
2638 since they are found in different directories. For this reason, you
2639 probably should use two different Media Types for your two disk Devices
2640 (even though you might think of them as both being File types). You can
2641 find more on this subject in the \ilink{Basic Volume
2642 Management}{DiskChapter} chapter of this manual.
2644 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2645 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2646 resource of the {\bf Storage daemon} configuration file. This directive
2647 is required, and it is used by the Director and the Storage daemon to
2648 ensure that a Volume automatically selected from the Pool corresponds to
2649 the physical device. If a Storage daemon handles multiple devices (e.g.
2650 will write to various file Volumes on different partitions), this
2651 directive allows you to specify exactly which device.
2653 As mentioned above, the value specified in the Director's Storage
2654 resource must agree with the value specified in the Device resource in
2655 the {\bf Storage daemon's} configuration file. It is also an additional
2656 check so that you don't try to write data for a DLT onto an 8mm device.
2657 \label{Autochanger1}
2659 \label{Storage:Autochanger}
2660 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2661 \index[dir]{Autochanger}
2662 \index[dir]{Directive!Autochanger}
2663 If you specify {\bf yes} for this command (the default is {\bf no}),
2664 when you use the {\bf label} command or the {\bf add} command to create
2665 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2666 number. This simplifies creating database entries for Volumes in an
2667 autochanger. If you forget to specify the Slot, the autochanger will
2668 not be used. However, you may modify the Slot associated with a Volume
2669 at any time by using the {\bf update volume} or {\bf update slots}
2670 command in the console program. When {\bf autochanger} is enabled, the
2671 algorithm used by Bacula to search for available volumes will be
2672 modified to consider only Volumes that are known to be in the
2673 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2674 will attempt recycling, pruning, \ldots{}, and if still no volume is found,
2675 Bacula will search for any volume whether or not in the magazine. By
2676 privileging in changer volumes, this procedure minimizes operator
2677 intervention. The default is {\bf no}.
2679 For the autochanger to be used, you must also specify {\bf Autochanger =
2680 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2681 configuration file as well as other important Storage daemon
2682 configuration information. Please consult the \ilink{Using
2683 Autochangers}{AutochangersChapter} manual of this chapter for the
2684 details of using autochangers.
2686 \label{Storage:MaximumConcurrentJobs}
2687 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2688 \index[dir]{Maximum Concurrent Jobs}
2689 \index[dir]{Directive!Maximum Concurrent Jobs}
2690 where \lt{}number\gt{} is the maximum number of Jobs with the current
2691 Storage resource that can run concurrently. Note, this directive limits
2692 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2693 the maximum concurrent jobs such as in the Director, Job, or Client
2694 resources will also apply in addition to any limit specified here. The
2695 default is set to 1, but you may set it to a larger number. However, if
2696 you set the Storage daemon's number of concurrent jobs greater than one,
2697 we recommend that you read the waring documented under \ilink{Maximum
2698 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2699 turn data spooling on as documented in the \ilink{Data
2700 Spooling}{SpoolingChapter} chapter of this manual.
2702 \label{AllowCompression}
2703 \label{Storage:AllowCompression}
2704 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2705 \index[dir]{AllowCompression}
2706 \index[dir]{Directive!AllowCompression}
2708 This directive is optional, and if you specify {\bf No} (the default is {\bf
2709 Yes}), it will cause backups jobs running on this storage resource to run
2710 without client File Daemon compression. This effectively overrides
2711 compression options in FileSets used by jobs which use this storage
2714 \label{Storage:Heartbeat Interval}
2715 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2716 \index[dir]{Heartbeat Interval}
2717 \index[dir]{Directive!Heartbeat}
2718 This directive is optional and if specified will cause the Director to
2719 set a keepalive interval (heartbeat) in seconds on each of the sockets
2720 it opens for the Storage resource. This value will override any
2721 specified at the Director level. It is implemented only on systems
2722 (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2723 The default value is zero, which means no change is made to the socket.
2727 The following is an example of a valid Storage resource definition:
2731 # Definition of tape storage device
2735 Password = storage_password # password for Storage daemon
2736 Device = "HP DLT 80" # same as Device in Storage daemon
2737 Media Type = DLT8000 # same as MediaType in Storage daemon
2742 \label{PoolResource}
2743 \section{The Pool Resource}
2744 \index[general]{Resource!Pool}
2745 \index[general]{Pool Resource}
2747 The Pool resource defines the set of storage Volumes (tapes or files) to be
2748 used by Bacula to write the data. By configuring different Pools, you can
2749 determine which set of Volumes (media) receives the backup data. This permits,
2750 for example, to store all full backup data on one set of Volumes and all
2751 incremental backups on another set of Volumes. Alternatively, you could assign
2752 a different set of Volumes to each machine that you backup. This is most
2753 easily done by defining multiple Pools.
2755 Another important aspect of a Pool is that it contains the default attributes
2756 (Maximum Jobs, Retention Period, Recycle flag, \ldots{}) that will be given to a
2757 Volume when it is created. This avoids the need for you to answer a large
2758 number of questions when labeling a new Volume. Each of these attributes can
2759 later be changed on a Volume by Volume basis using the {\bf update} command in
2760 the console program. Note that you must explicitly specify which Pool Bacula
2761 is to use with each Job. Bacula will not automatically search for the correct
2764 Most often in Bacula installations all backups for all machines (Clients) go
2765 to a single set of Volumes. In this case, you will probably only use the {\bf
2766 Default} Pool. If your backup strategy calls for you to mount a different tape
2767 each day, you will probably want to define a separate Pool for each day. For
2768 more information on this subject, please see the
2769 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2773 To use a Pool, there are three distinct steps. First the Pool must be defined
2774 in the Director's configuration file. Then the Pool must be written to the
2775 Catalog database. This is done automatically by the Director each time that it
2776 starts, or alternatively can be done using the {\bf create} command in the
2777 console program. Finally, if you change the Pool definition in the Director's
2778 configuration file and restart Bacula, the pool will be updated alternatively
2779 you can use the {\bf update pool} console command to refresh the database
2780 image. It is this database image rather than the Director's resource image
2781 that is used for the default Volume attributes. Note, for the pool to be
2782 automatically created or updated, it must be explicitly referenced by a Job
2785 Next the physical media must be labeled. The labeling can either be done with
2786 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2787 program. The preferred method is to use the {\bf label} command in the {\bf
2790 Finally, you must add Volume names (and their attributes) to the Pool. For
2791 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2792 archive device specified for the job (i.e. if you are going to back up to a
2793 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2794 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2795 are backing up to files. When running a Job, you must explicitly specify which
2796 Pool to use. Bacula will then automatically select the next Volume to use from
2797 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2798 from the Pool is identical to that required by the Storage resource you have
2799 specified for the Job.
2801 If you use the {\bf label} command in the console program to label the
2802 Volumes, they will automatically be added to the Pool, so this last step is
2803 not normally required.
2805 It is also possible to add Volumes to the database without explicitly labeling
2806 the physical volume. This is done with the {\bf add} console command.
2808 As previously mentioned, each time Bacula starts, it scans all the Pools
2809 associated with each Catalog, and if the database record does not already
2810 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2811 probably should do an {\bf update pool} if you change the Pool definition, but
2812 currently, you must do this manually using the {\bf update pool} command in
2813 the Console program.
2815 The Pool Resource defined in the Director's configuration file
2816 (bacula-dir.conf) may contain the following directives:
2822 \index[dir]{Directive!Pool}
2823 Start of the Pool resource. There must be at least one Pool resource
2828 \item [Name = \lt{}name\gt{}]
2830 \index[dir]{Directive!Name}
2831 The name of the pool. For most applications, you will use the default
2832 pool name {\bf Default}. This directive is required.
2835 \label{Pool:MaximumVolumes}
2836 \item [Maximum Volumes = \lt{}number\gt{}]
2837 \index[dir]{Maximum Volumes}
2838 \index[dir]{Directive!Maximum Volumes}
2839 This directive specifies the maximum number of volumes (tapes or files)
2840 contained in the pool. This directive is optional, if omitted or set to
2841 zero, any number of volumes will be permitted. In general, this
2842 directive is useful for Autochangers where there is a fixed number of
2843 Volumes, or for File storage where you wish to ensure that the backups
2844 made to disk files do not become too numerous or consume too much space.
2846 \label{Pool:PoolType}
2847 \item [Pool Type = \lt{}type\gt{}]
2848 \index[dir]{Pool Type}
2849 \index[dir]{Directive!Pool Type}
2850 This directive defines the pool type, which corresponds to the type of
2851 Job being run. It is required and may be one of the following:
2861 Note, only Backup is current implemented.
2863 \label{Pool:Storage}
2864 \item [Storage = \lt{}storage-resource-name\gt{}]
2865 \index[dir]{Storage}
2866 \index[dir]{Directive!Storage}
2867 The Storage directive defines the name of the storage services where you
2868 want to backup the FileSet data. For additional details, see the
2869 \ilink{Storage Resource Chapter}{StorageResource} of this manual.
2870 The Storage resource may also be specified in the Job resource,
2871 but the value, if any, in the Pool resource overrides any value
2872 in the Job. This Storage resource definition is not required by either
2873 the Job resource or in the Pool, but it must be specified in
2874 one or the other. If not configuration error will result.
2876 \label{Pool:UseVolumeOnce}
2877 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2878 \index[dir]{Use Volume Once}
2879 \index[dir]{Directive!Use Volume Once}
2880 This directive if set to {\bf yes} specifies that each volume is to be
2881 used only once. This is most useful when the Media is a file and you
2882 want a new file for each backup that is done. The default is {\bf no}
2883 (i.e. use volume any number of times). This directive will most likely
2884 be phased out (deprecated), so you are recommended to use {\bf Maximum
2885 Volume Jobs = 1} instead.
2887 The value defined by this directive in the bacula-dir.conf file is the
2888 default value used when a Volume is created. Once the volume is
2889 created, changing the value in the bacula-dir.conf file will not change
2890 what is stored for the Volume. To change the value for an existing
2891 Volume you must use the {\bf update} command in the Console.
2893 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2894 using this directive with multiple simultaneous jobs.
2896 \label{Pool:MaximumVolumeJobs}
2897 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2898 \index[dir]{Maximum Volume Jobs}
2899 \index[dir]{Directive!Maximum Volume Jobs}
2900 This directive specifies the maximum number of Jobs that can be written
2901 to the Volume. If you specify zero (the default), there is no limit.
2902 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2903 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2904 is marked {\bf Used} it can no longer be used for appending Jobs, much
2905 like the {\bf Full} status but it can be recycled if recycling is
2906 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2907 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2909 The value defined by this directive in the bacula-dir.conf
2910 file is the default value used when a Volume is created. Once the volume is
2911 created, changing the value in the bacula-dir.conf file will not change what
2912 is stored for the Volume. To change the value for an existing Volume you
2913 must use the {\bf update} command in the Console.
2915 If you are running multiple simultaneous jobs, this directive may not
2916 work correctly because when a drive is reserved for a job, this
2917 directive is not taken into account, so multiple jobs may try to
2918 start writing to the Volume. At some point, when the Media record is
2919 updated, multiple simultaneous jobs may fail since the Volume can no
2922 \label{Pool:MaximumVolumeFiles}
2923 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2924 \index[dir]{Maximum Volume Files}
2925 \index[dir]{Directive!Maximum Volume Files}
2926 This directive specifies the maximum number of files that can be written
2927 to the Volume. If you specify zero (the default), there is no limit.
2928 Otherwise, when the number of files written to the Volume equals {\bf
2929 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2930 is marked {\bf Used} it can no longer be used for appending Jobs, much
2931 like the {\bf Full} status but it can be recycled if recycling is
2932 enabled and thus used again. This value is checked and the {\bf Used}
2933 status is set only at the end of a job that writes to the particular
2936 The value defined by this directive in the bacula-dir.conf file is the
2937 default value used when a Volume is created. Once the volume is
2938 created, changing the value in the bacula-dir.conf file will not change
2939 what is stored for the Volume. To change the value for an existing
2940 Volume you must use the {\bf update} command in the Console.
2942 \label{Pool:MaximumVolumeBytes}
2943 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2944 \index[dir]{Maximum Volume Bytes}
2945 \index[dir]{Directive!Maximum Volume Bytes}
2946 This directive specifies the maximum number of bytes that can be written
2947 to the Volume. If you specify zero (the default), there is no limit
2948 except the physical size of the Volume. Otherwise, when the number of
2949 bytes written to the Volume equals {\bf size} the Volume will be marked
2950 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2951 used for appending Jobs, much like the {\bf Full} status but it can be
2952 recycled if recycling is enabled, and thus the Volume can be re-used
2953 after recycling. This value is checked and the {\bf Used} status set
2954 while the job is writing to the particular volume.
2956 This directive is particularly useful for restricting the size
2957 of disk volumes, and will work correctly even in the case of
2958 multiple simultaneous jobs writing to the volume.
2960 The value defined by this directive in the bacula-dir.conf file is the
2961 default value used when a Volume is created. Once the volume is
2962 created, changing the value in the bacula-dir.conf file will not change
2963 what is stored for the Volume. To change the value for an existing
2964 Volume you must use the {\bf update} command in the Console.
2966 \label{Pool:VolumeUseDuration}
2967 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2968 \index[dir]{Volume Use Duration}
2969 \index[dir]{Directive!Volume Use Duration}
2970 The Volume Use Duration directive defines the time period that the
2971 Volume can be written beginning from the time of first data write to the
2972 Volume. If the time-period specified is zero (the default), the Volume
2973 can be written indefinitely. Otherwise, the next time a job
2974 runs that wants to access this Volume, and the time period from the
2975 first write to the volume (the first Job written) exceeds the
2976 time-period-specification, the Volume will be marked {\bf Used}, which
2977 means that no more Jobs can be appended to the Volume, but it may be
2978 recycled if recycling is enabled. Using the command {\bf
2979 status dir} applies algorithms similar to running jobs, so
2980 during such a command, the Volume status may also be changed.
2982 recycled, it will be available for use again.
2984 You might use this directive, for example, if you have a Volume used for
2985 Incremental backups, and Volumes used for Weekly Full backups. Once the
2986 Full backup is done, you will want to use a different Incremental
2987 Volume. This can be accomplished by setting the Volume Use Duration for
2988 the Incremental Volume to six days. I.e. it will be used for the 6
2989 days following a Full save, then a different Incremental volume will be
2990 used. Be careful about setting the duration to short periods such as 23
2991 hours, or you might experience problems of Bacula waiting for a tape
2992 over the weekend only to complete the backups Monday morning when an
2993 operator mounts a new tape.
2995 The use duration is checked and the {\bf Used} status is set only at the
2996 end of a job that writes to the particular volume, which means that even
2997 though the use duration may have expired, the catalog entry will not be
2998 updated until the next job that uses this volume is run. This
2999 directive is not intended to be used to limit volume sizes
3000 and will not work correctly (i.e. will fail jobs) if the use
3001 duration expires while multiple simultaneous jobs are writing
3004 Please note that the value defined by this directive in the bacula-dir.conf
3005 file is the default value used when a Volume is created. Once the volume is
3006 created, changing the value in the bacula-dir.conf file will not change what
3007 is stored for the Volume. To change the value for an existing Volume you
3009 \bsysxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
3011 \label{Pool:CatalogFiles}
3012 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
3013 \index[dir]{Catalog Files}
3014 \index[dir]{Directive!Catalog Files}
3015 This directive defines whether or not you want the names of the files
3016 that were saved to be put into the catalog. The default is {\bf yes}.
3017 The advantage of specifying {\bf Catalog Files = No} is that you will
3018 have a significantly smaller Catalog database. The disadvantage is that
3019 you will not be able to produce a Catalog listing of the files backed up
3020 for each Job (this is often called Browsing). Also, without the File
3021 entries in the catalog, you will not be able to use the Console {\bf
3022 restore} command nor any other command that references File entries.
3023 \label{PoolAutoPrune}
3025 \label{Pool:AutoPrune}
3026 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
3027 \index[dir]{AutoPrune}
3028 \index[dir]{Directive!AutoPrune}
3029 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
3030 greater) will automatically apply the Volume Retention period when new
3031 Volume is needed and no appendable Volumes exist in the Pool. Volume
3032 pruning causes expired Jobs (older than the {\bf Volume Retention}
3033 period) to be deleted from the Catalog and permits possible recycling of
3035 \label{VolRetention}
3037 \label{Pool:VolumeRetention}
3038 \item [Volume Retention = \lt{}time-period-specification\gt{}]
3039 \index[dir]{Volume Retention}
3040 \index[dir]{Directive!Volume Retention}
3041 The Volume Retention directive defines the length of time that {\bf
3042 Bacula} will keep records associated with the Volume in
3043 the Catalog database after the End time of each Job written to the
3044 Volume. When this time period expires, and if {\bf AutoPrune} is set to
3045 {\bf yes} Bacula may prune (remove) Job records that are older than the
3046 specified Volume Retention period if it is necessary to free up a
3047 Volume. Recycling will not occur until it is absolutely necessary to
3048 free up a volume (i.e. no other writable volume exists).
3049 All File records associated with pruned Jobs are also
3050 pruned. The time may be specified as seconds, minutes, hours, days,
3051 weeks, months, quarters, or years. The {\bf Volume Retention} is
3052 applied independently of the {\bf Job Retention} and the {\bf File
3053 Retention} periods defined in the Client resource. This means that all
3054 the retentions periods are applied in turn and that the shorter period
3055 is the one that effectively takes precedence. Note, that when the {\bf
3056 Volume Retention} period has been reached, and it is necessary to obtain
3057 a new volume, Bacula will prune both the Job and the File records. This
3058 pruning could also occur during a {\bf status dir} command because it
3059 uses similar algorithms for finding the next available Volume.
3061 It is important to know that when the Volume Retention period expires,
3062 Bacula does not automatically recycle a Volume. It attempts to keep the
3063 Volume data intact as long as possible before over writing the Volume.
3065 By defining multiple Pools with different Volume Retention periods, you
3066 may effectively have a set of tapes that is recycled weekly, another
3067 Pool of tapes that is recycled monthly and so on. However, one must
3068 keep in mind that if your {\bf Volume Retention} period is too short, it
3069 may prune the last valid Full backup, and hence until the next Full
3070 backup is done, you will not have a complete backup of your system, and
3071 in addition, the next Incremental or Differential backup will be
3072 promoted to a Full backup. As a consequence, the minimum {\bf Volume
3073 Retention} period should be at twice the interval of your Full backups.
3074 This means that if you do a Full backup once a month, the minimum Volume
3075 retention period should be two months.
3077 The default Volume retention period is 365 days, and either the default
3078 or the value defined by this directive in the bacula-dir.conf file is
3079 the default value used when a Volume is created. Once the volume is
3080 created, changing the value in the bacula-dir.conf file will not change
3081 what is stored for the Volume. To change the value for an existing
3082 Volume you must use the {\bf update} command in the Console.
3084 \label{Pool:ActionOnPurge}
3085 \item [Action On Purge = \lt{Truncate}]
3086 \index[dir]{actiononpurge}
3088 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
3089 volume when it is purged with the \texttt{purge volume action=truncate}
3090 command. It is useful to prevent disk based volumes from consuming too much
3096 Action On Purge = Truncate
3101 You can schedule the truncate operation at the end of your CatalogBackup job
3102 like in this example:
3106 Name = CatalogBackup
3111 Console = "purge volume action=all allpools storage=File"
3115 \label{PoolScratchPool}
3117 \label{Pool:ScrachPool}
3118 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
3119 \index[dir]{ScrachPool}
3120 \index[dir]{Directive!ScrachPool}
3121 This directive permits to specify a dedicate \textsl{Scratch} for the
3122 current pool. This pool will replace the special pool named \textsl{Scrach}
3123 for volume selection. For more information about \textsl{Scratch} see
3124 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
3125 when using multiple storage sharing the same mediatype or when you want to
3126 dedicate volumes to a particular set of pool.
3127 \label{PoolRecyclePool}
3129 \label{Pool:RecyclePool}
3130 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
3131 \index[dir]{RecyclePool}
3132 \index[dir]{Directive!RecyclePool}
3133 This directive defines to which pool
3134 the Volume will be placed (moved) when it is recycled. Without
3135 this directive, a Volume will remain in the same pool when it is
3136 recycled. With this directive, it can be moved automatically to any
3137 existing pool during a recycle. This directive is probably most
3138 useful when defined in the Scratch pool, so that volumes will
3139 be recycled back into the Scratch pool. For more on the see the
3140 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
3142 Although this directive is called RecyclePool, the Volume in
3143 question is actually moved from its current pool to the one
3144 you specify on this directive when Bacula prunes the Volume and
3145 discovers that there are no records left in the catalog and hence
3146 marks it as {\bf Purged}.
3150 \label{Pool:Recycle}
3151 \item [Recycle = \lt{}yes\vb{}no\gt{}]
3152 \index[dir]{Recycle}
3153 \index[dir]{Directive!Recycle}
3154 This directive specifies whether or not Purged Volumes may be recycled.
3155 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
3156 none that are appendable, it will search for and recycle (reuse) Purged
3157 Volumes (i.e. volumes with all the Jobs and Files expired and thus
3158 deleted from the Catalog). If the Volume is recycled, all previous data
3159 written to that Volume will be overwritten. If Recycle is set to {\bf
3160 no}, the Volume will not be recycled, and hence, the data will remain
3161 valid. If you want to reuse (re-write) the Volume, and the recycle flag
3162 is no (0 in the catalog), you may manually set the recycle flag (update
3163 command) for a Volume to be reused.
3165 Please note that the value defined by this directive in the
3166 bacula-dir.conf file is the default value used when a Volume is created.
3167 Once the volume is created, changing the value in the bacula-dir.conf
3168 file will not change what is stored for the Volume. To change the value
3169 for an existing Volume you must use the {\bf update} command in the
3172 When all Job and File records have been pruned or purged from the
3173 catalog for a particular Volume, if that Volume is marked as
3174 Append, Full, Used, or Error, it will then be marked as Purged. Only
3175 Volumes marked as Purged will be considered to be converted to the
3176 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
3178 \label{RecycleOldest}
3180 \label{Pool:RecycleOldestVolume}
3181 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
3182 \index[dir]{Recycle Oldest Volume}
3183 \index[dir]{Directive!Recycle Oldest Volume}
3184 This directive instructs the Director to search for the oldest used
3185 Volume in the Pool when another Volume is requested by the Storage
3186 daemon and none are available. The catalog is then {\bf pruned}
3187 respecting the retention periods of all Files and Jobs written to this
3188 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
3189 Volume is recycled and will be used as the next Volume to be written.
3190 This directive respects any Job, File, or Volume retention periods that
3191 you may have specified, and as such it is {\bf much} better to use this
3192 directive than the Purge Oldest Volume.
3194 This directive can be useful if you have a fixed number of Volumes in the
3195 Pool and you want to cycle through them and you have specified the correct
3198 However, if you use this directive and have only one
3199 Volume in the Pool, you will immediately recycle your Volume if you fill
3200 it and Bacula needs another one. Thus your backup will be totally invalid.
3201 Please use this directive with care. The default is {\bf no}.
3202 \label{RecycleCurrent}
3205 \label{Pool:RecycleCurrentVolume}
3206 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3207 \index[dir]{Recycle Current Volume}
3208 \index[dir]{Directive!Recycle Current Volume}
3209 If Bacula needs a new Volume, this directive instructs Bacula to Prune
3210 the volume respecting the Job and File retention periods. If all Jobs
3211 are pruned (i.e. the volume is Purged), then the Volume is recycled and
3212 will be used as the next Volume to be written. This directive respects
3213 any Job, File, or Volume retention periods that you may have specified,
3214 and thus it is {\bf much} better to use it rather than the Purge Oldest
3217 This directive can be useful if you have: a fixed number of Volumes in
3218 the Pool, you want to cycle through them, and you have specified
3219 retention periods that prune Volumes before you have cycled through the
3222 However, if you use this directive and have only one Volume in the Pool,
3223 you will immediately recycle your Volume if you fill it and Bacula needs
3224 another one. Thus your backup will be totally invalid. Please use this
3225 directive with care. The default is {\bf no}.
3229 \label{Pool:PurgeOldestVolume}
3230 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3231 \index[dir]{Purge Oldest Volume}
3232 \index[dir]{Directive!Purge Oldest Volume}
3233 This directive instructs the Director to search for the oldest used
3234 Volume in the Pool when another Volume is requested by the Storage
3235 daemon and none are available. The catalog is then {\bf purged}
3236 irrespective of retention periods of all Files and Jobs written to this
3237 Volume. The Volume is then recycled and will be used as the next Volume
3238 to be written. This directive overrides any Job, File, or Volume
3239 retention periods that you may have specified.
3241 This directive can be useful if you have a fixed number of Volumes in
3242 the Pool and you want to cycle through them and reusing the oldest one
3243 when all Volumes are full, but you don't want to worry about setting
3244 proper retention periods. However, by using this option you risk losing
3247 Please be aware that {\bf Purge Oldest Volume} disregards all retention
3248 periods. If you have only a single Volume defined and you turn this
3249 variable on, that Volume will always be immediately overwritten when it
3250 fills! So at a minimum, ensure that you have a decent number of Volumes
3251 in your Pool before running any jobs. If you want retention periods to
3252 apply do not use this directive. To specify a retention period, use the
3253 {\bf Volume Retention} directive (see above).
3255 We {\bf highly} recommend against using this directive, because it is
3256 sure that some day, Bacula will recycle a Volume that contains current
3257 data. The default is {\bf no}.
3259 \label{Pool:FileRetention}
3260 \item [File Retention = \lt{}time-period-specification\gt{}]
3261 \index[dir]{File Retention}
3262 \index[dir]{Directive!File Retention}
3263 The File Retention directive defines the length of time that Bacula will
3264 keep File records in the Catalog database after the End time of the
3265 Job corresponding to the File records.
3267 This directive takes precedence over Client directives of the same name. For
3268 example, you can decide to increase Retention times for Archive or OffSite
3271 Note, this affects only records in the catalog database. It does not affect
3272 your archive backups.
3274 For more information see Client documentation about
3275 \ilink{FileRetention}{FileRetention}
3277 \label{Pool:JobRetention}
3278 \item [Job Retention = \lt{}time-period-specification\gt{}]
3279 \index[dir]{Job Retention}
3280 \index[dir]{Directive!Job Retention}
3282 The Job Retention directive defines the length of time that Bacula will keep
3283 Job records in the Catalog database after the Job End time. As with the
3284 other retention periods, this affects only records in the catalog and not
3285 data in your archive backup.
3287 This directive takes precedence over Client directives of the same name.
3288 For example, you can decide to increase Retention times for Archive or
3291 For more information see Client side documentation
3292 \ilink{JobRetention}{JobRetention}
3294 \label{Pool:CleaningPrefix}
3295 \item [Cleaning Prefix = \lt{}string\gt{}]
3296 \index[dir]{Cleaning Prefix}
3297 \index[dir]{Directive!Cleaning Prefix}
3298 This directive defines a prefix string, which if it matches the
3299 beginning of a Volume name during labeling of a Volume, the Volume will
3300 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3301 never attempt to use this tape. This is primarily for use with
3302 autochangers that accept barcodes where the convention is that barcodes
3303 beginning with {\bf CLN} are treated as cleaning tapes.
3306 \label{Pool:LabelFormat}
3307 \item [Label Format = \lt{}format\gt{}]
3308 \index[dir]{Label Format}
3309 \index[dir]{Directive!Label Format}
3310 This directive specifies the format of the labels contained in this
3311 pool. The format directive is used as a sort of template to create new
3312 Volume names during automatic Volume labeling.
3314 The {\bf format} should be specified in double quotes, and consists of
3315 letters, numbers and the special characters hyphen ({\bf -}), underscore
3316 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3317 characters for a Volume name. The {\bf format} should be enclosed in
3320 In addition, the format may contain a number of variable expansion
3321 characters which will be expanded by a complex algorithm allowing you to
3322 create Volume names of many different formats. In all cases, the
3323 expansion process must resolve to the set of characters noted above that
3324 are legal Volume names. Generally, these variable expansion characters
3325 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
3326 specify variable expansion characters, you should always enclose the
3327 format with double quote characters ({\bf "}). For more details on
3328 variable expansion, please see the \bsysxrlink{Variable
3329 Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
3331 If no variable expansion characters are found in the string, the Volume
3332 name will be formed from the {\bf format} string appended with the
3333 a unique number that increases. If you do not remove volumes from the
3334 pool, this number should be the number of volumes plus one, but this
3335 is not guaranteed. The unique number will be edited as four
3336 digits with leading zeros. For example, with a {\bf Label Format =
3337 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3338 File-0002}, \ldots{}
3340 With the exception of Job specific variables, you can test your {\bf
3341 LabelFormat} by using the \bsysxrlink{var}{var}{console}{command} in the
3344 In almost all cases, you should enclose the format specification (part
3345 after the equal sign) in double quotes. Please note that this directive
3346 is deprecated and is replaced in version 1.37 and greater with a Python
3347 script for creating volume names.
3351 In order for a Pool to be used during a Backup Job, the Pool must have at
3352 least one Volume associated with it. Volumes are created for a Pool using
3353 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3354 program. In addition to adding Volumes to the Pool (i.e. putting the
3355 Volume names in the Catalog database), the physical Volume must be labeled
3356 with a valid Bacula software volume label before {\bf Bacula} will accept
3357 the Volume. This will be automatically done if you use the {\bf label}
3358 command. Bacula can automatically label Volumes if instructed to do so,
3359 but this feature is not yet fully implemented.
3361 The following is an example of a valid Pool resource definition:
3373 \label{TheScratchPool}
3374 \subsection{The Scratch Pool}
3375 \index[general]{Scratch Pool}
3376 In general, you can give your Pools any name you wish, but there is one
3377 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3378 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3379 writing and it cannot find one, it will look in the Scratch pool, and if
3380 it finds an available Volume, it will move it out of the Scratch pool into
3381 the Pool currently being used by the job.
3384 \label{CatalogResource}
3385 \section{The Catalog Resource}
3386 \index[general]{Resource!Catalog}
3387 \index[general]{Catalog Resource}
3389 The Catalog Resource defines what catalog to use for the current job.
3390 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3391 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3392 may be as many Catalogs (databases) defined as you wish. For example, you
3393 may want each Client to have its own Catalog database, or you may want
3394 backup jobs to use one database and verify or restore jobs to use another
3397 Since SQLite is compiled in, it always runs on the same machine
3398 as the Director and the database must be directly accessible (mounted) from
3399 the Director. However, since both MySQL and PostgreSQL are networked
3400 databases, they may reside either on the same machine as the Director
3401 or on a different machine on the network. See below for more details.
3406 \index[dir]{Catalog}
3407 \index[dir]{Directive!Catalog}
3408 Start of the Catalog resource. At least one Catalog resource must be
3412 \label{Catalog:Name}
3413 \item [Name = \lt{}name\gt{}]
3415 \index[dir]{Directive!Name}
3416 The name of the Catalog. No necessary relation to the database server
3417 name. This name will be specified in the Client resource directive
3418 indicating that all catalog data for that Client is maintained in this
3419 Catalog. This directive is required.
3421 \label{Catalog:Password}
3422 \item [password = \lt{}password\gt{}]
3423 \index[dir]{password}
3424 \index[dir]{Directive!password}
3425 This specifies the password to use when logging into the database. This
3426 directive is required.
3428 \label{Catalog:DbName}
3429 \item [DB Name = \lt{}name\gt{}]
3430 \index[dir]{DB Name}
3431 \index[dir]{Directive!DB Name}
3432 This specifies the name of the database. If you use multiple catalogs
3433 (databases), you specify which one here. If you are using an external
3434 database server rather than the internal one, you must specify a name
3435 that is known to the server (i.e. you explicitly created the Bacula
3436 tables using this name. This directive is required.
3438 \label{Catalog:User}
3439 \item [user = \lt{}user\gt{}]
3441 \index[dir]{Directive!user}
3442 This specifies what user name to use to log into the database. This
3443 directive is required.
3445 \label{Catalog:DbSocket}
3446 \item [DB Socket = \lt{}socket-name\gt{}]
3447 \index[dir]{DB Socket}
3448 \index[dir]{Directive!DB Socket}
3449 This is the name of a socket to use on the local host to connect to the
3450 database. This directive is used only by MySQL and is ignored by SQLite.
3451 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3452 will use the default socket. If the DB Socket is specified, the
3453 MySQL server must reside on the same machine as the Director.
3455 \label{Catalog:DBAddress}
3456 \item [DB Address = \lt{}address\gt{}]
3457 \index[dir]{DB Address}
3458 \index[dir]{Directive!DB Address}
3459 This is the host address of the database server. Normally, you would specify
3460 this instead of {\bf DB Socket} if the database server is on another machine.
3461 In that case, you will also specify {\bf DB Port}. This directive is used
3462 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3463 This directive is optional.
3465 \label{Catalog:DbPort}
3466 \item [DB Port = \lt{}port\gt{}]
3467 \index[dir]{DB Port}
3468 \index[dir]{Directive!DB Port}
3469 This defines the port to be used in conjunction with {\bf DB Address} to
3470 access the database if it is on another machine. This directive is used only
3471 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3472 directive is optional.
3474 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3476 %% \index[dir]{Directive!Multiple Connections}
3477 %% By default, this directive is set to no. In that case, each job that uses
3479 %% same Catalog will use a single connection to the catalog. It will be shared,
3480 %% and Bacula will allow only one Job at a time to communicate. If you set this
3481 %% directive to yes, Bacula will permit multiple connections to the database,
3482 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3483 %% this is no problem. For MySQL, you must be *very* careful to have the
3484 %% multi-thread version of the client library loaded on your system. When this
3485 %% directive is set yes, each Job will have a separate connection to the
3486 %% database, and the database will control the interaction between the
3488 %% Jobs. This can significantly speed up the database operations if you are
3489 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3490 %% Bacula will automatically enable transactions. This can significantly speed
3491 %% up insertion of attributes in the database either for a single Job or
3492 %% multiple simultaneous Jobs.
3494 %% This directive has not been tested. Please test carefully before running it
3495 %% in production and report back your results.
3499 The following is an example of a valid Catalog resource definition:
3508 password = "" # no password = no security
3513 or for a Catalog on another machine:
3523 DB Address = remote.acme.com
3529 \label{MessagesResource2}
3530 \section{The Messages Resource}
3531 \index[general]{Resource!Messages}
3532 \index[general]{Messages Resource}
3534 For the details of the Messages Resource, please see the
3535 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3538 \label{ConsoleResource1}
3539 \section{The Console Resource}
3540 \index[general]{Console Resource}
3541 \index[general]{Resource!Console}
3543 As of Bacula version 1.33 and higher, there are three different kinds of
3544 consoles, which the administrator or user can use to interact with the
3545 Director. These three kinds of consoles comprise three different security
3549 \item The first console type is an {\bf anonymous} or {\bf default} console,
3550 which has full privileges. There is no console resource necessary for
3551 this type since the password is specified in the Director's resource and
3552 consequently such consoles do not have a name as defined on a {\bf Name
3553 =} directive. This is the kind of console that was initially
3554 implemented in versions prior to 1.33 and remains valid. Typically you
3555 would use it only for administrators.
3557 \item The second type of console, and new to version 1.33 and higher is a
3558 ``named'' console defined within a Console resource in both the Director's
3559 configuration file and in the Console's configuration file. Both the
3560 names and the passwords in these two entries must match much as is the
3561 case for Client programs.
3563 This second type of console begins with absolutely no privileges except
3564 those explicitly specified in the Director's Console resource. Thus you
3565 can have multiple Consoles with different names and passwords, sort of
3566 like multiple users, each with different privileges. As a default,
3567 these consoles can do absolutely nothing -- no commands whatsoever. You
3568 give them privileges or rather access to commands and resources by
3569 specifying access control lists in the Director's Console resource. The
3570 ACLs are specified by a directive followed by a list of access names.
3571 Examples of this are shown below.
3573 \item The third type of console is similar to the above mentioned one in that
3574 it requires a Console resource definition in both the Director and the
3575 Console. In addition, if the console name, provided on the {\bf Name =}
3576 directive, is the same as a Client name, that console is permitted to
3577 use the {\bf SetIP} command to change the Address directive in the
3578 Director's client resource to the IP address of the Console. This
3579 permits portables or other machines using DHCP (non-fixed IP addresses)
3580 to ``notify'' the Director of their current IP address.
3583 The Console resource is optional and need not be specified. The following
3584 directives are permitted within the Director's configuration resource:
3588 \label{Console:Name}
3589 \item [Name = \lt{}name\gt{}]
3591 \index[dir]{Directive!Name}
3592 The name of the console. This name must match the name specified in the
3593 Console's configuration resource (much as is the case with Client
3596 \label{Console:Password}
3597 \item [Password = \lt{}password\gt{}]
3598 \index[dir]{Password}
3599 \index[dir]{Directive!Password}
3600 Specifies the password that must be supplied for a named Bacula Console
3601 to be authorized. The same password must appear in the {\bf Console}
3602 resource of the Console configuration file. For added security, the
3603 password is never actually passed across the network but rather a
3604 challenge response hash code created with the password. This directive
3605 is required. If you have either {\bf /dev/random} {\bf bc} on your
3606 machine, Bacula will generate a random password during the configuration
3607 process, otherwise it will be left blank.
3609 The password is plain text. It is not generated through any special
3610 process. However, it is preferable for security reasons to choose
3613 \label{Console:JobAcl}
3614 \item [JobACL = \lt{}name-list\gt{}]
3616 \index[dir]{Directive!JobACL}
3617 This directive is used to specify a list of Job resource names that can
3618 be accessed by the console. Without this directive, the console cannot
3619 access any of the Director's Job resources. Multiple Job resource names
3620 may be specified by separating them with commas, and/or by specifying
3621 multiple JobACL directives. For example, the directive may be specified
3626 JobACL = kernsave, "Backup client 1", "Backup client 2"
3627 JobACL = "RestoreFiles"
3632 With the above specification, the console can access the Director's resources
3633 for the four jobs named on the JobACL directives, but for no others.
3635 \label{Console:ClientAcl}
3636 \item [ClientACL = \lt{}name-list\gt{}]
3637 \index[dir]{ClientACL}
3638 \index[dir]{Directive!ClientACL}
3639 This directive is used to specify a list of Client resource names that can
3641 accessed by the console.
3643 \label{Console:StorageAcl}
3644 \item [StorageACL = \lt{}name-list\gt{}]
3645 \index[dir]{StorageACL}
3646 \index[dir]{Directive!StorageACL}
3647 This directive is used to specify a list of Storage resource names that can
3648 be accessed by the console.
3650 \label{Console:ScheduleAcl}
3651 \item [ScheduleACL = \lt{}name-list\gt{}]
3652 \index[dir]{ScheduleACL}
3653 \index[dir]{Directive!ScheduleACL}
3654 This directive is used to specify a list of Schedule resource names that can
3655 be accessed by the console.
3657 \label{Console:PoolAcl}
3658 \item [PoolACL = \lt{}name-list\gt{}]
3659 \index[dir]{PoolACL}
3660 \index[dir]{Directive!PoolACL}
3661 This directive is used to specify a list of Pool resource names that can be
3662 accessed by the console.
3664 \label{Console:FileSetAcl}
3665 \item [FileSetACL = \lt{}name-list\gt{}]
3666 \index[dir]{FileSetACL}
3667 \index[dir]{Directive!FileSetACL}
3668 This directive is used to specify a list of FileSet resource names that
3669 can be accessed by the console.
3671 \label{Console:CatalogAcl}
3672 \item [CatalogACL = \lt{}name-list\gt{}]
3673 \index[dir]{CatalogACL}
3674 \index[dir]{Directive!CatalogACL}
3675 This directive is used to specify a list of Catalog resource names that
3676 can be accessed by the console.
3678 \label{Console:CommandAcl}
3679 \item [CommandACL = \lt{}name-list\gt{}]
3680 \index[dir]{CommandACL}
3681 \index[dir]{Directive!CommandACL}
3682 This directive is used to specify a list of of console commands that can
3683 be executed by the console.
3685 \label{Console:WhereAcl}
3686 \item [WhereACL = \lt{}string\gt{}]
3687 \index[dir]{WhereACL}
3688 \index[dir]{Directive!WhereACL}
3689 This directive permits you to specify where a restricted console
3690 can restore files. If this directive is not specified, only the
3691 default restore location is permitted (normally {\bf
3692 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3693 user enters will be accepted (not very secure), any other
3694 value specified (there may be multiple WhereACL directives) will
3695 restrict the user to use that path. For example, on a Unix system,
3696 if you specify ``/'', the file will be restored to the original
3697 location. This directive is untested.
3701 Aside from Director resource names and console command names, the special
3702 keyword {\bf *all*} can be specified in any of the above access control lists.
3703 When this keyword is present, any resource or command name (which ever is
3704 appropriate) will be accepted. For an example configuration file, please see
3706 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3709 \label{CounterResource}
3710 \section{The Counter Resource}
3711 \index[general]{Resource!Counter}
3712 \index[general]{Counter Resource}
3714 The Counter Resource defines a counter variable that can be accessed by
3715 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3717 \ilink{LabelFormat}{Label} directive in this chapter for more
3723 \index[dir]{Counter}
3724 \index[dir]{Directive!Counter}
3725 Start of the Counter resource. Counter directives are optional.
3727 \label{Counter:Name}
3728 \item [Name = \lt{}name\gt{}]
3730 \index[dir]{Directive!Name}
3731 The name of the Counter. This is the name you will use in the variable
3732 expansion to reference the counter value.
3734 \label{Counter:Minimum}
3735 \item [Minimum = \lt{}integer\gt{}]
3736 \index[dir]{Minimum}
3737 \index[dir]{Directive!Minimum}
3738 This specifies the minimum value that the counter can have. It also becomes
3739 the default. If not supplied, zero is assumed.
3741 \label{Counter:Maximum}
3742 \item [Maximum = \lt{}integer\gt{}]
3743 \index[dir]{Maximum}
3744 \index[dir]{Directive!Maximum}
3745 \index[dir]{Directive!Maximum}
3746 This is the maximum value value that the counter can have. If not specified
3747 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3748 the 31 power). When the counter is incremented past this value, it is reset
3751 \label{Counter:*WrapCounter}
3752 \item [*WrapCounter = \lt{}counter-name\gt{}]
3753 \index[dir]{*WrapCounter}
3754 \index[dir]{Directive!*WrapCounter}
3755 If this value is specified, when the counter is incremented past the
3757 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3758 is incremented. (This is not currently implemented).
3760 \label{Counter:Catalog}
3761 \item [Catalog = \lt{}catalog-name\gt{}]
3762 \index[dir]{Catalog}
3763 \index[dir]{Directive!Catalog}
3764 If this directive is specified, the counter and its values will be saved in
3765 the specified catalog. If this directive is not present, the counter will be
3766 redefined each time that Bacula is started.
3769 \label{SampleDirectorConfiguration}
3770 \section{Example Director Configuration File}
3771 \index[general]{File!Example Director Configuration}
3772 \index[general]{Example Director Configuration File}
3774 An example Director configuration file might be the following:
3779 # Default Bacula Director Configuration file
3781 # The only thing that MUST be changed is to add one or more
3782 # file or directory names in the Include directive of the
3785 # For Bacula release 1.15 (5 March 2002) -- redhat
3787 # You might also want to change the default email address
3788 # from root to your address. See the "mail" and "operator"
3789 # directives in the Messages resource.
3791 Director { # define myself
3793 QueryFile = "/home/kern/bacula/bin/query.sql"
3794 WorkingDirectory = "/home/kern/bacula/bin/working"
3795 PidDirectory = "/home/kern/bacula/bin/working"
3796 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3798 # Define the backup Job
3800 Name = "NightlySave"
3802 Level = Incremental # default
3805 Schedule = "WeeklyCycle"
3815 Where = /tmp/bacula-restores
3821 # List of files to be backed up
3825 Options { signature=SHA1}
3827 # Put your list of files here, one per line or include an
3828 # external list with:
3832 # Note: / backs up everything
3837 # When to do the backups
3839 Name = "WeeklyCycle"
3840 Run = level=Full sun at 2:05
3841 Run = level=Incremental mon-sat at 2:05
3843 # Client (File Services) to backup
3848 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3849 File Retention = 60d # sixty day file retention
3850 Job Retention = 1y # 1 year Job retention
3851 AutoPrune = yes # Auto apply retention periods
3853 # Definition of DLT tape storage device
3857 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3858 Device = "HP DLT 80" # same as Device in Storage daemon
3859 Media Type = DLT8000 # same as MediaType in Storage daemon
3861 # Definition for a DLT autochanger device
3865 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3866 Device = "Autochanger" # same as Device in Storage daemon
3867 Media Type = DLT-8000 # Different from DLTDrive
3870 # Definition of DDS tape storage device
3874 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3875 Device = SDT-10000 # same as Device in Storage daemon
3876 Media Type = DDS-4 # same as MediaType in Storage daemon
3878 # Definition of 8mm tape storage device
3882 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3883 Device = "Exabyte 8mm"
3886 # Definition of file storage device
3890 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3891 Device = FileStorage
3894 # Generic catalog service
3897 dbname = bacula; user = bacula; password = ""
3899 # Reasonable message delivery -- send most everything to
3900 # the email address and to the console
3903 mail = root@localhost = all, !skipped, !terminate
3904 operator = root@localhost = mount
3905 console = all, !skipped, !saved
3908 # Default pool definition
3916 # Restricted console used by tray-monitor to get the status of the director
3920 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3921 CommandACL = status, .status