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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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.
465 \label{Director:Job:Name}
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.
479 \label{Director:Job:Enabled}
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.
486 \label{Director:Job:Type}
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.
536 \label{Director:Job:Level}
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
776 \label{Director:Job:Accurate}
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{Director: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
810 \label{Director:Job:JobDefs}
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{Director: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{Director: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.
887 \label{Director:Job:Client}
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.
899 \label{Director:Job:Fileset}
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.
910 \label{Director:Job:Base}
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.
918 \label{Director:Job:Messages}
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.
929 \label{Director:Job:Pool}
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{Director: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{Director: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{Director: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.
964 \label{Director:Job:Schedule}
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.
982 \label{Director:Job:Storage}
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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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{Director: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.
1255 \label{Director:Job:End}
1257 You can use these following shortcuts:\\
1259 \LTXtable{0.95\linewidth}{table_runscriptshortcuts}
1265 Command = "/etc/init.d/apache stop"
1271 Command = "/etc/init.d/apache start"
1275 {\bf Notes about ClientRunBeforeJob}
1277 For compatibility reasons, with this shortcut, the command is executed
1278 directly when the client recieve it. And if the command is in error, other
1279 remote runscripts will be discarded. To be sure that all commands will be
1280 sent and executed, you have to use RunScript syntax.
1282 {\bf Special Windows Considerations}
1284 You can run scripts just after snapshots initializations with
1285 \textsl{AfterVSS} keyword.
1287 In addition, for a Windows client, please take
1288 note that you must ensure a correct path to your script. The script or
1289 program can be a .com, .exe or a .bat file. If you just put the program
1290 name in then Bacula will search using the same rules that cmd.exe uses
1291 (current directory, Bacula bin directory, and PATH). It will even try the
1292 different extensions in the same order as cmd.exe.
1293 The command can be anything that cmd.exe or command.com will recognize
1294 as an executable file.
1296 However, if you have slashes in the program name then Bacula figures you
1297 are fully specifying the name, so you must also explicitly add the three
1298 character extension.
1300 The command is run in a Win32 environment, so Unix like commands will not
1301 work unless you have installed and properly configured Cygwin in addition
1302 to and separately from Bacula.
1304 The System \%Path\% will be searched for the command. (under the
1305 environment variable dialog you have have both System Environment and
1306 User Environment, we believe that only the System environment will be
1307 available to bacula-fd, if it is running as a service.)
1309 System environment variables can be referenced with \%var\% and
1310 used as either part of the command name or arguments.
1312 So if you have a script in the Bacula\\bin directory then the following lines
1317 Client Run Before Job = systemstate
1319 Client Run Before Job = systemstate.bat
1321 Client Run Before Job = "systemstate"
1323 Client Run Before Job = "systemstate.bat"
1325 ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1329 The outer set of quotes is removed when the configuration file is parsed.
1330 You need to escape the inner quotes so that they are there when the code
1331 that parses the command line for execution runs so it can tell what the
1337 ClientRunBeforeJob = "\"C:/Program Files/Software
1338 Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1342 The special characters
1346 will need to be quoted,
1347 if they are part of a filename or argument.
1349 If someone is logged in, a blank ``command'' window running the commands
1350 will be present during the execution of the command.
1352 Some Suggestions from Phil Stracchino for running on Win32 machines with
1353 the native Win32 File daemon:
1356 \item You might want the ClientRunBeforeJob directive to specify a .bat
1357 file which runs the actual client-side commands, rather than trying
1358 to run (for example) regedit /e directly.
1359 \item The batch file should explicitly 'exit 0' on successful completion.
1360 \item The path to the batch file should be specified in Unix form:
1362 ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1364 rather than DOS/Windows form:
1366 ClientRunBeforeJob =
1368 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1372 For Win32, please note that there are certain limitations:
1374 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1376 Lines like the above do not work because there are limitations of
1377 cmd.exe that is used to execute the command.
1378 Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
1379 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1380 cmd prompt and see what happens. Once the command is correct insert a
1381 backslash (\textbackslash{}) before each double quote ("), and
1382 then put quotes around the whole thing when putting it in
1383 the director's .conf file. You either need to have only one set of quotes
1384 or else use the short name and don't put quotes around the command path.
1386 Below is the output from cmd's help as it relates to the command line
1387 passed to the /c option.
1390 If /C or /K is specified, then the remainder of the command line after
1391 the switch is processed as a command line, where the following logic is
1392 used to process quote (") characters:
1396 If all of the following conditions are met, then quote characters
1397 on the command line are preserved:
1400 \item exactly two quote characters.
1401 \item no special characters between the two quote characters,
1402 where special is one of:
1406 \item there are one or more whitespace characters between the
1407 the two quote characters.
1408 \item the string between the two quote characters is the name
1409 of an executable file.
1412 \item Otherwise, old behavior is to see if the first character is
1413 a quote character and if so, strip the leading character and
1414 remove the last quote character on the command line, preserving
1415 any text after the last quote character.
1420 The following example of the use of the Client Run Before Job directive was
1421 submitted by a user:\\
1422 You could write a shell script to back up a DB2 database to a FIFO. The shell
1432 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1437 The following line in the Job resource in the bacula-dir.conf file:
1440 Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1445 When the job is run, you will get messages from the output of the script
1446 stating that the backup has started. Even though the command being run is
1447 backgrounded with \&, the job will block until the ``db2 BACKUP DATABASE''
1448 command, thus the backup stalls.
1450 To remedy this situation, the ``db2 BACKUP DATABASE'' line should be changed to
1455 db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1460 It is important to redirect the input and outputs of a backgrounded command to
1461 /dev/null to prevent the script from blocking.
1463 \label{Director:Job:RunBeforeJob}
1464 \item [Run Before Job = \lt{}command\gt{}]
1465 \index[dir]{Run Before Job}
1466 \index[dir]{Directive!Run Before Job}
1467 \index[dir]{Directive!Run Before Job}
1468 The specified {\bf command} is run as an external program prior to running the
1469 current Job. This directive is not required, but if it is defined, and if the
1470 exit code of the program run is non-zero, the current Bacula job will be
1474 Run Before Job = "echo test"
1476 it's equivalent to :
1479 Command = "echo test"
1485 Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1486 simple way to modify your schedules during a holiday. For example, suppose
1487 that you normally do Full backups on Fridays, but Thursday and Friday are
1488 holidays. To avoid having to change tapes between Thursday and Friday when
1489 no one is in the office, you can create a RunBeforeJob that returns a
1490 non-zero status on Thursday and zero on all other days. That way, the
1491 Thursday job will not run, and on Friday the tape you inserted on Wednesday
1492 before leaving will be used.
1494 \label{Director:Job:RunAfterJob}
1495 \item [Run After Job = \lt{}command\gt{}]
1496 \index[dir]{Run After Job}
1497 \index[dir]{Directive!Run After Job}
1498 The specified {\bf command} is run as an external program if the current
1499 job terminates normally (without error or without being canceled). This
1500 directive is not required. If the exit code of the program run is
1501 non-zero, Bacula will print a warning message. Before submitting the
1502 specified command to the operating system, Bacula performs character
1503 substitution as described above for the {\bf RunScript} directive.
1505 An example of the use of this directive is given in the
1506 \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1508 See the {\bf Run After Failed Job} if you
1509 want to run a script after the job has terminated with any
1512 \label{Director:Job:RunAfterJob}
1513 \item [Run After Failed Job = \lt{}command\gt{}]
1514 \index[dir]{Run After Job}
1515 \index[dir]{Directive!Run After Job}
1516 The specified {\bf command} is run as an external program after the current
1517 job terminates with any error status. This directive is not required. The
1518 command string must be a valid program name or name of a shell script. If
1519 the exit code of the program run is non-zero, Bacula will print a
1520 warning message. Before submitting the specified command to the
1521 operating system, Bacula performs character substitution as described above
1522 for the {\bf RunScript} directive. Note, if you wish that your script
1523 will run regardless of the exit status of the Job, you can use this :
1526 Command = "echo test"
1530 RunsOnSuccess = yes # default, you can drop this line
1534 An example of the use of this directive is given in the
1535 \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1538 \label{Director:Job:ClientRunBeforeJob}
1539 \item [Client Run Before Job = \lt{}command\gt{}]
1540 \index[dir]{Client Run Before Job}
1541 \index[dir]{Directive!Client Run Before Job}
1542 This directive is the same as {\bf Run Before Job} except that the
1543 program is run on the client machine. The same restrictions apply to
1544 Unix systems as noted above for the {\bf RunScript}.
1546 \label{Director:Job:ClientRunAfterJob}
1547 \item [Client Run After Job = \lt{}command\gt{}]
1548 \index[dir]{Client Run After Job}
1549 \index[dir]{Directive!Client Run After Job}
1550 The specified {\bf command} is run on the client machine as soon
1551 as data spooling is complete in order to allow restarting applications
1552 on the client as soon as possible. .
1554 Note, please see the notes above in {\bf RunScript}
1555 concerning Windows clients.
1557 \label{Director:Job:RerunFailedLevels}
1558 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1559 \index[dir]{Rerun Failed Levels}
1560 \index[dir]{Directive!Rerun Failed Levels}
1561 If this directive is set to {\bf yes} (default no), and Bacula detects that
1562 a previous job at a higher level (i.e. Full or Differential) has failed,
1563 the current job level will be upgraded to the higher level. This is
1564 particularly useful for Laptops where they may often be unreachable, and if
1565 a prior Full save has failed, you wish the very next backup to be a Full
1566 save rather than whatever level it is started as.
1568 There are several points that must be taken into account when using this
1569 directive: first, a failed job is defined as one that has not terminated
1570 normally, which includes any running job of the same name (you need to
1571 ensure that two jobs of the same name do not run simultaneously);
1572 secondly, the {\bf Ignore FileSet Changes} directive is not considered
1573 when checking for failed levels, which means that any FileSet change will
1576 \label{Director:Job:SpoolData}
1577 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1578 \index[dir]{Spool Data}
1579 \index[dir]{Directive!Spool Data}
1581 If this directive is set to {\bf yes} (default no), the Storage daemon will
1582 be requested to spool the data for this Job to disk rather than write it
1583 directly to the Volume (normally a tape).
1585 Thus the data is written in large blocks to the Volume rather than small
1586 blocks. This directive is particularly useful when running multiple
1587 simultaneous backups to tape. Once all the data arrives or the spool
1588 files' maximum sizes are reached, the data will be despooled and written
1591 Spooling data prevents interleaving date from several job and reduces or
1592 eliminates tape drive stop and start commonly known as ``shoe-shine''.
1594 We don't recommend using this option if you are writing to a disk file
1595 using this option will probably just slow down the backup jobs.
1597 NOTE: When this directive is set to yes, Spool Attributes is also
1598 automatically set to yes.
1600 \label{Director:Job:SpoolData}
1601 \item [SpoolData=yes\vb{}no]
1602 \index[dir]{SpoolData}
1603 \index[dir]{Directive!SpoolData}
1604 tells Bacula to request the Storage daemon to spool data to a disk file
1605 before writing it to the Volume (normally a tape).
1607 \label{Director:Job:SpoolAttributes}
1608 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1609 \index[dir]{Spool Attributes}
1610 \index[dir]{Directive!Spool Attributes}
1612 \index[general]{slow}
1613 \index[dir]{Backups!slow}
1614 \index[general]{Backups!slow}
1615 The default is set to {\bf no}, which means that the File attributes are
1616 sent by the Storage daemon to the Director as they are stored on tape.
1617 However, if you want to avoid the possibility that database updates will
1618 slow down writing to the tape, you may want to set the value to {\bf
1619 yes}, in which case the Storage daemon will buffer the File attributes
1620 and Storage coordinates to a temporary file in the Working Directory,
1621 then when writing the Job data to the tape is completed, the attributes
1622 and storage coordinates will be sent to the Director.
1624 NOTE: When Spool Data is set to yes, Spool Attributes is also
1625 automatically set to yes.
1627 \label{Director:Job:SpoolSize}
1628 \item [SpoolSize={\it bytes}]
1629 \index[dir]{SpoolSize}
1630 \index[dir]{Directive!SpoolSize}
1631 where the bytes specify the maximum spool size for this job.
1632 The default is take from Device Maximum Spool Size limit.
1633 This directive is available only in Bacula version 2.3.5 or
1637 \label{Director:Job:Where}
1638 \item [Where = \lt{}directory\gt{}]
1640 \index[dir]{Directive!Where}
1641 This directive applies only to a Restore job and specifies a prefix to
1642 the directory name of all files being restored. This permits files to
1643 be restored in a different location from which they were saved. If {\bf
1644 Where} is not specified or is set to backslash ({\bf /}), the files will
1645 be restored to their original location. By default, we have set {\bf
1646 Where} in the example configuration files to be {\bf
1647 /tmp/bacula-restores}. This is to prevent accidental overwriting of
1650 \label{confaddprefix}
1651 \label{Director:Job:AddPrefix}
1652 \item [Add Prefix = \lt{}directory\gt{}]
1653 \index[dir]{AddPrefix}
1654 \index[dir]{Directive!AddPrefix}
1655 This directive applies only to a Restore job and specifies a prefix to the
1656 directory name of all files being restored. This will use \ilink{File
1657 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1659 \label{Director:Job:AddSuffix}
1660 \item [Add Suffix = \lt{}extention\gt{}]
1661 \index[dir]{AddSuffix}
1662 \index[dir]{Directive!AddSuffix}
1663 This directive applies only to a Restore job and specifies a suffix to all
1664 files being restored. This will use \ilink{File Relocation}{filerelocation}
1665 feature implemented in Bacula 2.1.8 or later.
1667 Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1668 \texttt{/etc/passwsd.old}
1670 \label{Director:Job:StripPrefix}
1671 \item [Strip Prefix = \lt{}directory\gt{}]
1672 \index[dir]{StripPrefix}
1673 \index[dir]{Directive!StripPrefix}
1674 This directive applies only to a Restore job and specifies a prefix to remove
1675 from the directory name of all files being restored. This will use the
1676 \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1679 Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1682 Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1690 \label{Director:Job:RegexWhere}
1691 \item [RegexWhere = \lt{}expressions\gt{}]
1692 \index[dir]{RegexWhere}
1693 \index[dir]{Directive!RegexWhere}
1694 This directive applies only to a Restore job and specifies a regex filename
1695 manipulation of all files being restored. This will use \ilink{File
1696 Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1698 For more informations about how use this option, see
1699 \ilink{this}{useregexwhere}.
1701 \label{Director:Job:Replace}
1702 \item [Replace = \lt{}replace-option\gt{}]
1703 \index[dir]{Replace}
1704 \index[dir]{Directive!Replace}
1705 This directive applies only to a Restore job and specifies what happens
1706 when Bacula wants to restore a file or directory that already exists.
1707 You have the following options for {\bf replace-option}:
1713 when the file to be restored already exists, it is deleted and then
1714 replaced by the copy that was backed up. This is the default value.
1717 \index[dir]{ifnewer}
1718 if the backed up file (on tape) is newer than the existing file, the
1719 existing file is deleted and replaced by the back up.
1722 \index[dir]{ifolder}
1723 if the backed up file (on tape) is older than the existing file, the
1724 existing file is deleted and replaced by the back up.
1728 if the backed up file already exists, Bacula skips restoring this file.
1731 \label{Director:Job:PrefixLinks}
1732 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1733 \index[dir]{Prefix Links}
1734 \index[dir]{Directive!Prefix Links}
1735 If a {\bf Where} path prefix is specified for a recovery job, apply it
1736 to absolute links as well. The default is {\bf No}. When set to {\bf
1737 Yes} then while restoring files to an alternate directory, any absolute
1738 soft links will also be modified to point to the new alternate
1739 directory. Normally this is what is desired -- i.e. everything is self
1740 consistent. However, if you wish to later move the files to their
1741 original locations, all files linked with absolute names will be broken.
1743 \label{Director:Job:MaximumConcurrentJobs}
1744 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1745 \index[dir]{Maximum Concurrent Jobs}
1746 \index[dir]{Directive!Maximum Concurrent Jobs}
1747 where \lt{}number\gt{} is the maximum number of Jobs from the current
1748 Job resource that can run concurrently. Note, this directive limits
1749 only Jobs with the same name as the resource in which it appears. Any
1750 other restrictions on the maximum concurrent jobs such as in the
1751 Director, Client, or Storage resources will also apply in addition to
1752 the limit specified here. The default is set to 1, but you may set it
1753 to a larger number. We strongly recommend that you read the WARNING
1754 documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1755 Director's resource.
1757 \label{Director:Job:RescheduleOnError}
1758 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1759 \index[dir]{Reschedule On Error}
1760 \index[dir]{Directive!Reschedule On Error}
1761 If this directive is enabled, and the job terminates in error, the job
1762 will be rescheduled as determined by the {\bf Reschedule Interval} and
1763 {\bf Reschedule Times} directives. If you cancel the job, it will not
1764 be rescheduled. The default is {\bf no} (i.e. the job will not be
1767 This specification can be useful for portables, laptops, or other
1768 machines that are not always connected to the network or switched on.
1770 \label{Director:Job:RescheduleInterval}
1771 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1772 \index[dir]{Reschedule Interval}
1773 \index[dir]{Directive!Reschedule Interval}
1774 If you have specified {\bf Reschedule On Error = yes} and the job
1775 terminates in error, it will be rescheduled after the interval of time
1776 specified by {\bf time-specification}. See \ilink{the time
1777 specification formats}{Time} in the Configure chapter for details of
1778 time specifications. If no interval is specified, the job will not be
1779 rescheduled on error.
1781 \label{Director:Job:RescheduleTimes}
1782 \item [Reschedule Times = \lt{}count\gt{}]
1783 \index[dir]{Reschedule Times}
1784 \index[dir]{Directive!Reschedule Times}
1785 This directive specifies the maximum number of times to reschedule the
1786 job. If it is set to zero (the default) the job will be rescheduled an
1787 indefinite number of times.
1789 \label{Director:Job:AllowDuplicateJobs}
1790 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1791 \index[general]{Allow Duplicate Jobs}
1793 %\begin{figure}[htbp]
1795 % \includegraphics[width=13cm]{\idir duplicate-real}
1796 % \label{fig:allowduplicatejobs}
1797 % \caption{Allow Duplicate Jobs usage}
1799 \bsysimageH{duplicate-real}{Allow Duplicate Jobs usage}{fig:allowduplicatejobs}
1801 A duplicate job in the sense we use it here means a second or subsequent job
1802 with the same name starts. This happens most frequently when the first job
1803 runs longer than expected because no tapes are available.
1805 If this directive is enabled duplicate jobs will be run. If
1806 the directive is set to {\bf no} (default) then only one job of a given name
1807 may run at one time, and the action that Bacula takes to ensure only
1808 one job runs is determined by the other directives (see below).
1810 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1811 are present and none of the three directives given below permit
1812 cancelling a job, then the current job (the second one started)
1815 \label{Job:AllowHigherDuplicates}
1816 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1817 \index[general]{Allow Higher Duplicates}
1818 This directive was implemented in version 5.0.0, but does not work
1819 as expected. If used, it should always be set to no. In later versions
1820 of Bacula the directive is disabled (disregarded).
1823 \label{Director:Job:CancelLowerLevelDuplicates}
1824 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1825 \index[general]{Cancel Lower Level Duplicates}
1826 If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
1827 directive is set to \textbf{yes}, Bacula will choose between duplicated
1828 jobs the one with the highest level. For example, it will cancel a
1829 previous Incremental to run a Full backup. It works only for Backup
1830 jobs. The default is \texttt{no}. If the levels of the duplicated
1831 jobs are the same, nothing is done and the other
1832 Cancel XXX Duplicate directives will be examined.
1834 \label{Director:Job:CancelQueuedDuplicates}
1835 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1836 \index[general]{Cancel Queued Duplicates}
1837 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1838 if this directive is set to {\bf yes} any job that is
1839 already queued to run but not yet running will be canceled.
1840 The default is {\bf no}.
1842 \label{Director:Job:CancelRunningDuplicates}
1843 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1844 \index[general]{Cancel Running Duplicates}
1845 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1846 if this directive is set to {\bf yes} any job that is already running
1847 will be canceled. The default is {\bf no}.
1850 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1851 %%\index[general]{Duplicate Job Proximity}
1852 %% This directive permits to determine if two jobs are really duplicated.
1853 %% If the first one is running for long time, this is probably not a good
1854 %% idea to cancel it.
1856 \label{Director:Job:Run}
1857 \item [Run = \lt{}job-name\gt{}]
1859 \index[dir]{Directive!Run}
1860 \index[dir]{Clone a Job}
1861 The Run directive (not to be confused with the Run option in a
1862 Schedule) allows you to start other jobs or to clone jobs. By using the
1863 cloning keywords (see below), you can backup
1864 the same data (or almost the same data) to two or more drives
1865 at the same time. The {\bf job-name} is normally the same name
1866 as the current Job resource (thus creating a clone). However, it
1867 may be any Job name, so one job may start other related jobs.
1869 The part after the equal sign must be enclosed in double quotes,
1870 and can contain any string or set of options (overrides) that you
1871 can specify when entering the Run command from the console. For
1872 example {\bf storage=DDS-4 \ldots{}}. In addition, there are two special
1873 keywords that permit you to clone the current job. They are {\bf level=\%l}
1874 and {\bf since=\%s}. The \%l in the level keyword permits
1875 entering the actual level of the current job and the \%s in the since
1876 keyword permits putting the same time for comparison as used on the
1877 current job. Note, in the case of the since keyword, the \%s must be
1878 enclosed in double quotes, and thus they must be preceded by a backslash
1879 since they are already inside quotes. For example:
1882 run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1885 A cloned job will not start additional clones, so it is not
1886 possible to recurse.
1888 Please note that all cloned jobs, as specified in the Run directives are
1889 submitted for running before the original job is run (while it is being
1890 initialized). This means that any clone job will actually start before
1891 the original job, and may even block the original job from starting
1892 until the original job finishes unless you allow multiple simultaneous
1893 jobs. Even if you set a lower priority on the clone job, if no other
1894 jobs are running, it will start before the original job.
1896 If you are trying to prioritize jobs by using the clone feature (Run
1897 directive), you will find it much easier to do using a RunScript
1898 resource, or a RunBeforeJob directive.
1901 \label{Director:Job:Priority}
1902 \item [Priority = \lt{}number\gt{}]
1903 \index[dir]{Priority}
1904 \index[dir]{Directive!Priority}
1905 This directive permits you to control the order in which your jobs will
1906 be run by specifying a positive non-zero number. The higher the number,
1907 the lower the job priority. Assuming you are not running concurrent jobs,
1908 all queued jobs of priority 1 will run before queued jobs of priority 2
1909 and so on, regardless of the original scheduling order.
1911 The priority only affects waiting jobs that are queued to run, not jobs
1912 that are already running. If one or more jobs of priority 2 are already
1913 running, and a new job is scheduled with priority 1, the currently
1914 running priority 2 jobs must complete before the priority 1 job is
1915 run, unless Allow Mixed Priority is set.
1917 The default priority is 10.
1919 If you want to run concurrent jobs you should
1920 keep these points in mind:
1923 \item See \bsysxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup
1924 concurrent jobs in the \problemsman{}.
1926 \item Bacula concurrently runs jobs of only one priority at a time. It
1927 will not simultaneously run a priority 1 and a priority 2 job.
1929 \item If Bacula is running a priority 2 job and a new priority 1 job is
1930 scheduled, it will wait until the running priority 2 job terminates even
1931 if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1932 to run simultaneously.
1934 \item Suppose that bacula is running a priority 2 job and a new priority 1
1935 job is scheduled and queued waiting for the running priority 2 job to
1936 terminate. If you then start a second priority 2 job, the waiting
1937 priority 1 job will prevent the new priority 2 job from running
1938 concurrently with the running priority 2 job. That is: as long as there
1939 is a higher priority job waiting to run, no new lower priority jobs will
1940 start even if the Maximum Concurrent Jobs settings would normally allow
1941 them to run. This ensures that higher priority jobs will be run as soon
1945 If you have several jobs of different priority, it may not best to start
1946 them at exactly the same time, because Bacula must examine them one at a
1947 time. If by Bacula starts a lower priority job first, then it will run
1948 before your high priority jobs. If you experience this problem, you may
1949 avoid it by starting any higher priority jobs a few seconds before lower
1950 priority ones. This insures that Bacula will examine the jobs in the
1951 correct order, and that your priority scheme will be respected.
1952 \label{AllowMixedPriority}
1954 \label{Director:Job:AllowMixedPriority}
1955 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1956 \index[dir]{Allow Mixed Priority}
1957 This directive is only implemented in version 2.5 and later. When
1958 set to {\bf yes} (default {\bf no}), this job may run even if lower
1959 priority jobs are already running. This means a high priority job
1960 will not have to wait for other jobs to finish before starting.
1961 The scheduler will only mix priorities when all running jobs have
1964 Note that only higher priority jobs will start early. Suppose the
1965 director will allow two concurrent jobs, and that two jobs with
1966 priority 10 are running, with two more in the queue. If a job with
1967 priority 5 is added to the queue, it will be run as soon as one of
1968 the running jobs finishes. However, new priority 10 jobs will not
1969 be run until the priority 5 job has finished.
1970 \label{WritePartAfterJob}
1972 \label{Director:Job:WritePartAfterJob}
1973 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1974 \index[dir]{Write Part After Job}
1975 \index[dir]{Directive!Write Part After Job}
1976 This directive is only implemented in version 1.37 and later.
1977 If this directive is set to {\bf yes} (default {\bf no}), a new part file
1978 will be created after the job is finished.
1980 It should be set to {\bf yes} when writing to devices that require mount
1981 (for example DVD), so you are sure that the current part, containing
1982 this job's data, is written to the device, and that no data is left in
1983 the temporary file on the hard disk. However, on some media, like DVD+R
1984 and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1985 written. So, if you run several jobs each after another, you could set
1986 this directive to {\bf no} for all jobs, except the last one, to avoid
1987 wasting too much space, but to ensure that the data is written to the
1988 medium when all jobs are finished.
1990 This directive is ignored with tape and FIFO devices.
1994 The following is an example of a valid Job resource definition:
2001 Level = Incremental # default
2003 FileSet="Minou Full Set"
2006 Schedule = "MinouWeeklyCycle"
2012 \label{JobDefsResource}
2013 \section{The JobDefs Resource}
2014 \index[general]{JobDefs Resource}
2015 \index[general]{Resource!JobDefs}
2017 The JobDefs resource permits all the same directives that can appear in a Job
2018 resource. However, a JobDefs resource does not create a Job, rather it can be
2019 referenced within a Job to provide defaults for that Job. This permits you to
2020 concisely define several nearly identical Jobs, each one referencing a JobDefs
2021 resource which contains the defaults. Only the changes from the defaults need to
2022 be mentioned in each Job.
2024 \label{ScheduleResource}
2025 \section{The Schedule Resource}
2026 \index[general]{Resource!Schedule}
2027 \index[general]{Schedule Resource}
2029 The Schedule resource provides a means of automatically scheduling a Job as
2030 well as the ability to override the default Level, Pool, Storage and Messages
2031 resources. If a Schedule resource is not referenced in a Job, the Job can only
2032 be run manually. In general, you specify an action to be taken and when.
2037 \index[dir]{Schedule}
2038 \index[dir]{Directive!Schedule}
2039 Start of the Schedule directives. No {\bf Schedule} resource is
2040 required, but you will need at least one if you want Jobs to be
2041 automatically started.
2043 \label{Director:Schedule:Name}
2044 \item [Name = \lt{}name\gt{}]
2046 \index[dir]{Directive!Name}
2047 The name of the schedule being defined. The Name directive is required.
2049 \label{Director:Schedule:Run}
2050 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
2052 \index[dir]{Directive!Run}
2053 The Run directive defines when a Job is to be run, and what overrides if
2054 any to apply. You may specify multiple {\bf run} directives within a
2055 {\bf Schedule} resource. If you do, they will all be applied (i.e.
2056 multiple schedules). If you have two {\bf Run} directives that start at
2057 the same time, two Jobs will start at the same time (well, within one
2058 second of each other).
2060 The {\bf Job-overrides} permit overriding the Level, the Storage, the
2061 Messages, and the Pool specifications provided in the Job resource. In
2062 addition, the FullPool, the IncrementalPool, and the DifferentialPool
2063 specifications permit overriding the Pool specification according to
2064 what backup Job Level is in effect.
2066 By the use of overrides, you may customize a particular Job. For
2067 example, you may specify a Messages override for your Incremental
2068 backups that outputs messages to a log file, but for your weekly or
2069 monthly Full backups, you may send the output by email by using a
2070 different Messages override.
2072 {\bf Job-overrides} are specified as: {\bf keyword=value} where the
2073 keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
2074 or IncrementalPool, and the {\bf value} is as defined on the respective
2075 directive formats for the Job resource. You may specify multiple {\bf
2076 Job-overrides} on one {\bf Run} directive by separating them with one or
2077 more spaces or by separating them with a trailing comma. For example:
2079 \label{Director:Schedule:End}
2084 \index[dir]{Directive!Level}
2085 is all files in the FileSet whether or not they have changed.
2087 \item [Level=Incremental]
2089 \index[dir]{Directive!Level}
2090 is all files that have changed since the last backup.
2094 \index[dir]{Directive!Pool}
2095 specifies to use the Pool named {\bf Weekly}.
2097 \item [Storage=DLT\_Drive]
2098 \index[dir]{Storage}
2099 \index[dir]{Directive!Storage}
2100 specifies to use {\bf DLT\_Drive} for the storage device.
2102 \item [Messages=Verbose]
2103 \index[dir]{Messages}
2104 \index[dir]{Directive!Messages}
2105 specifies to use the {\bf Verbose} message resource for the Job.
2107 \item [FullPool=Full]
2108 \index[dir]{FullPool}
2109 \index[dir]{Directive!FullPool}
2110 specifies to use the Pool named {\bf Full} if the job is a full backup, or
2112 upgraded from another type to a full backup.
2114 \item [DifferentialPool=Differential]
2115 \index[dir]{DifferentialPool}
2116 \index[dir]{Directive!DifferentialPool}
2117 specifies to use the Pool named {\bf Differential} if the job is a
2118 differential backup.
2120 \item [IncrementalPool=Incremental]
2121 \index[dir]{IncrementalPool}
2122 \index[dir]{Directive!IncrementalPool}
2123 specifies to use the Pool named {\bf Incremental} if the job is an
2127 \item [WritePartAfterJob=yes\vb{}no]
2128 \index[dir]{WritePartAfterJob}
2129 \index[dir]{Directive!WritePartAfterJob}
2130 tells Bacula to request the Storage daemon to write the current part
2131 file to the device when the job is finished (see \ilink{Write Part After
2132 Job directive in the Job resource}{WritePartAfterJob}). Please note,
2133 this directive is implemented only in version 1.37 and later. The
2134 default is yes. We strongly recommend that you keep this set to yes
2135 otherwise, when the last job has finished one part will remain in the
2136 spool file and restore may or may not work.
2140 {\bf Date-time-specification} determines when the Job is to be run. The
2141 specification is a repetition, and as a default Bacula is set to run a job at
2142 the beginning of the hour of every hour of every day of every week of every
2143 month of every year. This is not normally what you want, so you must specify
2144 or limit when you want the job to run. Any specification given is assumed to
2145 be repetitive in nature and will serve to override or limit the default
2146 repetition. This is done by specifying masks or times for the hour, day of the
2147 month, day of the week, week of the month, week of the year, and month when
2148 you want the job to run. By specifying one or more of the above, you can
2149 define a schedule to repeat at almost any frequency you want.
2151 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
2152 minute} the Job is to be run. Of these four items to be specified, {\bf day}
2153 is special in that you may either specify a day of the month such as 1, 2,
2154 \ldots{} 31, or you may specify a day of the week such as Monday, Tuesday, \ldots{}
2155 Sunday. Finally, you may also specify a week qualifier to restrict the
2156 schedule to the first, second, third, fourth, or fifth week of the month.
2158 For example, if you specify only a day of the week, such as {\bf Tuesday} the
2159 Job will be run every hour of every Tuesday of every Month. That is the {\bf
2160 month} and {\bf hour} remain set to the defaults of every month and all
2163 Note, by default with no other specification, your job will run at the
2164 beginning of every hour. If you wish your job to run more than once in any
2165 given hour, you will need to specify multiple {\bf run} specifications each
2166 with a different minute.
2168 The date/time to run the Job can be specified in the following way in
2175 <week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
2176 second | third | fourth | fifth
2177 <wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
2178 sunday | monday | tuesday | wednesday |
2179 thursday | friday | saturday
2180 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2181 <month-keyword> = jan | feb | mar | apr | may | jun | jul |
2182 aug | sep | oct | nov | dec | january |
2183 february | ... | december
2184 <daily-keyword> = daily
2185 <weekly-keyword> = weekly
2186 <monthly-keyword> = monthly
2187 <hourly-keyword> = hourly
2188 <digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2189 <number> = <digit> | <digit><number>
2190 <12hour> = 0 | 1 | 2 | ... 12
2191 <hour> = 0 | 1 | 2 | ... 23
2192 <minute> = 0 | 1 | 2 | ... 59
2193 <day> = 1 | 2 | ... 31
2194 <time> = <hour>:<minute> |
2195 <12hour>:<minute>am |
2197 <time-spec> = <at-keyword> <time> |
2199 <date-keyword> = <void-keyword> <weekly-keyword>
2200 <day-range> = <day>-<day>
2201 <month-range> = <month-keyword>-<month-keyword>
2202 <wday-range> = <wday-keyword>-<wday-keyword>
2203 <range> = <day-range> | <month-range> |
2205 <date> = <date-keyword> | <day> | <range>
2206 <date-spec> = <date> | <date-spec>
2207 <day-spec> = <day> | <wday-keyword> |
2208 <day> | <wday-range> |
2209 <week-keyword> <wday-keyword> |
2210 <week-keyword> <wday-range> |
2212 <month-spec> = <month-keyword> | <month-range> |
2214 <date-time-spec> = <month-spec> <day-spec> <time-spec>
2220 Note, the Week of Year specification wnn follows the ISO standard definition
2221 of the week of the year, where Week 1 is the week in which the first Thursday
2222 of the year occurs, or alternatively, the week which contains the 4th of
2223 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2224 precedes the first ISO week (i.e. has the first few days of the year if any
2225 occur before Thursday). w00 is not defined by the ISO specification. A week
2226 starts with Monday and ends with Sunday.
2228 According to the NIST (US National Institute of Standards and Technology),
2229 12am and 12pm are ambiguous and can be defined to anything. However,
2230 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2231 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
2232 this abiguity (confusion) by using 24 hour time specifications (i.e. no
2233 am/pm). This is the definition in Bacula version 2.0.3 and later.
2235 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2236 with level full each Sunday at 2:05am and an incremental job Monday through
2237 Saturday at 2:05am is:
2242 Name = "WeeklyCycle"
2243 Run = Level=Full sun at 2:05
2244 Run = Level=Incremental mon-sat at 2:05
2249 An example of a possible monthly cycle is as follows:
2254 Name = "MonthlyCycle"
2255 Run = Level=Full Pool=Monthly 1st sun at 2:05
2256 Run = Level=Differential 2nd-5th sun at 2:05
2257 Run = Level=Incremental Pool=Daily mon-sat at 2:05
2262 The first of every month:
2268 Run = Level=Full on 1 at 2:05
2269 Run = Level=Incremental on 2-31 at 2:05
2280 Run = Level=Full hourly at 0:05
2281 Run = Level=Full hourly at 0:15
2282 Run = Level=Full hourly at 0:25
2283 Run = Level=Full hourly at 0:35
2284 Run = Level=Full hourly at 0:45
2285 Run = Level=Full hourly at 0:55
2290 \section{Technical Notes on Schedules}
2291 \index[general]{Schedules!Technical Notes on}
2292 \index[general]{Technical Notes on Schedules}
2294 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2295 minute field to each schedule. The masks are hour, day of the month (mday),
2296 month, day of the week (wday), week of the month (wom), and week of the year
2297 (woy). The schedule is initialized to have the bits of each of these masks
2298 set, which means that at the beginning of every hour, the job will run. When
2299 you specify a month for the first time, the mask will be cleared and the bit
2300 corresponding to your selected month will be selected. If you specify a second
2301 month, the bit corresponding to it will also be added to the mask. Thus when
2302 Bacula checks the masks to see if the bits are set corresponding to the
2303 current time, your job will run only in the two months you have set. Likewise,
2304 if you set a time (hour), the hour mask will be cleared, and the hour you
2305 specify will be set in the bit mask and the minutes will be stored in the
2308 For any schedule you have defined, you can see how these bits are set by doing
2309 a {\bf show schedules} command in the Console program. Please note that the
2310 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2315 \label{ClientResource}
2316 \section{The Client Resource}
2317 \index[general]{Resource!Client}
2318 \index[general]{Client Resource}
2320 The Client resource defines the attributes of the Clients that are served by
2321 this Director; that is the machines that are to be backed up. You will need
2322 one Client resource definition for each machine to be backed up.
2326 \item [Client (or FileDaemon)]
2327 \index[dir]{Client (or FileDaemon)}
2328 \index[dir]{Directive!Client (or FileDaemon)}
2329 Start of the Client directives.
2331 \label{Director:Client:Name}
2332 \item [Name = \lt{}name\gt{}]
2334 \index[dir]{Directive!Name}
2335 The client name which will be used in the Job resource directive or in the
2336 console run command. This directive is required.
2338 \label{Director:Client:Address}
2339 \item [Address = \lt{}address\gt{}]
2340 \index[dir]{Address}
2341 \index[dir]{Directive!FD Address}
2342 \index[dir]{File Daemon Address}
2343 \index[dir]{Client Address}
2344 Where the address is a host name, a fully qualified domain name, or a
2345 network address in dotted quad notation for a Bacula File server daemon.
2346 This directive is required.
2348 \label{Director:Client:FdPort}
2349 \item [FD Port = \lt{}port-number\gt{}]
2350 \index[dir]{FD Port}
2351 \index[dir]{Directive!FD Port}
2352 Where the port is a port number at which the Bacula File server daemon can
2353 be contacted. The default is 9102.
2355 \label{Director:Client:Catalog}
2356 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2357 \index[dir]{Catalog}
2358 \index[dir]{Directive!Catalog}
2359 This specifies the name of the catalog resource to be used for this Client.
2360 This directive is required.
2362 \label{Director:Client:Password}
2363 \item [Password = \lt{}password\gt{}]
2364 \index[dir]{Password}
2365 \index[dir]{Directive!Password}
2366 This is the password to be used when establishing a connection with the File
2367 services, so the Client configuration file on the machine to be backed up
2368 must have the same password defined for this Director. This directive is
2369 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2370 Bacula will generate a random password during the configuration process,
2371 otherwise it will be left blank.
2373 The password is plain text. It is not generated through any special
2374 process, but it is preferable for security reasons to make the text
2376 \label{FileRetention}
2378 \label{FileRetention}
2379 \label{Director:Client:FileRetention}
2380 \item [File Retention = \lt{}time-period-specification\gt{}]
2381 \index[dir]{File Retention}
2382 \index[dir]{Directive!File Retention}
2383 The File Retention directive defines the length of time that Bacula will
2384 keep File records in the Catalog database after the End time of the
2385 Job corresponding to the File records.
2386 When this time period expires, and if
2387 {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
2388 that are older than the specified File Retention period. Note, this affects
2389 only records in the catalog database. It does not affect your archive
2392 File records may actually be retained for a shorter period than you specify
2393 on this directive if you specify either a shorter {\bf Job Retention} or a
2394 shorter {\bf Volume Retention} period. The shortest retention period of the
2395 three takes precedence. The time may be expressed in seconds, minutes,
2396 hours, days, weeks, months, quarters, or years. See the
2397 \ilink{ Configuration chapter}{Time} of this manual for
2398 additional details of time specification.
2400 The default is 60 days.
2402 \label{JobRetention}
2403 \label{Director:Client:JobRetention}
2404 \item [Job Retention = \lt{}time-period-specification\gt{}]
2405 \index[dir]{Job Retention}
2406 \index[dir]{Directive!Job Retention}
2407 The Job Retention directive defines the length of time that Bacula will keep
2408 Job records in the Catalog database after the Job End time. When
2409 this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2410 Bacula will prune (remove) Job records that are older than the specified
2411 File Retention period. As with the other retention periods, this
2412 affects only records in the catalog and not data in your archive backup.
2414 If a Job record is selected for pruning, all associated File and JobMedia
2415 records will also be pruned regardless of the File Retention period set.
2416 As a consequence, you normally will set the File retention period to be
2417 less than the Job retention period. The Job retention period can actually
2418 be less than the value you specify here if you set the {\bf Volume
2419 Retention} directive in the Pool resource to a smaller duration. This is
2420 because the Job retention period and the Volume retention period are
2421 independently applied, so the smaller of the two takes precedence.
2423 The Job retention period is specified as seconds, minutes, hours, days,
2424 weeks, months, quarters, or years. See the
2425 \ilink{ Configuration chapter}{Time} of this manual for
2426 additional details of time specification.
2428 The default is 180 days.
2431 \label{Director:Client:AutoPrune}
2432 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2433 \index[dir]{AutoPrune}
2434 \index[dir]{Directive!AutoPrune}
2435 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
2436 will automatically apply the File retention period and the Job retention
2437 period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
2438 pruning will not be done, and your Catalog will grow in size each time you
2439 run a Job. Pruning affects only information in the catalog and not data
2440 stored in the backup archives (on Volumes).
2442 \label{Director:Client:MaximumConcurrentJobs}
2443 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2444 \index[dir]{Maximum Concurrent Jobs}
2445 \index[dir]{Directive!Maximum Concurrent Jobs}
2446 where \lt{}number\gt{} is the maximum number of Jobs with the current Client
2447 that can run concurrently. Note, this directive limits only Jobs for Clients
2448 with the same name as the resource in which it appears. Any other
2449 restrictions on the maximum concurrent jobs such as in the Director, Job, or
2450 Storage resources will also apply in addition to any limit specified here.
2451 The default is set to 1, but you may set it to a larger number.
2453 \label{Director:Client:MaximumBandwidthPerJob}
2454 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2455 \index[dir]{Maximum Bandwidth Per Job}
2456 \index[dir]{Directive!Maximum Bandwidth Per Job}
2458 The speed parameter specifies the maximum allowed bandwidth that a job may use
2459 when started for this Client. The speed parameter should be specified in
2460 k/s, Kb/s, m/s or Mb/s.
2462 % \item [FD Storage Address = \lt{}address\gt{}]
2463 % \index[dir]{FDStorageAddress}
2464 % \index[dir]{Directive!FD Storage Address}
2465 % \index[dir]{Storage daemon Address}
2467 % Where the address is a host name, a {\bf fully qualified domain name}, or an
2468 % {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2469 % will be transmitted to the File daemon instead of the Storage
2470 % \texttt{Address} who will then use it to contact the Storage daemon. This
2471 % directive can be used in NAT environment where the configuration of the
2472 % Client resolver is not possible. Note that using this directive will not allow
2473 % to use multiple Storage Daemon for Backup/Restore jobs.
2475 % \begin{figure}[htbp]
2477 % \includegraphics[width=10cm]{\idir BackupOverWan1}
2478 % \caption{Backup over WAN using FD Storage Address}
2481 \label{Director:Client:Priority}
2482 \item [Priority = \lt{}number\gt{}]
2483 \index[dir]{Priority}
2484 \index[dir]{Directive!Priority}
2485 The number specifies the priority of this client relative to other clients
2486 that the Director is processing simultaneously. The priority can range from
2487 1 to 1000. The clients are ordered such that the smaller number priorities
2488 are performed first (not currently implemented).
2491 The following is an example of a valid Client resource definition:
2497 FDAddress = minimatou
2499 Password = very_good
2504 \label{StorageResource}
2505 \section{The Storage Resource}
2506 \index[general]{Resource!Storage}
2507 \index[general]{Storage Resource}
2509 The Storage resource defines which Storage daemons are available for use by
2515 \index[dir]{Storage}
2516 \index[dir]{Directive!Storage}
2517 Start of the Storage resources. At least one storage resource must be
2520 \label{Director:Storage:Name}
2521 \item [Name = \lt{}name\gt{}]
2523 \index[dir]{Directive!Name}
2524 The name of the storage resource. This name appears on the Storage directive
2525 specified in the Job resource and is required.
2527 \label{Director:Storage:Address}
2528 \item [Address = \lt{}address\gt{}]
2529 \index[dir]{Address}
2530 \index[dir]{Directive!SD Address}
2531 \index[dir]{Storage daemon Address}
2532 Where the address is a host name, a {\bf fully qualified domain name}, or an
2533 {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2534 will be transmitted to the File daemon who will then use it to contact the
2535 Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
2536 the name but rather a fully qualified machine name or an IP address. This
2537 directive is required.
2539 \label{Director:Storage:FdStorageAddress}
2540 \item [FD Storage Address = \lt{}address\gt{}]
2541 \index[dir]{FDStorageAddress}
2542 \index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
2543 Address} Where the address is a host name, a {\bf fully qualified domain
2544 name}, or an {\bf IP address}. Please note that the \lt{}address\gt{} as
2545 specified here will be transmitted to the File daemon instead of the
2546 \texttt{Address} who will then use it to contact the Storage daemon. This
2547 directive can be used in NAT environment where the configuration of the
2548 Client resolver is not possible.
2550 \bsysimageH{BackupOverWan1}{Backup over WAN using FD Storage Address}{figdirdconf:backupwan}
2551 %% \begin{figure}[htbp]
2553 %% \includegraphics[width=10cm]{\idir BackupOverWan1}
2554 %% \caption{Backup over WAN using FD Storage Address}
2557 \label{Director:Storage:SdPort}
2558 \item [SD Port = \lt{}port\gt{}]
2559 \index[dir]{SD Port}
2560 \index[dir]{Directive!SD Port}
2561 Where port is the port to use to contact the storage daemon for information
2562 and to start jobs. This same port number must appear in the Storage resource
2563 of the Storage daemon's configuration file. The default is 9103.
2565 \label{Director:Storage:Password}
2566 \item [Password = \lt{}password\gt{}]
2567 \index[dir]{Password}
2568 \index[dir]{Directive!Password}
2569 This is the password to be used when establishing a connection with the
2570 Storage services. This same password also must appear in the Director
2571 resource of the Storage daemon's configuration file. This directive is
2572 required. If you have either {\bf /dev/random} {\bf bc} on your machine,
2573 Bacula will generate a random password during the configuration process,
2574 otherwise it will be left blank.
2576 The password is plain text. It is not generated through any special
2577 process, but it is preferable for security reasons to use random text.
2579 \label{Director:Storage:Device}
2580 \item [Device = \lt{}device-name\gt{}]
2582 \index[dir]{Directive!Device}
2583 This directive specifies the Storage daemon's name of the device
2584 resource to be used for the storage. If you are using an Autochanger,
2585 the name specified here should be the name of the Storage daemon's
2586 Autochanger resource rather than the name of an individual device. This
2587 name is not the physical device name, but the logical device name as
2588 defined on the {\bf Name} directive contained in the {\bf Device} or the
2589 {\bf Autochanger} resource definition of the {\bf Storage daemon}
2590 configuration file. You can specify any name you would like (even the
2591 device name if you prefer) up to a maximum of 127 characters in length.
2592 The physical device name associated with this device is specified in the
2593 {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2594 Please take care not to define two different Storage resource directives
2595 in the Director that point to the same Device in the Storage daemon.
2596 Doing so may cause the Storage daemon to block (or hang) attempting to
2597 open the same device that is already open. This directive is required.
2600 \label{Director:Storage:MediaType}
2601 \item [Media Type = \lt{}MediaType\gt{}]
2602 \index[dir]{Media Type}
2603 \index[dir]{Directive!Media Type}
2604 This directive specifies the Media Type to be used to store the data.
2605 This is an arbitrary string of characters up to 127 maximum that you
2606 define. It can be anything you want. However, it is best to make it
2607 descriptive of the storage media (e.g. File, DAT, ``HP DLT8000'', 8mm,
2608 \ldots{}). In addition, it is essential that you make the {\bf Media Type}
2609 specification unique for each storage media type. If you have two DDS-4
2610 drives that have incompatible formats, or if you have a DDS-4 drive and
2611 a DDS-4 autochanger, you almost certainly should specify different {\bf
2612 Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
2613 associated with the Job, Bacula can decide to use any Storage daemon
2614 that supports Media Type {\bf DDS-4} and on any drive that supports it.
2616 If you are writing to disk Volumes, you must make doubly sure that each
2617 Device resource defined in the Storage daemon (and hence in the
2618 Director's conf file) has a unique media type. Otherwise for Bacula
2619 versions 1.38 and older, your restores may not work because Bacula
2620 will assume that you can mount any Media Type with the same name on
2621 any Device associated with that Media Type. This is possible with
2622 tape drives, but with disk drives, unless you are very clever you
2623 cannot mount a Volume in any directory -- this can be done by creating
2624 an appropriate soft link.
2626 Currently Bacula permits only a single Media Type per Storage
2627 and Device definition. Consequently, if
2628 you have a drive that supports more than one Media Type, you can
2629 give a unique string to Volumes with different intrinsic Media
2630 Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2631 those volumes will only be mounted on drives indicated with the
2632 dual type (DDS-3-4).
2634 If you want to tie Bacula to using a single Storage daemon or drive, you
2635 must specify a unique Media Type for that drive. This is an important
2636 point that should be carefully understood. Note, this applies equally
2637 to Disk Volumes. If you define more than one disk Device resource in
2638 your Storage daemon's conf file, the Volumes on those two devices are in
2639 fact incompatible because one can not be mounted on the other device
2640 since they are found in different directories. For this reason, you
2641 probably should use two different Media Types for your two disk Devices
2642 (even though you might think of them as both being File types). You can
2643 find more on this subject in the \ilink{Basic Volume
2644 Management}{DiskChapter} chapter of this manual.
2646 The {\bf MediaType} specified in the Director's Storage resource, {\bf
2647 must} correspond to the {\bf Media Type} specified in the {\bf Device}
2648 resource of the {\bf Storage daemon} configuration file. This directive
2649 is required, and it is used by the Director and the Storage daemon to
2650 ensure that a Volume automatically selected from the Pool corresponds to
2651 the physical device. If a Storage daemon handles multiple devices (e.g.
2652 will write to various file Volumes on different partitions), this
2653 directive allows you to specify exactly which device.
2655 As mentioned above, the value specified in the Director's Storage
2656 resource must agree with the value specified in the Device resource in
2657 the {\bf Storage daemon's} configuration file. It is also an additional
2658 check so that you don't try to write data for a DLT onto an 8mm device.
2659 \label{Autochanger1}
2661 \label{Director:Storage:Autochanger}
2662 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2663 \index[dir]{Autochanger}
2664 \index[dir]{Directive!Autochanger}
2665 If you specify {\bf yes} for this command (the default is {\bf no}),
2666 when you use the {\bf label} command or the {\bf add} command to create
2667 a new Volume, {\bf Bacula} will also request the Autochanger Slot
2668 number. This simplifies creating database entries for Volumes in an
2669 autochanger. If you forget to specify the Slot, the autochanger will
2670 not be used. However, you may modify the Slot associated with a Volume
2671 at any time by using the {\bf update volume} or {\bf update slots}
2672 command in the console program. When {\bf autochanger} is enabled, the
2673 algorithm used by Bacula to search for available volumes will be
2674 modified to consider only Volumes that are known to be in the
2675 autochanger's magazine. If no {\bf in changer} volume is found, Bacula
2676 will attempt recycling, pruning, \ldots{}, and if still no volume is found,
2677 Bacula will search for any volume whether or not in the magazine. By
2678 privileging in changer volumes, this procedure minimizes operator
2679 intervention. The default is {\bf no}.
2681 For the autochanger to be used, you must also specify {\bf Autochanger =
2682 yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2683 configuration file as well as other important Storage daemon
2684 configuration information. Please consult the \ilink{Using
2685 Autochangers}{AutochangersChapter} manual of this chapter for the
2686 details of using autochangers.
2688 \label{Director:Storage:MaximumConcurrentJobs}
2689 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2690 \index[dir]{Maximum Concurrent Jobs}
2691 \index[dir]{Directive!Maximum Concurrent Jobs}
2692 where \lt{}number\gt{} is the maximum number of Jobs with the current
2693 Storage resource that can run concurrently. Note, this directive limits
2694 only Jobs for Jobs using this Storage daemon. Any other restrictions on
2695 the maximum concurrent jobs such as in the Director, Job, or Client
2696 resources will also apply in addition to any limit specified here. The
2697 default is set to 1, but you may set it to a larger number. However, if
2698 you set the Storage daemon's number of concurrent jobs greater than one,
2699 we recommend that you read the waring documented under \ilink{Maximum
2700 Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2701 turn data spooling on as documented in the \ilink{Data
2702 Spooling}{SpoolingChapter} chapter of this manual.
2704 \label{AllowCompression}
2705 \label{Director:Storage:AllowCompression}
2706 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2707 \index[dir]{AllowCompression}
2708 \index[dir]{Directive!AllowCompression}
2710 This directive is optional, and if you specify {\bf No} (the default is {\bf
2711 Yes}), it will cause backups jobs running on this storage resource to run
2712 without client File Daemon compression. This effectively overrides
2713 compression options in FileSets used by jobs which use this storage
2716 \label{Director:Storage:HeartbeatInterval}
2717 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2718 \index[dir]{Heartbeat Interval}
2719 \index[dir]{Directive!Heartbeat}
2720 This directive is optional and if specified will cause the Director to
2721 set a keepalive interval (heartbeat) in seconds on each of the sockets
2722 it opens for the Storage resource. This value will override any
2723 specified at the Director level. It is implemented only on systems
2724 (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2725 The default value is zero, which means no change is made to the socket.
2729 The following is an example of a valid Storage resource definition:
2733 # Definition of tape storage device
2737 Password = storage_password # password for Storage daemon
2738 Device = "HP DLT 80" # same as Device in Storage daemon
2739 Media Type = DLT8000 # same as MediaType in Storage daemon
2744 \label{PoolResource}
2745 \section{The Pool Resource}
2746 \index[general]{Resource!Pool}
2747 \index[general]{Pool Resource}
2749 The Pool resource defines the set of storage Volumes (tapes or files) to be
2750 used by Bacula to write the data. By configuring different Pools, you can
2751 determine which set of Volumes (media) receives the backup data. This permits,
2752 for example, to store all full backup data on one set of Volumes and all
2753 incremental backups on another set of Volumes. Alternatively, you could assign
2754 a different set of Volumes to each machine that you backup. This is most
2755 easily done by defining multiple Pools.
2757 Another important aspect of a Pool is that it contains the default attributes
2758 (Maximum Jobs, Retention Period, Recycle flag, \ldots{}) that will be given to a
2759 Volume when it is created. This avoids the need for you to answer a large
2760 number of questions when labeling a new Volume. Each of these attributes can
2761 later be changed on a Volume by Volume basis using the {\bf update} command in
2762 the console program. Note that you must explicitly specify which Pool Bacula
2763 is to use with each Job. Bacula will not automatically search for the correct
2766 Most often in Bacula installations all backups for all machines (Clients) go
2767 to a single set of Volumes. In this case, you will probably only use the {\bf
2768 Default} Pool. If your backup strategy calls for you to mount a different tape
2769 each day, you will probably want to define a separate Pool for each day. For
2770 more information on this subject, please see the
2771 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2775 To use a Pool, there are three distinct steps. First the Pool must be defined
2776 in the Director's configuration file. Then the Pool must be written to the
2777 Catalog database. This is done automatically by the Director each time that it
2778 starts, or alternatively can be done using the {\bf create} command in the
2779 console program. Finally, if you change the Pool definition in the Director's
2780 configuration file and restart Bacula, the pool will be updated alternatively
2781 you can use the {\bf update pool} console command to refresh the database
2782 image. It is this database image rather than the Director's resource image
2783 that is used for the default Volume attributes. Note, for the pool to be
2784 automatically created or updated, it must be explicitly referenced by a Job
2787 Next the physical media must be labeled. The labeling can either be done with
2788 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2789 program. The preferred method is to use the {\bf label} command in the {\bf
2792 Finally, you must add Volume names (and their attributes) to the Pool. For
2793 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2794 archive device specified for the job (i.e. if you are going to back up to a
2795 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2796 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2797 are backing up to files. When running a Job, you must explicitly specify which
2798 Pool to use. Bacula will then automatically select the next Volume to use from
2799 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2800 from the Pool is identical to that required by the Storage resource you have
2801 specified for the Job.
2803 If you use the {\bf label} command in the console program to label the
2804 Volumes, they will automatically be added to the Pool, so this last step is
2805 not normally required.
2807 It is also possible to add Volumes to the database without explicitly labeling
2808 the physical volume. This is done with the {\bf add} console command.
2810 As previously mentioned, each time Bacula starts, it scans all the Pools
2811 associated with each Catalog, and if the database record does not already
2812 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2813 probably should do an {\bf update pool} if you change the Pool definition, but
2814 currently, you must do this manually using the {\bf update pool} command in
2815 the Console program.
2817 The Pool Resource defined in the Director's configuration file
2818 (bacula-dir.conf) may contain the following directives:
2824 \index[dir]{Directive!Pool}
2825 Start of the Pool resource. There must be at least one Pool resource
2829 \label{Director:Pool:Name}
2830 \item [Name = \lt{}name\gt{}]
2832 \index[dir]{Directive!Name}
2833 The name of the pool. For most applications, you will use the default
2834 pool name {\bf Default}. This directive is required.
2837 \label{Director:Pool:MaximumVolumes}
2838 \item [Maximum Volumes = \lt{}number\gt{}]
2839 \index[dir]{Maximum Volumes}
2840 \index[dir]{Directive!Maximum Volumes}
2841 This directive specifies the maximum number of volumes (tapes or files)
2842 contained in the pool. This directive is optional, if omitted or set to
2843 zero, any number of volumes will be permitted. In general, this
2844 directive is useful for Autochangers where there is a fixed number of
2845 Volumes, or for File storage where you wish to ensure that the backups
2846 made to disk files do not become too numerous or consume too much space.
2848 \label{Director:Pool:PoolType}
2849 \item [Pool Type = \lt{}type\gt{}]
2850 \index[dir]{Pool Type}
2851 \index[dir]{Directive!Pool Type}
2852 This directive defines the pool type, which corresponds to the type of
2853 Job being run. It is required and may be one of the following:
2863 Note, only Backup is current implemented.
2865 \label{Director:Pool:Storage}
2866 \item [Storage = \lt{}storage-resource-name\gt{}]
2867 \index[dir]{Storage}
2868 \index[dir]{Directive!Storage}
2869 The Storage directive defines the name of the storage services where you
2870 want to backup the FileSet data. For additional details, see the
2871 \ilink{Storage Resource Chapter}{StorageResource} of this manual.
2872 The Storage resource may also be specified in the Job resource,
2873 but the value, if any, in the Pool resource overrides any value
2874 in the Job. This Storage resource definition is not required by either
2875 the Job resource or in the Pool, but it must be specified in
2876 one or the other. If not configuration error will result.
2878 \label{Director:Pool:UseVolumeOnce}
2879 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2880 \index[dir]{Use Volume Once}
2881 \index[dir]{Directive!Use Volume Once}
2882 This directive if set to {\bf yes} specifies that each volume is to be
2883 used only once. This is most useful when the Media is a file and you
2884 want a new file for each backup that is done. The default is {\bf no}
2885 (i.e. use volume any number of times). This directive will most likely
2886 be phased out (deprecated), so you are recommended to use {\bf Maximum
2887 Volume Jobs = 1} instead.
2889 The value defined by this directive in the bacula-dir.conf file is the
2890 default value used when a Volume is created. Once the volume is
2891 created, changing the value in the bacula-dir.conf file will not change
2892 what is stored for the Volume. To change the value for an existing
2893 Volume you must use the {\bf update} command in the Console.
2895 Please see the notes below under {\bf Maximum Volume Jobs} concerning
2896 using this directive with multiple simultaneous jobs.
2898 \label{Director:Pool:MaximumVolumeJobs}
2899 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2900 \index[dir]{Maximum Volume Jobs}
2901 \index[dir]{Directive!Maximum Volume Jobs}
2902 This directive specifies the maximum number of Jobs that can be written
2903 to the Volume. If you specify zero (the default), there is no limit.
2904 Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2905 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2906 is marked {\bf Used} it can no longer be used for appending Jobs, much
2907 like the {\bf Full} status but it can be recycled if recycling is
2908 enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
2909 one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2911 The value defined by this directive in the bacula-dir.conf
2912 file is the default value used when a Volume is created. Once the volume is
2913 created, changing the value in the bacula-dir.conf file will not change what
2914 is stored for the Volume. To change the value for an existing Volume you
2915 must use the {\bf update} command in the Console.
2917 If you are running multiple simultaneous jobs, this directive may not
2918 work correctly because when a drive is reserved for a job, this
2919 directive is not taken into account, so multiple jobs may try to
2920 start writing to the Volume. At some point, when the Media record is
2921 updated, multiple simultaneous jobs may fail since the Volume can no
2924 \label{Director:Pool:MaximumVolumeFiles}
2925 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2926 \index[dir]{Maximum Volume Files}
2927 \index[dir]{Directive!Maximum Volume Files}
2928 This directive specifies the maximum number of files that can be written
2929 to the Volume. If you specify zero (the default), there is no limit.
2930 Otherwise, when the number of files written to the Volume equals {\bf
2931 positive-integer} the Volume will be marked {\bf Used}. When the Volume
2932 is marked {\bf Used} it can no longer be used for appending Jobs, much
2933 like the {\bf Full} status but it can be recycled if recycling is
2934 enabled and thus used again. This value is checked and the {\bf Used}
2935 status is set only at the end of a job that writes to the particular
2938 The value defined by this directive in the bacula-dir.conf file is the
2939 default value used when a Volume is created. Once the volume is
2940 created, changing the value in the bacula-dir.conf file will not change
2941 what is stored for the Volume. To change the value for an existing
2942 Volume you must use the {\bf update} command in the Console.
2944 \label{Director:Pool:MaximumVolumeBytes}
2945 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2946 \index[dir]{Maximum Volume Bytes}
2947 \index[dir]{Directive!Maximum Volume Bytes}
2948 This directive specifies the maximum number of bytes that can be written
2949 to the Volume. If you specify zero (the default), there is no limit
2950 except the physical size of the Volume. Otherwise, when the number of
2951 bytes written to the Volume equals {\bf size} the Volume will be marked
2952 {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
2953 used for appending Jobs, much like the {\bf Full} status but it can be
2954 recycled if recycling is enabled, and thus the Volume can be re-used
2955 after recycling. This value is checked and the {\bf Used} status set
2956 while the job is writing to the particular volume.
2958 This directive is particularly useful for restricting the size
2959 of disk volumes, and will work correctly even in the case of
2960 multiple simultaneous jobs writing to the volume.
2962 The value defined by this directive in the bacula-dir.conf file is the
2963 default value used when a Volume is created. Once the volume is
2964 created, changing the value in the bacula-dir.conf file will not change
2965 what is stored for the Volume. To change the value for an existing
2966 Volume you must use the {\bf update} command in the Console.
2968 \label{Director:Pool:VolumeUseDuration}
2969 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2970 \index[dir]{Volume Use Duration}
2971 \index[dir]{Directive!Volume Use Duration}
2972 The Volume Use Duration directive defines the time period that the
2973 Volume can be written beginning from the time of first data write to the
2974 Volume. If the time-period specified is zero (the default), the Volume
2975 can be written indefinitely. Otherwise, the next time a job
2976 runs that wants to access this Volume, and the time period from the
2977 first write to the volume (the first Job written) exceeds the
2978 time-period-specification, the Volume will be marked {\bf Used}, which
2979 means that no more Jobs can be appended to the Volume, but it may be
2980 recycled if recycling is enabled. Using the command {\bf
2981 status dir} applies algorithms similar to running jobs, so
2982 during such a command, the Volume status may also be changed.
2984 recycled, it will be available for use again.
2986 You might use this directive, for example, if you have a Volume used for
2987 Incremental backups, and Volumes used for Weekly Full backups. Once the
2988 Full backup is done, you will want to use a different Incremental
2989 Volume. This can be accomplished by setting the Volume Use Duration for
2990 the Incremental Volume to six days. I.e. it will be used for the 6
2991 days following a Full save, then a different Incremental volume will be
2992 used. Be careful about setting the duration to short periods such as 23
2993 hours, or you might experience problems of Bacula waiting for a tape
2994 over the weekend only to complete the backups Monday morning when an
2995 operator mounts a new tape.
2997 The use duration is checked and the {\bf Used} status is set only at the
2998 end of a job that writes to the particular volume, which means that even
2999 though the use duration may have expired, the catalog entry will not be
3000 updated until the next job that uses this volume is run. This
3001 directive is not intended to be used to limit volume sizes
3002 and will not work correctly (i.e. will fail jobs) if the use
3003 duration expires while multiple simultaneous jobs are writing
3006 Please note that the value defined by this directive in the bacula-dir.conf
3007 file is the default value used when a Volume is created. Once the volume is
3008 created, changing the value in the bacula-dir.conf file will not change what
3009 is stored for the Volume. To change the value for an existing Volume you
3011 \bsysxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
3013 \label{Director:Pool:CatalogFiles}
3014 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
3015 \index[dir]{Catalog Files}
3016 \index[dir]{Directive!Catalog Files}
3017 This directive defines whether or not you want the names of the files
3018 that were saved to be put into the catalog. The default is {\bf yes}.
3019 The advantage of specifying {\bf Catalog Files = No} is that you will
3020 have a significantly smaller Catalog database. The disadvantage is that
3021 you will not be able to produce a Catalog listing of the files backed up
3022 for each Job (this is often called Browsing). Also, without the File
3023 entries in the catalog, you will not be able to use the Console {\bf
3024 restore} command nor any other command that references File entries.
3025 \label{PoolAutoPrune}
3027 \label{Director:Pool:AutoPrune}
3028 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
3029 \index[dir]{AutoPrune}
3030 \index[dir]{Directive!AutoPrune}
3031 If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
3032 greater) will automatically apply the Volume Retention period when new
3033 Volume is needed and no appendable Volumes exist in the Pool. Volume
3034 pruning causes expired Jobs (older than the {\bf Volume Retention}
3035 period) to be deleted from the Catalog and permits possible recycling of
3037 \label{VolRetention}
3039 \label{Director:Pool:VolumeRetention}
3040 \item [Volume Retention = \lt{}time-period-specification\gt{}]
3041 \index[dir]{Volume Retention}
3042 \index[dir]{Directive!Volume Retention}
3043 The Volume Retention directive defines the length of time that {\bf
3044 Bacula} will keep records associated with the Volume in
3045 the Catalog database after the End time of each Job written to the
3046 Volume. When this time period expires, and if {\bf AutoPrune} is set to
3047 {\bf yes} Bacula may prune (remove) Job records that are older than the
3048 specified Volume Retention period if it is necessary to free up a
3049 Volume. Recycling will not occur until it is absolutely necessary to
3050 free up a volume (i.e. no other writable volume exists).
3051 All File records associated with pruned Jobs are also
3052 pruned. The time may be specified as seconds, minutes, hours, days,
3053 weeks, months, quarters, or years. The {\bf Volume Retention} is
3054 applied independently of the {\bf Job Retention} and the {\bf File
3055 Retention} periods defined in the Client resource. This means that all
3056 the retentions periods are applied in turn and that the shorter period
3057 is the one that effectively takes precedence. Note, that when the {\bf
3058 Volume Retention} period has been reached, and it is necessary to obtain
3059 a new volume, Bacula will prune both the Job and the File records. This
3060 pruning could also occur during a {\bf status dir} command because it
3061 uses similar algorithms for finding the next available Volume.
3063 It is important to know that when the Volume Retention period expires,
3064 Bacula does not automatically recycle a Volume. It attempts to keep the
3065 Volume data intact as long as possible before over writing the Volume.
3067 By defining multiple Pools with different Volume Retention periods, you
3068 may effectively have a set of tapes that is recycled weekly, another
3069 Pool of tapes that is recycled monthly and so on. However, one must
3070 keep in mind that if your {\bf Volume Retention} period is too short, it
3071 may prune the last valid Full backup, and hence until the next Full
3072 backup is done, you will not have a complete backup of your system, and
3073 in addition, the next Incremental or Differential backup will be
3074 promoted to a Full backup. As a consequence, the minimum {\bf Volume
3075 Retention} period should be at twice the interval of your Full backups.
3076 This means that if you do a Full backup once a month, the minimum Volume
3077 retention period should be two months.
3079 The default Volume retention period is 365 days, and either the default
3080 or the value defined by this directive in the bacula-dir.conf file is
3081 the default value used when a Volume is created. Once the volume is
3082 created, changing the value in the bacula-dir.conf file will not change
3083 what is stored for the Volume. To change the value for an existing
3084 Volume you must use the {\bf update} command in the Console.
3086 \label{Director:Pool:ActionOnPurge}
3087 \item [Action On Purge = \lt{Truncate}]
3088 \index[dir]{actiononpurge}
3090 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
3091 volume when it is purged with the \texttt{purge volume action=truncate}
3092 command. It is useful to prevent disk based volumes from consuming too much
3098 Action On Purge = Truncate
3103 You can schedule the truncate operation at the end of your CatalogBackup job
3104 like in this example:
3108 Name = CatalogBackup
3113 Console = "purge volume action=all allpools storage=File"
3117 \label{PoolScratchPool}
3119 \label{Director:Pool:ScrachPool}
3120 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
3121 \index[dir]{ScrachPool}
3122 \index[dir]{Directive!ScrachPool}
3123 This directive permits to specify a dedicate \textsl{Scratch} for the
3124 current pool. This pool will replace the special pool named \textsl{Scrach}
3125 for volume selection. For more information about \textsl{Scratch} see
3126 \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
3127 when using multiple storage sharing the same mediatype or when you want to
3128 dedicate volumes to a particular set of pool.
3129 \label{PoolRecyclePool}
3131 \label{Director:Pool:RecyclePool}
3132 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
3133 \index[dir]{RecyclePool}
3134 \index[dir]{Directive!RecyclePool}
3135 This directive defines to which pool
3136 the Volume will be placed (moved) when it is recycled. Without
3137 this directive, a Volume will remain in the same pool when it is
3138 recycled. With this directive, it can be moved automatically to any
3139 existing pool during a recycle. This directive is probably most
3140 useful when defined in the Scratch pool, so that volumes will
3141 be recycled back into the Scratch pool. For more on the see the
3142 \ilink{Scratch Pool}{TheScratchPool} section of this manual.
3144 Although this directive is called RecyclePool, the Volume in
3145 question is actually moved from its current pool to the one
3146 you specify on this directive when Bacula prunes the Volume and
3147 discovers that there are no records left in the catalog and hence
3148 marks it as {\bf Purged}.
3152 \label{Director:Pool:Recycle}
3153 \item [Recycle = \lt{}yes\vb{}no\gt{}]
3154 \index[dir]{Recycle}
3155 \index[dir]{Directive!Recycle}
3156 This directive specifies whether or not Purged Volumes may be recycled.
3157 If it is set to {\bf yes} (default) and Bacula needs a volume but finds
3158 none that are appendable, it will search for and recycle (reuse) Purged
3159 Volumes (i.e. volumes with all the Jobs and Files expired and thus
3160 deleted from the Catalog). If the Volume is recycled, all previous data
3161 written to that Volume will be overwritten. If Recycle is set to {\bf
3162 no}, the Volume will not be recycled, and hence, the data will remain
3163 valid. If you want to reuse (re-write) the Volume, and the recycle flag
3164 is no (0 in the catalog), you may manually set the recycle flag (update
3165 command) for a Volume to be reused.
3167 Please note that the value defined by this directive in the
3168 bacula-dir.conf file is the default value used when a Volume is created.
3169 Once the volume is created, changing the value in the bacula-dir.conf
3170 file will not change what is stored for the Volume. To change the value
3171 for an existing Volume you must use the {\bf update} command in the
3174 When all Job and File records have been pruned or purged from the
3175 catalog for a particular Volume, if that Volume is marked as
3176 Append, Full, Used, or Error, it will then be marked as Purged. Only
3177 Volumes marked as Purged will be considered to be converted to the
3178 Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
3180 \label{RecycleOldest}
3182 \label{Director:Pool:RecycleOldestVolume}
3183 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
3184 \index[dir]{Recycle Oldest Volume}
3185 \index[dir]{Directive!Recycle Oldest Volume}
3186 This directive instructs the Director to search for the oldest used
3187 Volume in the Pool when another Volume is requested by the Storage
3188 daemon and none are available. The catalog is then {\bf pruned}
3189 respecting the retention periods of all Files and Jobs written to this
3190 Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
3191 Volume is recycled and will be used as the next Volume to be written.
3192 This directive respects any Job, File, or Volume retention periods that
3193 you may have specified, and as such it is {\bf much} better to use this
3194 directive than the Purge Oldest Volume.
3196 This directive can be useful if you have a fixed number of Volumes in the
3197 Pool and you want to cycle through them and you have specified the correct
3200 However, if you use this directive and have only one
3201 Volume in the Pool, you will immediately recycle your Volume if you fill
3202 it and Bacula needs another one. Thus your backup will be totally invalid.
3203 Please use this directive with care. The default is {\bf no}.
3204 \label{RecycleCurrent}
3207 \label{Director:Pool:RecycleCurrentVolume}
3208 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3209 \index[dir]{Recycle Current Volume}
3210 \index[dir]{Directive!Recycle Current Volume}
3211 If Bacula needs a new Volume, this directive instructs Bacula to Prune
3212 the volume respecting the Job and File retention periods. If all Jobs
3213 are pruned (i.e. the volume is Purged), then the Volume is recycled and
3214 will be used as the next Volume to be written. This directive respects
3215 any Job, File, or Volume retention periods that you may have specified,
3216 and thus it is {\bf much} better to use it rather than the Purge Oldest
3219 This directive can be useful if you have: a fixed number of Volumes in
3220 the Pool, you want to cycle through them, and you have specified
3221 retention periods that prune Volumes before you have cycled through the
3224 However, if you use this directive and have only one Volume in the Pool,
3225 you will immediately recycle your Volume if you fill it and Bacula needs
3226 another one. Thus your backup will be totally invalid. Please use this
3227 directive with care. The default is {\bf no}.
3231 \label{Director:Pool:PurgeOldestVolume}
3232 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3233 \index[dir]{Purge Oldest Volume}
3234 \index[dir]{Directive!Purge Oldest Volume}
3235 This directive instructs the Director to search for the oldest used
3236 Volume in the Pool when another Volume is requested by the Storage
3237 daemon and none are available. The catalog is then {\bf purged}
3238 irrespective of retention periods of all Files and Jobs written to this
3239 Volume. The Volume is then recycled and will be used as the next Volume
3240 to be written. This directive overrides any Job, File, or Volume
3241 retention periods that you may have specified.
3243 This directive can be useful if you have a fixed number of Volumes in
3244 the Pool and you want to cycle through them and reusing the oldest one
3245 when all Volumes are full, but you don't want to worry about setting
3246 proper retention periods. However, by using this option you risk losing
3249 Please be aware that {\bf Purge Oldest Volume} disregards all retention
3250 periods. If you have only a single Volume defined and you turn this
3251 variable on, that Volume will always be immediately overwritten when it
3252 fills! So at a minimum, ensure that you have a decent number of Volumes
3253 in your Pool before running any jobs. If you want retention periods to
3254 apply do not use this directive. To specify a retention period, use the
3255 {\bf Volume Retention} directive (see above).
3257 We {\bf highly} recommend against using this directive, because it is
3258 sure that some day, Bacula will recycle a Volume that contains current
3259 data. The default is {\bf no}.
3261 \label{Director:Pool:FileRetention}
3262 \item [File Retention = \lt{}time-period-specification\gt{}]
3263 \index[dir]{File Retention}
3264 \index[dir]{Directive!File Retention}
3265 The File Retention directive defines the length of time that Bacula will
3266 keep File records in the Catalog database after the End time of the
3267 Job corresponding to the File records.
3269 This directive takes precedence over Client directives of the same name. For
3270 example, you can decide to increase Retention times for Archive or OffSite
3273 Note, this affects only records in the catalog database. It does not affect
3274 your archive backups.
3276 For more information see Client documentation about
3277 \ilink{FileRetention}{FileRetention}
3279 \label{Director:Pool:JobRetention}
3280 \item [Job Retention = \lt{}time-period-specification\gt{}]
3281 \index[dir]{Job Retention}
3282 \index[dir]{Directive!Job Retention}
3284 The Job Retention directive defines the length of time that Bacula will keep
3285 Job records in the Catalog database after the Job End time. As with the
3286 other retention periods, this affects only records in the catalog and not
3287 data in your archive backup.
3289 This directive takes precedence over Client directives of the same name.
3290 For example, you can decide to increase Retention times for Archive or
3293 For more information see Client side documentation
3294 \ilink{JobRetention}{JobRetention}
3296 \label{Director:Pool:CleaningPrefix}
3297 \item [Cleaning Prefix = \lt{}string\gt{}]
3298 \index[dir]{Cleaning Prefix}
3299 \index[dir]{Directive!Cleaning Prefix}
3300 This directive defines a prefix string, which if it matches the
3301 beginning of a Volume name during labeling of a Volume, the Volume will
3302 be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3303 never attempt to use this tape. This is primarily for use with
3304 autochangers that accept barcodes where the convention is that barcodes
3305 beginning with {\bf CLN} are treated as cleaning tapes.
3308 \label{Director:Pool:LabelFormat}
3309 \item [Label Format = \lt{}format\gt{}]
3310 \index[dir]{Label Format}
3311 \index[dir]{Directive!Label Format}
3312 This directive specifies the format of the labels contained in this
3313 pool. The format directive is used as a sort of template to create new
3314 Volume names during automatic Volume labeling.
3316 The {\bf format} should be specified in double quotes, and consists of
3317 letters, numbers and the special characters hyphen ({\bf -}), underscore
3318 ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3319 characters for a Volume name. The {\bf format} should be enclosed in
3322 In addition, the format may contain a number of variable expansion
3323 characters which will be expanded by a complex algorithm allowing you to
3324 create Volume names of many different formats. In all cases, the
3325 expansion process must resolve to the set of characters noted above that
3326 are legal Volume names. Generally, these variable expansion characters
3327 begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
3328 specify variable expansion characters, you should always enclose the
3329 format with double quote characters ({\bf "}). For more details on
3330 variable expansion, please see the \bsysxrlink{Variable
3331 Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
3333 If no variable expansion characters are found in the string, the Volume
3334 name will be formed from the {\bf format} string appended with the
3335 a unique number that increases. If you do not remove volumes from the
3336 pool, this number should be the number of volumes plus one, but this
3337 is not guaranteed. The unique number will be edited as four
3338 digits with leading zeros. For example, with a {\bf Label Format =
3339 "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3340 File-0002}, \ldots{}
3342 With the exception of Job specific variables, you can test your {\bf
3343 LabelFormat} by using the \bsysxrlink{var}{var}{console}{command} in the
3346 In almost all cases, you should enclose the format specification (part
3347 after the equal sign) in double quotes. Please note that this directive
3348 is deprecated and is replaced in version 1.37 and greater with a Python
3349 script for creating volume names.
3351 \label{Director:Pool:End}
3354 In order for a Pool to be used during a Backup Job, the Pool must have at
3355 least one Volume associated with it. Volumes are created for a Pool using
3356 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3357 program. In addition to adding Volumes to the Pool (i.e. putting the
3358 Volume names in the Catalog database), the physical Volume must be labeled
3359 with a valid Bacula software volume label before {\bf Bacula} will accept
3360 the Volume. This will be automatically done if you use the {\bf label}
3361 command. Bacula can automatically label Volumes if instructed to do so,
3362 but this feature is not yet fully implemented.
3364 The following is an example of a valid Pool resource definition:
3376 \label{TheScratchPool}
3377 \subsection{The Scratch Pool}
3378 \index[general]{Scratch Pool}
3379 In general, you can give your Pools any name you wish, but there is one
3380 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3381 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3382 writing and it cannot find one, it will look in the Scratch pool, and if
3383 it finds an available Volume, it will move it out of the Scratch pool into
3384 the Pool currently being used by the job.
3387 \label{CatalogResource}
3388 \section{The Catalog Resource}
3389 \index[general]{Resource!Catalog}
3390 \index[general]{Catalog Resource}
3392 The Catalog Resource defines what catalog to use for the current job.
3393 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3394 PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
3395 may be as many Catalogs (databases) defined as you wish. For example, you
3396 may want each Client to have its own Catalog database, or you may want
3397 backup jobs to use one database and verify or restore jobs to use another
3400 Since SQLite is compiled in, it always runs on the same machine
3401 as the Director and the database must be directly accessible (mounted) from
3402 the Director. However, since both MySQL and PostgreSQL are networked
3403 databases, they may reside either on the same machine as the Director
3404 or on a different machine on the network. See below for more details.
3409 \index[dir]{Catalog}
3410 \index[dir]{Directive!Catalog}
3411 Start of the Catalog resource. At least one Catalog resource must be
3415 \label{Director:Catalog:Name}
3416 \item [Name = \lt{}name\gt{}]
3418 \index[dir]{Directive!Name}
3419 The name of the Catalog. No necessary relation to the database server
3420 name. This name will be specified in the Client resource directive
3421 indicating that all catalog data for that Client is maintained in this
3422 Catalog. This directive is required.
3424 \label{Director:Catalog:Password}
3425 \item [password = \lt{}password\gt{}]
3426 \index[dir]{password}
3427 \index[dir]{Directive!password}
3428 This specifies the password to use when logging into the database. This
3429 directive is required.
3431 \label{Director:Catalog:DbName}
3432 \item [DB Name = \lt{}name\gt{}]
3433 \index[dir]{DB Name}
3434 \index[dir]{Directive!DB Name}
3435 This specifies the name of the database. If you use multiple catalogs
3436 (databases), you specify which one here. If you are using an external
3437 database server rather than the internal one, you must specify a name
3438 that is known to the server (i.e. you explicitly created the Bacula
3439 tables using this name. This directive is required.
3441 \label{Director:Catalog:User}
3442 \item [user = \lt{}user\gt{}]
3444 \index[dir]{Directive!user}
3445 This specifies what user name to use to log into the database. This
3446 directive is required.
3448 \label{Director:Catalog:DbSocket}
3449 \item [DB Socket = \lt{}socket-name\gt{}]
3450 \index[dir]{DB Socket}
3451 \index[dir]{Directive!DB Socket}
3452 This is the name of a socket to use on the local host to connect to the
3453 database. This directive is used only by MySQL and is ignored by SQLite.
3454 Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
3455 will use the default socket. If the DB Socket is specified, the
3456 MySQL server must reside on the same machine as the Director.
3458 \label{Director:Catalog:DBAddress}
3459 \item [DB Address = \lt{}address\gt{}]
3460 \index[dir]{DB Address}
3461 \index[dir]{Directive!DB Address}
3462 This is the host address of the database server. Normally, you would specify
3463 this instead of {\bf DB Socket} if the database server is on another machine.
3464 In that case, you will also specify {\bf DB Port}. This directive is used
3465 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3466 This directive is optional.
3468 \label{Director:Catalog:DbPort}
3469 \item [DB Port = \lt{}port\gt{}]
3470 \index[dir]{DB Port}
3471 \index[dir]{Directive!DB Port}
3472 This defines the port to be used in conjunction with {\bf DB Address} to
3473 access the database if it is on another machine. This directive is used only
3474 by MySQL and PostgreSQL and is ignored by SQLite if provided. This
3475 directive is optional.
3477 \label{Director:Catalog:End}
3479 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3481 %% \index[dir]{Directive!Multiple Connections}
3482 %% By default, this directive is set to no. In that case, each job that uses
3484 %% same Catalog will use a single connection to the catalog. It will be shared,
3485 %% and Bacula will allow only one Job at a time to communicate. If you set this
3486 %% directive to yes, Bacula will permit multiple connections to the database,
3487 %% and the database must be multi-thread capable. For SQLite and PostgreSQL,
3488 %% this is no problem. For MySQL, you must be *very* careful to have the
3489 %% multi-thread version of the client library loaded on your system. When this
3490 %% directive is set yes, each Job will have a separate connection to the
3491 %% database, and the database will control the interaction between the
3493 %% Jobs. This can significantly speed up the database operations if you are
3494 %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
3495 %% Bacula will automatically enable transactions. This can significantly speed
3496 %% up insertion of attributes in the database either for a single Job or
3497 %% multiple simultaneous Jobs.
3499 %% This directive has not been tested. Please test carefully before running it
3500 %% in production and report back your results.
3504 The following is an example of a valid Catalog resource definition:
3513 password = "" # no password = no security
3518 or for a Catalog on another machine:
3528 DB Address = remote.acme.com
3534 \label{MessagesResource2}
3535 \section{The Messages Resource}
3536 \index[general]{Resource!Messages}
3537 \index[general]{Messages Resource}
3539 For the details of the Messages Resource, please see the
3540 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3543 \label{ConsoleResource1}
3544 \section{The Console Resource}
3545 \index[general]{Console Resource}
3546 \index[general]{Resource!Console}
3548 As of Bacula version 1.33 and higher, there are three different kinds of
3549 consoles, which the administrator or user can use to interact with the
3550 Director. These three kinds of consoles comprise three different security
3554 \item The first console type is an {\bf anonymous} or {\bf default} console,
3555 which has full privileges. There is no console resource necessary for
3556 this type since the password is specified in the Director's resource and
3557 consequently such consoles do not have a name as defined on a {\bf Name
3558 =} directive. This is the kind of console that was initially
3559 implemented in versions prior to 1.33 and remains valid. Typically you
3560 would use it only for administrators.
3562 \item The second type of console, and new to version 1.33 and higher is a
3563 ``named'' console defined within a Console resource in both the Director's
3564 configuration file and in the Console's configuration file. Both the
3565 names and the passwords in these two entries must match much as is the
3566 case for Client programs.
3568 This second type of console begins with absolutely no privileges except
3569 those explicitly specified in the Director's Console resource. Thus you
3570 can have multiple Consoles with different names and passwords, sort of
3571 like multiple users, each with different privileges. As a default,
3572 these consoles can do absolutely nothing -- no commands whatsoever. You
3573 give them privileges or rather access to commands and resources by
3574 specifying access control lists in the Director's Console resource. The
3575 ACLs are specified by a directive followed by a list of access names.
3576 Examples of this are shown below.
3578 \item The third type of console is similar to the above mentioned one in that
3579 it requires a Console resource definition in both the Director and the
3580 Console. In addition, if the console name, provided on the {\bf Name =}
3581 directive, is the same as a Client name, that console is permitted to
3582 use the {\bf SetIP} command to change the Address directive in the
3583 Director's client resource to the IP address of the Console. This
3584 permits portables or other machines using DHCP (non-fixed IP addresses)
3585 to ``notify'' the Director of their current IP address.
3588 The Console resource is optional and need not be specified. The following
3589 directives are permitted within the Director's configuration resource:
3593 \label{Director:Console:Name}
3594 \item [Name = \lt{}name\gt{}]
3596 \index[dir]{Directive!Name}
3597 The name of the console. This name must match the name specified in the
3598 Console's configuration resource (much as is the case with Client
3601 \label{Director:Console:Password}
3602 \item [Password = \lt{}password\gt{}]
3603 \index[dir]{Password}
3604 \index[dir]{Directive!Password}
3605 Specifies the password that must be supplied for a named Bacula Console
3606 to be authorized. The same password must appear in the {\bf Console}
3607 resource of the Console configuration file. For added security, the
3608 password is never actually passed across the network but rather a
3609 challenge response hash code created with the password. This directive
3610 is required. If you have either {\bf /dev/random} {\bf bc} on your
3611 machine, Bacula will generate a random password during the configuration
3612 process, otherwise it will be left blank.
3614 The password is plain text. It is not generated through any special
3615 process. However, it is preferable for security reasons to choose
3618 \label{Director:Console:JobAcl}
3619 \item [JobACL = \lt{}name-list\gt{}]
3621 \index[dir]{Directive!JobACL}
3622 This directive is used to specify a list of Job resource names that can
3623 be accessed by the console. Without this directive, the console cannot
3624 access any of the Director's Job resources. Multiple Job resource names
3625 may be specified by separating them with commas, and/or by specifying
3626 multiple JobACL directives. For example, the directive may be specified
3631 JobACL = kernsave, "Backup client 1", "Backup client 2"
3632 JobACL = "RestoreFiles"
3637 With the above specification, the console can access the Director's resources
3638 for the four jobs named on the JobACL directives, but for no others.
3640 \label{Director:Console:ClientAcl}
3641 \item [ClientACL = \lt{}name-list\gt{}]
3642 \index[dir]{ClientACL}
3643 \index[dir]{Directive!ClientACL}
3644 This directive is used to specify a list of Client resource names that can
3646 accessed by the console.
3648 \label{Director:Console:StorageAcl}
3649 \item [StorageACL = \lt{}name-list\gt{}]
3650 \index[dir]{StorageACL}
3651 \index[dir]{Directive!StorageACL}
3652 This directive is used to specify a list of Storage resource names that can
3653 be accessed by the console.
3655 \label{Director:Console:ScheduleAcl}
3656 \item [ScheduleACL = \lt{}name-list\gt{}]
3657 \index[dir]{ScheduleACL}
3658 \index[dir]{Directive!ScheduleACL}
3659 This directive is used to specify a list of Schedule resource names that can
3660 be accessed by the console.
3662 \label{Director:Console:PoolAcl}
3663 \item [PoolACL = \lt{}name-list\gt{}]
3664 \index[dir]{PoolACL}
3665 \index[dir]{Directive!PoolACL}
3666 This directive is used to specify a list of Pool resource names that can be
3667 accessed by the console.
3669 \label{Director:Console:FileSetAcl}
3670 \item [FileSetACL = \lt{}name-list\gt{}]
3671 \index[dir]{FileSetACL}
3672 \index[dir]{Directive!FileSetACL}
3673 This directive is used to specify a list of FileSet resource names that
3674 can be accessed by the console.
3676 \label{Director:Console:CatalogAcl}
3677 \item [CatalogACL = \lt{}name-list\gt{}]
3678 \index[dir]{CatalogACL}
3679 \index[dir]{Directive!CatalogACL}
3680 This directive is used to specify a list of Catalog resource names that
3681 can be accessed by the console.
3683 \label{Director:Console:CommandAcl}
3684 \item [CommandACL = \lt{}name-list\gt{}]
3685 \index[dir]{CommandACL}
3686 \index[dir]{Directive!CommandACL}
3687 This directive is used to specify a list of of console commands that can
3688 be executed by the console.
3690 \label{Director:Console:WhereAcl}
3691 \item [WhereACL = \lt{}string\gt{}]
3692 \index[dir]{WhereACL}
3693 \index[dir]{Directive!WhereACL}
3694 This directive permits you to specify where a restricted console
3695 can restore files. If this directive is not specified, only the
3696 default restore location is permitted (normally {\bf
3697 /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3698 user enters will be accepted (not very secure), any other
3699 value specified (there may be multiple WhereACL directives) will
3700 restrict the user to use that path. For example, on a Unix system,
3701 if you specify ``/'', the file will be restored to the original
3702 location. This directive is untested.
3706 Aside from Director resource names and console command names, the special
3707 keyword {\bf *all*} can be specified in any of the above access control lists.
3708 When this keyword is present, any resource or command name (which ever is
3709 appropriate) will be accepted. For an example configuration file, please see
3711 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3714 \label{CounterResource}
3715 \section{The Counter Resource}
3716 \index[general]{Resource!Counter}
3717 \index[general]{Counter Resource}
3719 The Counter Resource defines a counter variable that can be accessed by
3720 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3722 \ilink{LabelFormat}{Label} directive in this chapter for more
3728 \index[dir]{Counter}
3729 \index[dir]{Directive!Counter}
3730 Start of the Counter resource. Counter directives are optional.
3732 \label{Director:Counter:Name}
3733 \item [Name = \lt{}name\gt{}]
3735 \index[dir]{Directive!Name}
3736 The name of the Counter. This is the name you will use in the variable
3737 expansion to reference the counter value.
3739 \label{Director:Counter:Minimum}
3740 \item [Minimum = \lt{}integer\gt{}]
3741 \index[dir]{Minimum}
3742 \index[dir]{Directive!Minimum}
3743 This specifies the minimum value that the counter can have. It also becomes
3744 the default. If not supplied, zero is assumed.
3746 \label{Director:Counter:Maximum}
3747 \item [Maximum = \lt{}integer\gt{}]
3748 \index[dir]{Maximum}
3749 \index[dir]{Directive!Maximum}
3750 \index[dir]{Directive!Maximum}
3751 This is the maximum value value that the counter can have. If not specified
3752 or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
3753 the 31 power). When the counter is incremented past this value, it is reset
3756 \label{Director:Counter:*WrapCounter}
3757 \item [*WrapCounter = \lt{}counter-name\gt{}]
3758 \index[dir]{*WrapCounter}
3759 \index[dir]{Directive!*WrapCounter}
3760 If this value is specified, when the counter is incremented past the
3762 and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
3763 is incremented. (This is not currently implemented).
3765 \label{Director:Counter:Catalog}
3766 \item [Catalog = \lt{}catalog-name\gt{}]
3767 \index[dir]{Catalog}
3768 \index[dir]{Directive!Catalog}
3769 If this directive is specified, the counter and its values will be saved in
3770 the specified catalog. If this directive is not present, the counter will be
3771 redefined each time that Bacula is started.
3773 \label{Director:Counter:End}
3776 \label{SampleDirectorConfiguration}
3777 \section{Example Director Configuration File}
3778 \index[general]{File!Example Director Configuration}
3779 \index[general]{Example Director Configuration File}
3781 An example Director configuration file might be the following:
3786 # Default Bacula Director Configuration file
3788 # The only thing that MUST be changed is to add one or more
3789 # file or directory names in the Include directive of the
3792 # For Bacula release 1.15 (5 March 2002) -- redhat
3794 # You might also want to change the default email address
3795 # from root to your address. See the "mail" and "operator"
3796 # directives in the Messages resource.
3798 Director { # define myself
3800 QueryFile = "/home/kern/bacula/bin/query.sql"
3801 WorkingDirectory = "/home/kern/bacula/bin/working"
3802 PidDirectory = "/home/kern/bacula/bin/working"
3803 Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3805 # Define the backup Job
3807 Name = "NightlySave"
3809 Level = Incremental # default
3812 Schedule = "WeeklyCycle"
3822 Where = /tmp/bacula-restores
3828 # List of files to be backed up
3832 Options { signature=SHA1}
3834 # Put your list of files here, one per line or include an
3835 # external list with:
3839 # Note: / backs up everything
3844 # When to do the backups
3846 Name = "WeeklyCycle"
3847 Run = level=Full sun at 2:05
3848 Run = level=Incremental mon-sat at 2:05
3850 # Client (File Services) to backup
3855 Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3856 File Retention = 60d # sixty day file retention
3857 Job Retention = 1y # 1 year Job retention
3858 AutoPrune = yes # Auto apply retention periods
3860 # Definition of DLT tape storage device
3864 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3865 Device = "HP DLT 80" # same as Device in Storage daemon
3866 Media Type = DLT8000 # same as MediaType in Storage daemon
3868 # Definition for a DLT autochanger device
3872 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3873 Device = "Autochanger" # same as Device in Storage daemon
3874 Media Type = DLT-8000 # Different from DLTDrive
3877 # Definition of DDS tape storage device
3881 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3882 Device = SDT-10000 # same as Device in Storage daemon
3883 Media Type = DDS-4 # same as MediaType in Storage daemon
3885 # Definition of 8mm tape storage device
3889 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3890 Device = "Exabyte 8mm"
3893 # Definition of file storage device
3897 Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3898 Device = FileStorage
3901 # Generic catalog service
3904 dbname = bacula; user = bacula; password = ""
3906 # Reasonable message delivery -- send most everything to
3907 # the email address and to the console
3910 mail = root@localhost = all, !skipped, !terminate
3911 operator = root@localhost = mount
3912 console = all, !skipped, !saved
3915 # Default pool definition
3923 # Restricted console used by tray-monitor to get the status of the director
3927 Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3928 CommandACL = status, .status