]> git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/main/dirdconf.tex
Add virtualfull documentation
[bacula/docs] / docs / manuals / en / main / dirdconf.tex
1 %%
2 %%
3
4 \chapter{Configuring the Director}
5 \label{DirectorChapter}
6 \index[general]{Director!Configuring the}
7 \index[general]{Configuring the Director}
8
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.
12
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.
16
17 \section{Director Resource Types}
18 \index[general]{Types!Director Resource}
19 \index[general]{Director Resource Types}
20
21 Director resource type may be one of the following:
22
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:
25
26 Note, everything revolves around a job and is tied to a job in one
27 way or another.
28
29 \begin{bsysitemize}
30 \item
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.
37 \item
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
42    for each client).
43 \item
44    \ilink{JobDefs}{JobDefsResource} -- optional resource for
45    providing defaults for Job resources.
46 \item
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
50    one.
51 \item
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.
55 \item
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.
59 \item
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.
63 \item
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.
70 \item
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
78    in a later release.
79 \item
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{}).
84 \end{bsysitemize}
85
86 \label{DirectorResource}
87 \section{The Director Resource}
88 \index[general]{Director Resource}
89 \index[general]{Resource!Director}
90
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.
95
96 \begin{description}
97
98 \item [Director]
99    \index[dir]{Director}
100    Start of the Director resource. One and only one  director resource must be
101 supplied.
102
103 \label{Director:Director:Name}
104 \item [Name = \lt{}name\gt{}]
105    \index[dir]{Name}
106    \index[dir]{Directive!Name}
107    The director name used by the system  administrator. This directive is
108 required.
109
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.
116
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
129    it.
130
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
133    security reasons.
134
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.
143
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.
160
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.
165
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
175    properly expanded.
176
177    The PID directory specified must already exist and be
178    readable and writable by the Bacula daemon referencing it
179
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.
183
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
193    expanded.
194
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.
204
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.
215
216 \label{DirMaxConJobs}
217
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
226    larger number.
227
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.
235
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.
243
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.
251
252    \label{Director:Director:DirAddresses}
253 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
254    \index[dir]{DirAddresses}
255    \index[dir]{Address}
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:
261
262 \footnotesize
263 \begin{lstlisting}
264  DirAddresses  = {
265     ip = { addr = 1.2.3.4; port = 1205;}
266     ipv4 = {
267         addr = 1.2.3.4; port = http;}
268     ipv6 = {
269         addr = 1.2.3.4;
270         port = 1205;
271     }
272     ip = {
273         addr = 1.2.3.4
274         port = 1205
275     }
276     ip = { addr = 1.2.3.4 }
277     ip = { addr = 201:220:222::2 }
278     ip = {
279         addr = bluedot.thun.net
280     }
281 }
282 \end{lstlisting}
283 \normalsize
284
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.
292
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
295 resource.
296
297    \label{Director:Director:DirPort}
298 \item [DirPort = \lt{}port-number\gt{}]
299    \index[dir]{DirPort}
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)
306    directive.
307
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.
320
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).
330
331 \phantomsection
332 \label{Director:Director:StatisticsRetention}
333 \item[Statistics Retention = \lt{}time\gt{}]
334    \index[dir]{StatisticsRetention}
335    \label{PruneStatistics}
336    \index[dir]{Directive!StatisticsRetention}
337
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.
343
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.
347
348    See the \ilink{ Configuration chapter}{Time} of this manual for additional
349    details of time specification.
350
351    The default is 5 years.
352
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.
358
359   \label{Director:Director:MaximumConsoleConnections}
360 \item[MaximumConsoleConnections = \lt{}number\gt{}]
361   \index[dir]{MaximumConsoleConnections}
362   \index[dir]{Directive!MaximumConsoleConnections}
363   \index[dir]{Console}
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
366    larger number.
367
368 \label{Director:Director:MaximumReloadRequests}
369  \item[MaximumReloadRequests = \lt{}number\gt{}]
370 \index[dir]{MaximumReloadRequests}
371 \index[dir]{Directive!MaximumReloadRequests}
372 \index[dir]{Console}
373
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
376 sufficient.
377
378 \label{Director:Director:End}
379
380 %   \label{Director:SharedStorage}
381 %\item[SharedStorage = \lt{}yes\vb{}no\gt{}]
382 %   \index[dir]{SharedStorage}
383 %   \index[dir]{Directive!SharedStorage}
384 %
385 %   The \texttt{Shared Storage} directive is a Bacula Enterprise feature that
386 %   allows you to share volumes between different Storage resources. This
387 %   directive should be used \textbf{only} if all \texttt{Media Type} are
388 %   correctly set across all Devices.
389 %
390 %   The \texttt{Shared Storage} directive should be used when using the SAN
391 %   Shared Storage plugin or when accessing from the Director Storage resources
392 %   directly to Devices of an Autochanger.
393 %
394 %   When sharing volumes between different Storage resources, you will
395 %   need also to use the \texttt{reset-storageid} script before using the
396 %   \texttt{update slots} command. This script can be scheduled once a day in
397 %   an Admin job.
398 %
399 %\begin{lstlisting}
400 % $ /opt/bacula/scripts/reset-storageid MediaType StorageName
401 % $ bconsole
402 % * update slots storage=StorageName drive=0
403 %\end{lstlisting}
404 %
405 %   Please contact Bacula Systems support to get help on this advanced
406 %   configuration.
407
408 \end{description}
409
410 The following is an example of a valid Director resource definition:
411
412 \footnotesize
413 \begin{lstlisting}
414 Director {
415   Name = HeadMan
416   WorkingDirectory = "$HOME/bacula/bin/working"
417   Password = UA_password
418   PidDirectory = "$HOME/bacula/bin/working"
419   QueryFile = "$HOME/bacula/bin/query.sql"
420   Messages = Standard
421 }
422 \end{lstlisting} %% $
423 \normalsize
424
425 \label{JobResource}
426 \section{The Job Resource}
427 \index[general]{Resource!Job}
428 \index[general]{Job Resource}
429
430 The Job resource defines a Job (Backup, Restore, \ldots{}) that Bacula must
431 perform. Each Job resource definition contains the name of a Client and
432 a FileSet to backup, the Schedule for the Job, where the data
433 are to be stored, and what media Pool can be used. In effect, each Job
434 resource must specify What, Where, How, and When or FileSet, Storage,
435 Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
436 be specified for a restore job for historical reasons, but it is no longer used.
437
438 Only a single type ({\bf Backup}, {\bf Restore}, \ldots{}) can be specified for any
439 job. If you want to backup multiple FileSets on the same Client or multiple
440 Clients, you must define a Job for each one.
441
442 Note, you define only a single Job to do the Full, Differential, and
443 Incremental backups since the different backup levels are tied together by
444 a unique Job name.  Normally, you will have only one Job per Client, but
445 if a client has a really huge number of files (more than several million),
446 you might want to split it into to Jobs each with a different FileSet
447 covering only part of the total files.
448
449 Multiple Storage daemons are not currently supported for Jobs, so if
450 you do want to use multiple storage daemons, you will need to create
451 a different Job and ensure that for each Job that the combination of
452 Client and FileSet are unique.  The Client and FileSet are what Bacula
453 uses to restore a client, so if there are multiple Jobs with the same
454 Client and FileSet or multiple Storage daemons that are used, the
455 restore will not work.  This problem can be resolved by defining multiple
456 FileSet definitions (the names must be different, but the contents of
457 the FileSets may be the same).
458
459
460 \begin{description}
461
462 \item [Job]
463    \index[dir]{Job}
464    \index[dir]{Directive!Job}
465    Start of the Job resource. At least one Job  resource is required.
466
467    \label{Director:Job:Name}
468 \item [Name = \lt{}name\gt{}]
469    \index[dir]{Name}
470    \index[dir]{Directive!Name}
471    The Job name. This name can be specified  on the {\bf Run} command in the
472    console program to start a job. If the  name contains spaces, it must be
473    specified between quotes. It is  generally a good idea to give your job the
474    same name as the Client  that it will backup. This permits easy
475    identification of jobs.
476
477    When the job actually runs, the unique Job Name will consist  of the name you
478    specify here followed by the date and time the  job was scheduled for
479    execution. This directive is required.
480
481   \label{Director:Job:Enabled}
482 \item [Enabled = \lt{}yes\vb{}no\gt{}]
483   \index[dir]{Enable}
484   \index[dir]{Directive!Enable}
485   This directive allows you to enable or disable automatic execution
486   via the scheduler of a Job.
487
488    \label{Director:Job:Type}
489 \item [Type = \lt{}job-type\gt{}]
490    \index[dir]{Type}
491    \index[dir]{Directive!Type}
492    The {\bf Type} directive specifies  the Job type, which may be one of the
493    following: {\bf Backup},  {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
494    directive  is required. Within a particular Job Type, there are also Levels
495    as discussed in the next item.
496
497 \begin{description}
498
499 \item [Backup]
500    \index[dir]{Backup}
501    Run a backup Job. Normally you will  have at least one Backup job for each
502    client you want  to save. Normally, unless you turn off cataloging,  most all
503    the important statistics and data concerning  files backed up will be placed
504    in the catalog.
505
506 \item [Restore]
507    \index[dir]{Restore}
508    Run a restore Job.  Normally, you will specify only one Restore job
509    which acts as a sort of prototype that you will modify using the console
510    program in order to perform restores.  Although certain basic
511    information from a Restore job is saved in the catalog, it is very
512    minimal compared to the information stored for a Backup job -- for
513    example, no File database entries are generated since no Files are
514    saved.
515
516    {\bf Restore} jobs cannot be
517    automatically started by the scheduler as is the case for Backup, Verify
518    and Admin jobs. To restore files, you must use the {\bf restore} command
519    in the console.
520
521
522 \item [Verify]
523    \index[dir]{Verify}
524    Run a verify Job. In general, {\bf verify}  jobs permit you to compare the
525    contents of the catalog  to the file system, or to what was backed up. In
526    addition,  to verifying that a tape that was written can be read,  you can
527    also use {\bf verify} as a sort of tripwire  intrusion detection.
528
529 \item [Admin]
530    \index[dir]{Admin}
531    Run an admin Job. An {\bf Admin} job can  be used to periodically run catalog
532    pruning, if you  do not want to do it at the end of each {\bf Backup}  Job.
533    Although an Admin job is recorded in the  catalog, very little data is saved.
534 \end{description}
535 \label{Level}
536
537
538 \label{Director:Job:Level}
539 \item [Level = \lt{}job-level\gt{}]
540 \index[dir]{Level}
541 \index[dir]{Directive!Level}
542    The Level directive specifies the default Job level to be run.  Each
543    different Job Type (Backup, Restore, \ldots{}) has a different set of Levels
544    that can be specified.  The Level is normally overridden by a different
545    value that is specified in the {\bf Schedule} resource.  This directive
546    is not required, but must be specified either by a {\bf Level} directive
547    or as an override specified in the {\bf Schedule} resource.
548
549 For a {\bf Backup} Job, the Level may be one of the  following:
550
551 \begin{description}
552
553 \item [Full]
554 \index[dir]{Full}
555    When the Level is set to Full all files in the FileSet whether or not
556    they have changed will be backed up.
557
558 \item [Incremental]
559    \index[dir]{Incremental}
560    When the Level is set to Incremental all files specified in the FileSet
561    that have changed since the last successful backup of the the same Job
562    using the same FileSet and Client, will be backed up.  If the Director
563    cannot find a previous valid Full backup then the job will be upgraded
564    into a Full backup.  When the Director looks for a valid backup record
565    in the catalog database, it looks for a previous Job with:
566
567 \begin{bsysitemize}
568 \item The same Job name.
569 \item The same Client name.
570 \item The same FileSet (any change to the definition of  the FileSet such as
571    adding or deleting a file in the  Include or Exclude sections constitutes a
572    different FileSet.
573 \item The Job was a Full, Differential, or Incremental backup.
574 \item The Job terminated normally (i.e. did not fail or was not  canceled).
575 \item The Job started no longer ago than {\bf Max Full Interval}.
576 \end{bsysitemize}
577
578    If all the above conditions do not hold, the Director will upgrade  the
579    Incremental to a Full save. Otherwise, the Incremental  backup will be
580    performed as requested.
581
582    The File daemon (Client) decides which files to backup for an
583    Incremental backup by comparing start time of the prior Job (Full,
584    Differential, or Incremental) against the time each file was last
585    ``modified'' (st\_mtime) and the time its attributes were last
586    ``changed''(st\_ctime).  If the file was modified or its attributes
587    changed on or after this start time, it will then be backed up.
588
589    Some virus scanning software may change st\_ctime while
590    doing the scan.  For example, if the virus scanning program attempts to
591    reset the access time (st\_atime), which Bacula does not use, it will
592    cause st\_ctime to change and hence Bacula will backup the file during
593    an Incremental or Differential backup.  In the case of Sophos virus
594    scanning, you can prevent it from resetting the access time (st\_atime)
595    and hence changing st\_ctime by using the {\bf \lstinline:--:no-reset-atime}
596    option.  For other software, please see their manual.
597
598    When Bacula does an Incremental backup, all modified files that are
599    still on the system are backed up.  However, any file that has been
600    deleted since the last Full backup remains in the Bacula catalog,
601    which means that if between a Full save and the time you do a
602    restore, some files are deleted, those deleted files will also be
603    restored.  The deleted files will no longer appear in the catalog
604    after doing another Full save.
605
606    In addition, if you move a directory rather than copy it, the files in
607    it do not have their modification time (st\_mtime) or their attribute
608    change time (st\_ctime) changed.  As a consequence, those files will
609    probably not be backed up by an Incremental or Differential backup which
610    depend solely on these time stamps.  If you move a directory, and wish
611    it to be properly backed up, it is generally preferable to copy it, then
612    delete the original.
613
614    However, to manage deleted files or directories changes in the
615    catalog during an Incremental backup you can use \texttt{accurate}
616    mode. This is quite memory consuming process. See \ilink{Accurate
617      mode}{accuratemode} for more details.
618
619 \item [Differential]
620    \index[dir]{Differential}
621    When the Level is set to Differential
622    all files specified in the FileSet that have changed since the last
623    successful Full backup of the same Job will be backed up.
624    If the Director cannot find a
625    valid previous Full backup for the same Job, FileSet, and Client,
626    backup, then the Differential job will be upgraded into a Full backup.
627    When the Director looks for a valid Full backup record in the catalog
628    database, it looks for a previous Job with:
629
630 \begin{bsysitemize}
631 \item The same Job name.
632 \item The same Client name.
633 \item The same FileSet (any change to the definition of  the FileSet such as
634    adding or deleting a file in the  Include or Exclude sections constitutes a
635    different FileSet.
636 \item The Job was a FULL backup.
637 \item The Job terminated normally (i.e. did not fail or was not  canceled).
638 \item The Job started no longer ago than {\bf Max Full Interval}.
639 \end{bsysitemize}
640
641    If all the above conditions do not hold, the Director will  upgrade the
642    Differential to a Full save. Otherwise, the  Differential backup will be
643    performed as requested.
644
645    The File daemon (Client) decides which files to backup for a
646    differential backup by comparing the start time of the prior Full backup
647    Job against the time each file was last ``modified'' (st\_mtime) and the
648    time its attributes were last ``changed'' (st\_ctime).  If the file was
649    modified or its attributes were changed on or after this start time, it
650    will then be backed up.  The start time used is displayed after the {\bf
651    Since} on the Job report.  In rare cases, using the start time of the
652    prior backup may cause some files to be backed up twice, but it ensures
653    that no change is missed.  As with the Incremental option, you should
654    ensure that the clocks on your server and client are synchronized or as
655    close as possible to avoid the possibility of a file being skipped.
656    Note, on versions 1.33 or greater Bacula automatically makes the
657    necessary adjustments to the time between the server and the client so
658    that the times Bacula uses are synchronized.
659
660    When Bacula does a Differential backup, all modified files that are
661    still on the system are backed up.  However, any file that has been
662    deleted since the last Full backup remains in the Bacula catalog, which
663    means that if between a Full save and the time you do a restore, some
664    files are deleted, those deleted files will also be restored.  The
665    deleted files will no longer appear in the catalog after doing another
666    Full save.  However, to remove deleted files from the catalog during a
667    Differential backup is quite a time consuming process and not currently
668    implemented in Bacula.  It is, however, a planned future feature.
669
670    As noted above, if you move a directory rather than copy it, the
671    files in it do not have their modification time (st\_mtime) or
672    their attribute change time (st\_ctime) changed.  As a
673    consequence, those files will probably not be backed up by an
674    Incremental or Differential backup which depend solely on these
675    time stamps.  If you move a directory, and wish it to be
676    properly backed up, it is generally preferable to copy it, then
677    delete the original. Alternatively, you can move the directory, then
678    use the {\bf touch} program to update the timestamps.
679
680 %% TODO: merge this with incremental
681    However, to manage deleted files or directories changes in the
682    catalog during an Differential backup you can use \texttt{accurate}
683    mode. This is quite memory consuming process. See \ilink{Accurate
684      mode}{accuratemode} for more details.
685
686    Every once and a while, someone asks why we need Differential
687    backups as long as Incremental backups pickup all changed files.
688    There are possibly many answers to this question, but the one
689    that is the most important for me is that a Differential backup
690    effectively merges
691    all the Incremental and Differential backups since the last Full backup
692    into a single Differential backup.  This has two effects: 1.  It gives
693    some redundancy since the old backups could be used if the merged backup
694    cannot be read.  2.  More importantly, it reduces the number of Volumes
695    that are needed to do a restore effectively eliminating the need to read
696    all the volumes on which the preceding Incremental and Differential
697    backups since the last Full are done.
698
699 \item [VirtualFull]
700    \index[dir]{VirtualFull}
701
702    When the Level is set to VirtualFull, it permits you to consolidate the
703    previous Full backup plus the most recent Differential backup and any
704    subsequent Incremental backups into a new Full backup.  This new Full backup
705    will then be considered as the most recent Full for any future Incremental
706    or Differential backups.  The VirtualFull backup is accomplished without
707    contacting the client by reading the previous backup data and writing it to
708    a volume in a different pool.
709
710    Bacula's virtual backup feature is often called Synthetic Backup or
711    Consolidation in other backup products.
712
713 \end{description}
714
715 For a {\bf Restore} Job, no level needs to be specified.
716
717 For a {\bf Verify} Job, the Level may be one of the  following:
718
719 \begin{description}
720
721 \item [InitCatalog]
722 \index[dir]{InitCatalog}
723    does a scan of the specified {\bf FileSet} and stores the file
724    attributes in the Catalog database.  Since no file data is saved, you
725    might ask why you would want to do this.  It turns out to be a very
726    simple and easy way to have a {\bf Tripwire} like feature using {\bf
727    Bacula}.  In other words, it allows you to save the state of a set of
728    files defined by the {\bf FileSet} and later check to see if those files
729    have been modified or deleted and if any new files have been added.
730    This can be used to detect system intrusion.  Typically you would
731    specify a {\bf FileSet} that contains the set of system files that
732    should not change (e.g.  /sbin, /boot, /lib, /bin, \ldots{}).  Normally, you
733    run the {\bf InitCatalog} level verify one time when your system is
734    first setup, and then once again after each modification (upgrade) to
735    your system.  Thereafter, when your want to check the state of your
736    system files, you use a {\bf Verify} {\bf level = Catalog}.  This
737    compares the results of your {\bf InitCatalog} with the current state of
738    the files.
739
740 \item [Catalog]
741 \index[dir]{Catalog}
742    Compares the current state of the files against the state previously
743    saved during an {\bf InitCatalog}.  Any discrepancies are reported.  The
744    items reported are determined by the {\bf verify} options specified on
745    the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
746    FileSet} resource below for more details).  Typically this command will
747    be run once a day (or night) to check for any changes to your system
748    files.
749
750    Please note!  If you run two Verify Catalog jobs on the same client at
751    the same time, the results will certainly be incorrect.  This is because
752    Verify Catalog modifies the Catalog database while running in order to
753    track new files.
754
755 \item [VolumeToCatalog]
756 \index[dir]{VolumeToCatalog}
757    This level causes Bacula to read the file attribute data written to the
758    Volume from the last backup Job for the job specified on the {\bf VerifyJob}
759    directive.  The file attribute data are compared to the
760    values saved in the Catalog database and any differences are reported.
761    This is similar to the {\bf DiskToCatalog} level except that instead of
762    comparing the disk file attributes to the catalog database, the
763    attribute data written to the Volume is read and compared to the catalog
764    database.  Although the attribute data including the signatures (MD5 or
765    SHA1) are compared, the actual file data is not compared (it is not in
766    the catalog).
767
768    Please note!  If you run two Verify VolumeToCatalog jobs on the same
769    client at the same time, the results will certainly be incorrect.  This
770    is because the Verify VolumeToCatalog modifies the Catalog database
771    while running.
772
773 \item [DiskToCatalog]
774 \index[dir]{DiskToCatalog}
775    This level causes Bacula to read the files as they currently are on
776    disk, and to compare the current file attributes with the attributes
777    saved in the catalog from the last backup for the job specified on the
778    {\bf VerifyJob} directive.  This level differs from the {\bf VolumeToCatalog}
779    level described above by the fact that it doesn't compare against a
780    previous Verify job but against a previous backup.  When you run this
781    level, you must supply the verify options on your Include statements.
782    Those options determine what attribute fields are compared.
783
784    This command can be very useful if you have disk problems because it
785    will compare the current state of your disk against the last successful
786    backup, which may be several jobs.
787
788    Note, the current implementation (1.32c) does not identify files that
789    have been deleted.
790 \end{description}
791
792 \label{Director:Job:Accurate}
793 \item [Accurate = \lt{}yes\vb{}no\gt{}]
794 \index[dir]{Accurate}
795    In accurate mode, the File daemon knowns exactly which files were present
796    after the last backup. So it is able to handle deleted or renamed files.
797
798    When restoring a FileSet for a specified date (including ``most
799    recent''), Bacula is able to restore exactly the files and
800    directories that existed at the time of the last backup prior to
801    that date including ensuring that deleted files are actually deleted,
802    and renamed directories are restored properly.
803
804    In this mode, the File daemon must keep data concerning all files in
805    memory.  So If you do not have sufficient memory, the backup may
806    either be terribly slow or fail.
807
808 %%   $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
809
810    For 500.000 files (a typical desktop linux system), it will require
811    approximately 64 Megabytes of RAM on your File daemon to hold the
812    required information.
813
814    \label{Director:Job:VerifyJob}
815 \item [Verify Job = \lt{}Job-Resource-Name\gt{}]
816    \index[dir]{Verify Job}
817    \index[dir]{Directive!Verify Job}
818    If you run a verify job without this directive, the last job run will be
819    compared with the catalog, which means that you must immediately follow
820    a backup by a verify command.  If you specify a {\bf Verify Job} Bacula
821    will find the last job with that name that ran.  This permits you to run
822    all your backups, then run Verify jobs on those that you wish to be
823    verified (most often a {\bf VolumeToCatalog}) so that the tape just
824    written is re-read.
825
826 \label{Director:Job:JobDefs}
827 \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
828 \index[dir]{JobDefs}
829 \index[dir]{Directive!JobDefs}
830    If a JobDefs-Resource-Name is specified, all the values contained in the
831    named JobDefs resource will be used as the defaults for the current Job.
832    Any value that you explicitly define in the current Job resource, will
833    override any defaults specified in the JobDefs resource.  The use of
834    this directive permits writing much more compact Job resources where the
835    bulk of the directives are defined in one or more JobDefs.  This is
836    particularly useful if you have many similar Jobs but with minor
837    variations such as different Clients.  A simple example of the use of
838    JobDefs is provided in the default bacula-dir.conf file.
839
840 \label{Director:Job:Bootstrap}
841 \item [Bootstrap = \lt{}bootstrap-file\gt{}]
842 \index[dir]{Bootstrap}
843 \index[dir]{Directive!Bootstrap}
844    The Bootstrap directive specifies a bootstrap file that, if provided,
845    will be used during {\bf Restore} Jobs and is ignored in other Job
846    types.  The {\bf bootstrap} file contains the list of tapes to be used
847    in a restore Job as well as which files are to be restored.
848    Specification of this directive is optional, and if specified, it is
849    used only for a restore job.  In addition, when running a Restore job
850    from the console, this value can be changed.
851
852    If you use the {\bf Restore} command in the Console program, to start a
853    restore job, the {\bf bootstrap} file will be created automatically from
854    the files you select to be restored.
855
856    For additional details of the {\bf bootstrap} file, please see
857    \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
858    of this manual.
859 \label{writebootstrap}
860
861 \label{Director:Job:WriteBootstrap}
862 \item [Write Bootstrap =  \lt{}bootstrap-file-specification\gt{}]
863 \index[dir]{Write Bootstrap}
864 \index[dir]{Directive!Write Bootstrap}
865    The {\bf writebootstrap} directive specifies a file name where Bacula
866    will write a {\bf bootstrap} file for each Backup job run.  This
867    directive applies only to Backup Jobs.  If the Backup job is a Full
868    save, Bacula will erase any current contents of the specified file
869    before writing the bootstrap records.  If the Job is an Incremental
870    or Differential
871    save, Bacula will append the current bootstrap record to the end of the
872    file.
873
874    Using this feature, permits you to constantly have a bootstrap file that
875    can recover the current state of your system.  Normally, the file
876    specified should be a mounted drive on another machine, so that if your
877    hard disk is lost, you will immediately have a bootstrap record
878    available.  Alternatively, you should copy the bootstrap file to another
879    machine after it is updated. Note, it is a good idea to write a separate
880    bootstrap file for each Job backed up including the job that backs up
881    your catalog database.
882
883    If the {\bf bootstrap-file-specification} begins with a vertical bar
884    (\lstinline+|+), Bacula will use the specification as the name of a program to which
885    it will pipe the bootstrap record.  It could for example be a shell
886    script that emails you the bootstrap record.
887
888    On versions 1.39.22 or greater, before opening the file or executing the
889    specified command, Bacula performs
890    \ilink{character substitution}{character substitution} like in RunScript
891    directive. To automatically manage your bootstrap files, you can use
892    this in your {\bf JobDefs} resources:
893 \begin{lstlisting}
894 JobDefs {
895    Write Bootstrap = "%c_%n.bsr"
896    ...
897 }
898 \end{lstlisting}
899
900    For more details on using this file, please see the chapter entitled
901    \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
902
903 \label{Director:Job:Client}
904 \item [Client = \lt{}client-resource-name\gt{}]
905 \index[dir]{Client}
906 \index[dir]{Directive!Client}
907    The Client directive  specifies the Client (File daemon) that will be used in
908    the  current Job. Only a single Client may be specified in any one Job.  The
909    Client runs on the machine to be backed up,  and sends the requested files to
910    the Storage daemon for backup,  or receives them when restoring. For
911    additional details, see the
912    \ilink{Client Resource section}{ClientResource} of this chapter.
913    This directive is required.
914
915 \label{Director:Job:Fileset}
916 \item [FileSet = \lt{}FileSet-resource-name\gt{}]
917 \index[dir]{FileSet}
918 \index[dir]{Directive!FileSet}
919    The FileSet directive specifies the FileSet that will be used in the
920    current Job.  The FileSet specifies which directories (or files) are to
921    be backed up, and what options to use (e.g.  compression, \ldots{}).  Only a
922    single FileSet resource may be specified in any one Job.  For additional
923    details, see the \ilink{FileSet Resource section}{FileSetResource} of
924    this chapter.  This directive is required.
925
926 \label{Director:Job:Base}
927 \item [Base = \lt{}job-resource-name, \ldots{}\gt{}]
928 \index[dir]{Base}
929 \index[dir]{Directive!Base}
930 The Base directive permits to specify the list of jobs that will be used during
931 Full backup as base. This directive is optional. See the \ilink{Base Job
932 chapter}{basejobs} for more information.
933
934 \label{Director:Job:Messages}
935 \item [Messages = \lt{}messages-resource-name\gt{}]
936 \index[dir]{Messages}
937 \index[dir]{Directive!Messages}
938    The Messages directive defines what Messages resource should be used for
939    this job, and thus how and where the various messages are to be
940    delivered.  For example, you can direct some messages to a log file, and
941    others can be sent by email.  For additional details, see the
942    \ilink{Messages Resource}{MessagesChapter} Chapter of this manual.  This
943    directive is required.
944
945 \label{Director:Job:Pool}
946 \item [Pool = \lt{}pool-resource-name\gt{}]
947 \index[dir]{Pool}
948 \index[dir]{Directive!Pool}
949    The Pool directive defines the pool of Volumes where your data can be
950    backed up.  Many Bacula installations will use only the {\bf Default}
951    pool.  However, if you want to specify a different set of Volumes for
952    different Clients or different Jobs, you will probably want to use
953    Pools.  For additional details, see the \ilink{Pool Resource
954    section}{PoolResource} of this chapter.  This directive is required.
955
956 \label{Director:Job:FullBackupPool}
957 \item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
958 \index[dir]{Full Backup Pool}
959 \index[dir]{Directive!Full Backup Pool}
960    The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
961    It will override any Pool specification during a Full backup.  This
962    directive is optional.
963
964 \label{Director:Job:DifferentialBackupPool}
965 \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
966 \index[dir]{Differential Backup Pool}
967 \index[dir]{Directive!Differential Backup Pool}
968    The {\it Differential Backup Pool} specifies a Pool to be used for
969    Differential backups.  It will override any Pool specification during a
970    Differential backup.  This directive is optional.
971
972 \label{Director:Job:IncrementalBackupPool}
973 \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
974 \index[dir]{Incremental Backup Pool}
975 \index[dir]{Directive!Incremental Backup Pool}
976    The {\it Incremental Backup Pool} specifies a Pool to be used for
977    Incremental backups.  It will override any Pool specification during an
978    Incremental backup.  This directive is optional.
979
980 \label{Director:Job:Schedule}
981 \item [Schedule = \lt{}schedule-name\gt{}]
982 \index[dir]{Schedule}
983 \index[dir]{Directive!Schedule}
984    The Schedule directive defines what schedule is to be used for the Job.
985    The schedule in turn determines when the Job will be automatically
986    started and what Job level (i.e.  Full, Incremental, \ldots{}) is to be run.
987    This directive is optional, and if left out, the Job can only be started
988    manually using the Console program.  Although you may specify only a
989    single Schedule resource for any one job, the Schedule resource may
990    contain multiple {\bf Run} directives, which allow you to run the Job at
991    many different times, and each {\bf run} directive permits overriding
992    the default Job Level Pool, Storage, and Messages resources.  This gives
993    considerable flexibility in what can be done with a single Job.  For
994    additional details, see the \ilink{Schedule Resource
995    Chapter}{ScheduleResource} of this manual.
996
997
998 \label{Director:Job:Storage}
999 \item [Storage = \lt{}storage-resource-name\gt{}]
1000 \index[dir]{Storage}
1001 \index[dir]{Directive!Storage}
1002    The Storage directive defines the name of the storage services where you
1003    want to backup the FileSet data.  For additional details, see the
1004    \ilink{Storage Resource Chapter}{StorageResource} of this manual.
1005    The Storage resource may also be specified in the Job's Pool resource,
1006    in which case the value in the Pool resource overrides any value
1007    in the Job. This Storage resource definition is not required by either
1008    the Job resource or in the Pool, but it must be specified in
1009    one or the other, if not an error will result.
1010
1011 \label{Director:Job:MaxStartDelay}
1012 \item [Max Start Delay = \lt{}time\gt{}]
1013 \index[dir]{Max Start Delay}
1014 \index[dir]{Directive!Max Start Delay}
1015    The time specifies the maximum delay between the scheduled time and the
1016    actual start time for the Job.  For example, a job can be scheduled to
1017    run at 1:00am, but because other jobs are running, it may wait to run.
1018    If the delay is set to 3600 (one hour) and the job has not begun to run
1019    by 2:00am, the job will be canceled.  This can be useful, for example,
1020    to prevent jobs from running during day time hours.  The default is 0
1021    which indicates no limit.
1022
1023 \label{Director:Job:MaxRunTime}
1024 \item [Max Run Time = \lt{}time\gt{}]
1025 \index[dir]{Max Run Time}
1026 \index[dir]{Directive!Max Run Time}
1027    The time specifies the maximum allowed time that a job may run, counted
1028    from when the job starts, ({\bf not} necessarily the same as when the
1029    job was scheduled).
1030
1031    By default, the the watchdog thread will kill any Job that has run more
1032    than 6 days.  The maximum watchdog timeout is independent of MaxRunTime
1033    and cannot be changed.
1034
1035
1036 \label{Director:Job:IncrementalWaitRunTime}
1037 \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
1038 \index[dir]{Incremental Wait Run Time}
1039 \index[dir]{Differential Wait Run Time}
1040 \index[dir]{Directive!Differential Max Wait Time}
1041     Theses directives have been deprecated in favor of
1042     \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
1043
1044 \label{Director:Job:IncrementalMaxRunTime}
1045 \item [Incremental Max Run Time = \lt{}time\gt{}]
1046 \index[dir]{Incremental Max Run Time}
1047 \index[dir]{Directive!Incremental Max Run Time}
1048 The time specifies the maximum allowed time that an Incremental backup job may
1049 run, counted from when the job starts, ({\bf not} necessarily the same as when
1050 the job was scheduled).
1051
1052 \label{Director:Job:DifferentialMaxRunTime}
1053 \item [Differential Max Wait Time = \lt{}time\gt{}]
1054 \index[dir]{Differential Max Run Time}
1055 \index[dir]{Directive!Differential Max Run Time}
1056 The time specifies the maximum allowed time that a Differential backup job may
1057 run, counted from when the job starts, ({\bf not} necessarily the same as when
1058 the job was scheduled).
1059
1060 \label{Director:Job:MaxRunSchedTime}
1061 \item [Max Run Sched Time = \lt{}time\gt{}]
1062 \index[dir]{Max Run Sched Time}
1063 \index[dir]{Directive!Max Run Sched Time}
1064
1065 The time specifies the maximum allowed time that a job may run, counted from
1066 when the job was scheduled. This can be useful to prevent jobs from running
1067 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1068   Time}.
1069
1070 \label{Director:Job:MaxWaitTime}
1071 \item [Max Wait Time = \lt{}time\gt{}]
1072 \index[dir]{Max Wait Time}
1073 \index[dir]{Directive!Max Wait Time}
1074    The time specifies the maximum allowed time that a job may block waiting
1075    for a resource (such as waiting for a tape to be mounted, or waiting for
1076    the storage or file daemons to perform their duties), counted from the
1077    when the job starts, ({\bf not} necessarily the same as when the job was
1078    scheduled). This directive works as expected since bacula 2.3.18.
1079
1080 \bsysimageH{different_time}{Job time control directives}{fig:differenttime}
1081
1082 \label{Director:Job:MaximumBandwidth}
1083 \item [Maximum Bandwidth = \lt{}speed\gt{}]
1084 \index[dir]{Maximum Bandwidth}
1085 \index[dir]{Directive!Maximum Bandwidth}
1086
1087 The speed parameter specifies the maximum allowed bandwidth that a job may
1088 use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
1089
1090 \label{Director:Job:MaxFullInterval}
1091 \item [Max Full Interval = \lt{}time\gt{}]
1092 \index[dir]{Max Full Interval}
1093 \index[dir]{Directive!Max Full Interval}
1094    The time specifies the maximum allowed age (counting from start time) of
1095    the most recent successful Full backup that is required in order to run
1096    Incremental or Differential backup jobs. If the most recent Full backup
1097    is older than this interval, Incremental and Differential backups will be
1098    upgraded to Full backups automatically. If this directive is not present,
1099    or specified as 0, then the age of the previous Full backup is not
1100    considered.
1101 \label{PreferMountedVolumes}
1102
1103 \label{Director:Job:PreferMountedVolumes}
1104 \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
1105 \index[dir]{Prefer Mounted Volumes}
1106 \index[dir]{Directive!Prefer Mounted Volumes}
1107    If the Prefer Mounted Volumes directive is set to {\bf yes} (default
1108    yes), the Storage daemon is requested to select either an Autochanger or
1109    a drive with a valid Volume already mounted in preference to a drive
1110    that is not ready.  This means that all jobs will attempt to append
1111    to the same Volume (providing the Volume is appropriate -- right Pool,
1112    \ldots{} for that job), unless you are using multiple pools.
1113    If no drive with a suitable Volume is available, it
1114    will select the first available drive.  Note, any Volume that has
1115    been requested to be mounted, will be considered valid as a mounted
1116    volume by another job.  This if multiple jobs start at the same time
1117    and they all prefer mounted volumes, the first job will request the
1118    mount, and the other jobs will use the same volume.
1119
1120    If the directive is set to {\bf no}, the Storage daemon will prefer
1121    finding an unused drive, otherwise, each job started will append to the
1122    same Volume (assuming the Pool is the same for all jobs).  Setting
1123    Prefer Mounted Volumes to no can be useful for those sites
1124    with multiple drive autochangers that prefer to maximize backup
1125    throughput at the expense of using additional drives and Volumes.
1126    This means that the job will prefer to use an unused drive rather
1127    than use a drive that is already in use.
1128
1129    Despite the above, we recommend against setting this directive to
1130    {\bf no} since
1131    it tends to add a lot of swapping of Volumes between the different
1132    drives and can easily lead to deadlock situations in the Storage
1133    daemon. We will accept bug reports against it, but we cannot guarantee
1134    that we will be able to fix the problem in a reasonable time.
1135
1136    A better alternative for using multiple drives is to use multiple
1137    pools so that Bacula will be forced to mount Volumes from those Pools
1138    on different drives.
1139
1140 \label{Director:Job:PruneJobs}
1141 \item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
1142 \index[dir]{Prune Jobs}
1143 \index[dir]{Directive!Prune Jobs}
1144    Normally, pruning of Jobs from the Catalog is specified on a Client by
1145    Client basis in the Client resource with the {\bf AutoPrune} directive.
1146    If this directive is specified (not normally) and the value is {\bf
1147    yes}, it will override the value specified in the Client resource.  The
1148    default is {\bf no}.
1149
1150
1151 \label{Director:Job:PruneFiles}
1152 \item [Prune Files = \lt{}yes\vb{}no\gt{}]
1153 \index[dir]{Prune Files}
1154 \index[dir]{Directive!Prune Files}
1155    Normally, pruning of Files from the Catalog is specified on a Client by
1156    Client basis in the Client resource with the {\bf AutoPrune} directive.
1157    If this directive is specified (not normally) and the value is {\bf
1158    yes}, it will override the value specified in the Client resource.  The
1159    default is {\bf no}.
1160
1161 \label{Director:Job:PruneVolumes}
1162 \item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
1163 \index[dir]{Prune Volumes}
1164 \index[dir]{Directive!Prune Volumes}
1165    Normally, pruning of Volumes from the Catalog is specified on a Pool by
1166    Pool basis in the Pool resource with the {\bf AutoPrune} directive.
1167    Note, this is different from File and Job pruning which is done on a
1168    Client by Client basis.  If this directive is specified (not normally)
1169    and the value is {\bf yes}, it will override the value specified in the
1170    Pool resource.  The default is {\bf no}.
1171
1172    \label{Director:Job:Runscript}
1173 \item [RunScript \{\lt{}body-of-runscript\gt{}\}]
1174    \index[dir]{RunScript}
1175    \index[dir]{Directive!Run Script}
1176
1177    The RunScript directive behaves like a resource in that it
1178    requires opening and closing braces around a number of directives
1179    that make up the body of the runscript.
1180
1181    The specified {\bf Command} (see below for details) is run as an external
1182    program prior or after the current Job.  This is optional.  By default, the
1183    program is executed on the Client side like in \texttt{ClientRunXXXJob}.
1184
1185    \textbf{Console} options are special commands that are sent to the director instead
1186    of the OS. At this time, console command ouputs are redirected to log with
1187    the jobid 0.
1188
1189    You can use following console command : \texttt{delete}, \texttt{disable},
1190    \texttt{enable}, \texttt{estimate}, \texttt{list}, \texttt{llist},
1191    \texttt{memory}, \texttt{prune}, \texttt{purge}, \texttt{reload},
1192    \texttt{status}, \texttt{setdebug}, \texttt{show}, \texttt{time},
1193    \texttt{trace}, \texttt{update}, \texttt{version}, \texttt{.client},
1194    \texttt{.jobs}, \texttt{.pool}, \texttt{.storage}.  See console chapter for
1195    more information. You need to specify needed information on command line, nothing
1196    will be prompted. Example :
1197
1198 \begin{lstlisting}
1199    Console = "prune files client=%c"
1200    Console = "update stats age=3"
1201 \end{lstlisting}
1202
1203    You can specify more than one Command/Console option per RunScript.
1204
1205    You can use following options may be specified in the body
1206    of the runscript:\\
1207    \LTXtable{0.95\linewidth}{table_runscript}
1208
1209    Any output sent by the command to standard output will be included in the
1210    Bacula job report.  The command string must be a valid program name or name
1211    of a shell script.
1212
1213    In addition, the command string is parsed then fed to the OS,
1214    which means that the path will be searched to execute your specified
1215    command, but there is no shell interpretation, as a consequence, if you
1216    invoke complicated commands or want any shell features such as redirection
1217    or piping, you must call a shell script and do it inside that script.
1218
1219    Before submitting the specified command to the operating system, Bacula
1220    performs character substitution of the following characters:
1221 \label{character substitution}
1222
1223 \footnotesize
1224 \begin{lstlisting}
1225     %% = %
1226     %b = Job Bytes
1227     %c = Client's name
1228     %d = Daemon's name (Such as host-dir or host-fd)
1229     %D = Director's name (Also valid on file daemon)
1230     %e = Job Exit Status
1231     %f = Job FileSet (Only on director side)
1232     %F = Job Files
1233     %h = Client address
1234     %i = JobId
1235     %j = Unique Job id
1236     %l = Job Level
1237     %n = Job name
1238     %p = Pool name (Only on director side)
1239     %s = Since time
1240     %t = Job type (Backup, ...)
1241     %v = Volume name (Only on director side)
1242     %w = Storage name (Only on director side)
1243     %x = Spooling enabled? ("yes" or "no")
1244
1245 \end{lstlisting}
1246 \normalsize
1247
1248 Some character substitutions are not available in all situations. The Job Exit
1249 Status code \%e edits the following values:
1250
1251
1252 \index[dir]{Exit Status}
1253 \begin{bsysitemize}
1254 \item OK
1255 \item Error
1256 \item Fatal Error
1257 \item Canceled
1258 \item Differences
1259 \item Unknown term code
1260 \end{bsysitemize}
1261
1262    Thus if you edit it on a command line, you will need to enclose
1263    it within some sort of quotes.
1264
1265 \label{Director:Job:End}
1266
1267 You can use these following shortcuts:\\
1268
1269 \LTXtable{0.95\linewidth}{table_runscriptshortcuts}
1270 Examples:
1271 \begin{lstlisting}
1272 RunScript {
1273     RunsWhen = Before
1274     FailJobOnError = No
1275     Command = "/etc/init.d/apache stop"
1276 }
1277
1278 RunScript {
1279     RunsWhen = After
1280     RunsOnFailure = yes
1281     Command = "/etc/init.d/apache start"
1282 }
1283 \end{lstlisting}
1284
1285    {\bf Notes about ClientRunBeforeJob}
1286
1287    For compatibility reasons, with this shortcut, the command is executed
1288    directly when the client recieve it. And if the command is in error, other
1289    remote runscripts will be discarded. To be sure that all commands will be
1290    sent and executed, you have to use RunScript syntax.
1291
1292    {\bf Special Windows Considerations}
1293
1294    You can run scripts just after snapshots initializations with
1295    \textsl{AfterVSS} keyword.
1296
1297    In addition, for a Windows client, please take
1298    note that you must ensure a correct path to your script.  The script or
1299    program can be a .com, .exe or a .bat file.  If you just put the program
1300    name in then Bacula will search using the same rules that cmd.exe uses
1301    (current directory, Bacula bin directory, and PATH).  It will even try the
1302    different extensions in the same order as cmd.exe.
1303    The command can be anything that cmd.exe or command.com will recognize
1304    as an executable file.
1305
1306    However, if you have slashes in the program name then Bacula figures you
1307    are fully specifying the name, so you must also explicitly add the three
1308    character extension.
1309
1310    The command is run in a Win32 environment, so Unix like commands will not
1311    work unless you have installed and properly configured Cygwin in addition
1312    to and separately from Bacula.
1313
1314    The System \%Path\% will be searched for the command.  (under the
1315    environment variable dialog you have have both System Environment and
1316    User Environment, we believe that only the System environment will be
1317    available to bacula-fd, if it is running as a service.)
1318
1319    System environment variables can be referenced with \%var\% and
1320    used as either part of the command name or arguments.
1321
1322    So if you have a script in the Bacula\\bin directory then the following lines
1323    should work fine:
1324
1325 \footnotesize
1326 \begin{lstlisting}
1327         Client Run Before Job = systemstate
1328 or
1329         Client Run Before Job = systemstate.bat
1330 or
1331         Client Run Before Job = "systemstate"
1332 or
1333         Client Run Before Job = "systemstate.bat"
1334 or
1335         ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
1336 \end{lstlisting}
1337 \normalsize
1338
1339 The outer set of quotes is removed when the configuration file is parsed.
1340 You need to escape the inner quotes so that they are there when the code
1341 that parses the command line for execution runs so it can tell what the
1342 program name is.
1343
1344
1345 \footnotesize
1346 \begin{lstlisting}
1347 ClientRunBeforeJob = "\"C:/Program Files/Software
1348      Vendor/Executable\" /arg1 /arg2 \"foo bar\""
1349 \end{lstlisting}
1350 \normalsize
1351
1352    The special characters
1353 \begin{lstlisting}
1354 &<>()@^|
1355 \end{lstlisting}
1356    will need to be quoted,
1357    if they are part of a filename or argument.
1358
1359    If someone is logged in, a blank ``command'' window running the commands
1360    will be present during the execution of the command.
1361
1362    Some Suggestions from Phil Stracchino for running on Win32 machines with
1363    the native Win32 File daemon:
1364
1365    \begin{enumerate}
1366    \item You might want the ClientRunBeforeJob directive to specify a .bat
1367       file which runs the actual client-side commands, rather than trying
1368       to run (for example) regedit /e directly.
1369    \item The batch file should explicitly 'exit 0' on successful completion.
1370    \item The path to the batch file should be specified in Unix form:
1371
1372       ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
1373
1374    rather than DOS/Windows form:
1375
1376    ClientRunBeforeJob =
1377
1378 "c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
1379    INCORRECT
1380    \end{enumerate}
1381
1382 For Win32, please note that there are certain limitations:
1383
1384 ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
1385
1386 Lines like the above do not work because there are limitations of
1387 cmd.exe that is used to execute the command.
1388 Bacula prefixes the string you supply with {\bf cmd.exe /c }.  To test that
1389 your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
1390 cmd prompt and see what happens.  Once the command is correct insert a
1391 backslash (\textbackslash{}) before each double quote ("), and
1392 then put quotes around the whole thing when putting it in
1393 the director's .conf file.  You either need to have only one set of quotes
1394 or else use the short name and don't put quotes around the command path.
1395
1396 Below is the output from cmd's help as it relates to the command line
1397 passed to the /c option.
1398
1399
1400  If /C or /K is specified, then the remainder of the command line after
1401  the switch is processed as a command line, where the following logic is
1402  used to process quote (") characters:
1403
1404 \begin{enumerate}
1405 \item
1406      If all of the following conditions are met, then quote characters
1407          on the command line are preserved:
1408     \begin{bsysitemize}
1409        \item no /S switch.
1410        \item exactly two quote characters.
1411        \item no special characters between the two quote characters,
1412            where special is one of:
1413 \begin{lstlisting}
1414 &<>()@^|
1415 \end{lstlisting}
1416        \item there are one or more whitespace characters between the
1417            the two quote characters.
1418        \item the string between the two quote characters is the name
1419            of an executable file.
1420     \end{bsysitemize}
1421
1422 \item  Otherwise, old behavior is to see if the first character is
1423          a quote character and if so, strip the leading character and
1424          remove the last quote character on the command line, preserving
1425          any text after the last quote character.
1426
1427 \end{enumerate}
1428
1429
1430 The following example of the use of the Client Run Before Job directive was
1431 submitted by a user:\\
1432 You could write a shell script to back up a DB2 database to a FIFO. The shell
1433 script is:
1434
1435 \footnotesize
1436 \begin{lstlisting}
1437  #!/bin/sh
1438  # ===== backupdb.sh
1439  DIR=/u01/mercuryd
1440
1441  mkfifo $DIR/dbpipe
1442  db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
1443  sleep 1
1444 \end{lstlisting}
1445 \normalsize
1446
1447 The following line in the Job resource in the bacula-dir.conf file:
1448 \footnotesize
1449 \begin{lstlisting}
1450  Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
1451 '%l'\""
1452 \end{lstlisting}
1453 \normalsize
1454
1455 When the job is run, you will get messages from the output of the script
1456 stating that the backup has started. Even though the command being run is
1457 backgrounded with \&, the job will block until the ``db2 BACKUP DATABASE''
1458 command, thus the backup stalls.
1459
1460 To remedy this situation, the ``db2 BACKUP DATABASE'' line should be changed to
1461 the following:
1462
1463 \footnotesize
1464 \begin{lstlisting}
1465  db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
1466 2>&1 < /dev/null &
1467 \end{lstlisting}
1468 \normalsize
1469
1470 It is important to redirect the input and outputs of a backgrounded command to
1471 /dev/null to prevent the script from blocking.
1472
1473 \label{Director:Job:RunBeforeJob}
1474 \item [Run Before Job = \lt{}command\gt{}]
1475 \index[dir]{Run Before Job}
1476 \index[dir]{Directive!Run Before Job}
1477 \index[dir]{Directive!Run Before Job}
1478 The specified {\bf command} is run as an external program prior to running the
1479 current Job.  This directive is not required, but if it is defined, and if the
1480 exit code of the program run is non-zero, the current Bacula job will be
1481 canceled.
1482
1483 \begin{lstlisting}
1484 Run Before Job = "echo test"
1485 \end{lstlisting}
1486    it's equivalent to :
1487 \begin{lstlisting}
1488 RunScript {
1489  Command = "echo test"
1490  RunsOnClient = No
1491  RunsWhen = Before
1492 }
1493 \end{lstlisting}
1494
1495    Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
1496    simple way to modify your schedules during a holiday.  For example, suppose
1497    that you normally do Full backups on Fridays, but Thursday and Friday are
1498    holidays.  To avoid having to change tapes between Thursday and Friday when
1499    no one is in the office, you can create a RunBeforeJob that returns a
1500    non-zero status on Thursday and zero on all other days.  That way, the
1501    Thursday job will not run, and on Friday the tape you inserted on Wednesday
1502    before leaving will be used.
1503
1504 \label{Director:Job:RunAfterJob}
1505 \item [Run After Job = \lt{}command\gt{}]
1506 \index[dir]{Run After Job}
1507 \index[dir]{Directive!Run After Job}
1508    The specified {\bf command} is run as an external program if the current
1509    job terminates normally (without error or without being canceled).  This
1510    directive is not required.  If the exit code of the program run is
1511    non-zero, Bacula will print a warning message.  Before submitting the
1512    specified command to the operating system, Bacula performs character
1513    substitution as described above for the {\bf RunScript} directive.
1514
1515    An example of the use of this directive is given in the
1516    \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1517
1518    See the {\bf Run After Failed Job} if you
1519    want to run a script after the job has terminated with any
1520    non-normal status.
1521
1522 \label{Director:Job:RunAfterJob}
1523 \item [Run After Failed Job = \lt{}command\gt{}]
1524 \index[dir]{Run After Job}
1525 \index[dir]{Directive!Run After Job}
1526    The specified {\bf command} is run as an external program after the current
1527    job terminates with any error status.  This directive is not required.  The
1528    command string must be a valid program name or name of a shell script. If
1529    the exit code of the program run is non-zero, Bacula will print a
1530    warning message. Before submitting the specified command to the
1531    operating system, Bacula performs character substitution as described above
1532    for the {\bf RunScript} directive. Note, if you wish that your script
1533    will run regardless of the exit status of the Job, you can use this :
1534 \begin{lstlisting}
1535 RunScript {
1536  Command = "echo test"
1537  RunsWhen = After
1538  RunsOnFailure = yes
1539  RunsOnClient  = no
1540  RunsOnSuccess = yes    # default, you can drop this line
1541 }
1542 \end{lstlisting}
1543
1544    An example of the use of this directive is given in the
1545    \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
1546
1547
1548 \label{Director:Job:ClientRunBeforeJob}
1549 \item [Client Run Before Job = \lt{}command\gt{}]
1550 \index[dir]{Client Run Before Job}
1551 \index[dir]{Directive!Client Run Before Job}
1552    This directive is the same as {\bf Run Before Job} except that the
1553    program is run on the client machine.  The same restrictions apply to
1554    Unix systems as noted above for the {\bf RunScript}.
1555
1556    \label{Director:Job:ClientRunAfterJob}
1557 \item [Client Run After Job = \lt{}command\gt{}]
1558    \index[dir]{Client Run After Job}
1559    \index[dir]{Directive!Client Run After Job}
1560    The specified {\bf command} is run on the client machine as soon
1561    as data spooling is complete in order to allow restarting applications
1562    on the client as soon as possible. .
1563
1564    Note, please see the notes above in {\bf RunScript}
1565    concerning Windows clients.
1566
1567    \label{Director:Job:RerunFailedLevels}
1568 \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
1569    \index[dir]{Rerun Failed Levels}
1570    \index[dir]{Directive!Rerun Failed Levels}
1571    If this directive is set to {\bf yes} (default no), and Bacula detects that
1572    a previous job at a higher level (i.e.  Full or Differential) has failed,
1573    the current job level will be upgraded to the higher level.  This is
1574    particularly useful for Laptops where they may often be unreachable, and if
1575    a prior Full save has failed, you wish the very next backup to be a Full
1576    save rather than whatever level it is started as.
1577
1578    There are several points that must be taken into account when using this
1579    directive: first, a failed job is defined as one that has not terminated
1580    normally, which includes any running job of the same name (you need to
1581    ensure that two jobs of the same name do not run simultaneously);
1582    secondly, the {\bf Ignore FileSet Changes} directive is not considered
1583    when checking for failed levels, which means that any FileSet change will
1584    trigger a rerun.
1585
1586    \label{Director:Job:SpoolData}
1587 \item [Spool Data = \lt{}yes\vb{}no\gt{}]
1588    \index[dir]{Spool Data}
1589    \index[dir]{Directive!Spool Data}
1590
1591    If this directive is set  to {\bf yes} (default no), the Storage daemon will
1592    be requested  to spool the data for this Job to disk rather than write it
1593    directly to the Volume (normally a tape).
1594
1595    Thus the data is written in large blocks to the Volume rather than small
1596    blocks.  This directive is particularly useful when running multiple
1597    simultaneous backups to tape.  Once all the data arrives or the spool
1598    files' maximum sizes are reached, the data will be despooled and written
1599    to tape.
1600
1601    Spooling data prevents interleaving date from several job and reduces or
1602    eliminates tape drive stop and start commonly known as ``shoe-shine''.
1603
1604    We don't recommend using this option if you are writing to a disk file
1605    using this option will probably just slow down the backup jobs.
1606
1607    NOTE: When this directive is set to yes, Spool Attributes is also
1608    automatically set to yes.
1609
1610    \label{Director:Job:SpoolData}
1611 \item [SpoolData=yes\vb{}no]
1612    \index[dir]{SpoolData}
1613    \index[dir]{Directive!SpoolData}
1614    tells Bacula to request the Storage  daemon to spool data to a disk file
1615    before writing it to the Volume (normally a tape).
1616
1617    \label{Director:Job:SpoolAttributes}
1618 \item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
1619    \index[dir]{Spool Attributes}
1620    \index[dir]{Directive!Spool Attributes}
1621    \index[dir]{slow}
1622    \index[general]{slow}
1623    \index[dir]{Backups!slow}
1624    \index[general]{Backups!slow}
1625    The default is set to {\bf no}, which means that the File attributes are
1626    sent by the Storage daemon to the Director as they are stored on tape.
1627    However, if you want to avoid the possibility that database updates will
1628    slow down writing to the tape, you may want to set the value to {\bf
1629    yes}, in which case the Storage daemon will buffer the File attributes
1630    and Storage coordinates to a temporary file in the Working Directory,
1631    then when writing the Job data to the tape is completed, the attributes
1632    and storage coordinates will be sent to the Director.
1633
1634    NOTE: When Spool Data is set to yes, Spool Attributes is also
1635    automatically set to yes.
1636
1637    \label{Director:Job:SpoolSize}
1638 \item [SpoolSize={\it bytes}]
1639    \index[dir]{SpoolSize}
1640    \index[dir]{Directive!SpoolSize}
1641    where the bytes specify the maximum spool size for this job.
1642    The default is take from Device Maximum Spool Size limit.
1643    This directive is available only in Bacula version 2.3.5 or
1644    later.
1645
1646
1647    \label{Director:Job:Where}
1648 \item [Where = \lt{}directory\gt{}]
1649    \index[dir]{Where}
1650    \index[dir]{Directive!Where}
1651    This directive applies only to a Restore job and specifies a prefix to
1652    the directory name of all files being restored.  This permits files to
1653    be restored in a different location from which they were saved.  If {\bf
1654    Where} is not specified or is set to backslash ({\bf /}), the files will
1655    be restored to their original location.  By default, we have set {\bf
1656    Where} in the example configuration files to be {\bf
1657    /tmp/bacula-restores}.  This is to prevent accidental overwriting of
1658    your files.
1659
1660   \label{confaddprefix}
1661   \label{Director:Job:AddPrefix}
1662 \item [Add Prefix = \lt{}directory\gt{}]
1663   \index[dir]{AddPrefix}
1664   \index[dir]{Directive!AddPrefix}
1665   This directive applies only to a Restore job and specifies a prefix to the
1666   directory name of all files being restored.  This will use \ilink{File
1667   Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1668
1669   \label{Director:Job:AddSuffix}
1670 \item [Add Suffix = \lt{}extention\gt{}]
1671   \index[dir]{AddSuffix}
1672   \index[dir]{Directive!AddSuffix}
1673   This directive applies only to a Restore job and specifies a suffix to all
1674   files being restored.  This will use \ilink{File Relocation}{filerelocation}
1675   feature implemented in Bacula 2.1.8 or later.
1676
1677   Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
1678   \texttt{/etc/passwsd.old}
1679
1680   \label{Director:Job:StripPrefix}
1681 \item [Strip Prefix = \lt{}directory\gt{}]
1682   \index[dir]{StripPrefix}
1683   \index[dir]{Directive!StripPrefix}
1684   This directive applies only to a Restore job and specifies a prefix to remove
1685   from the directory name of all files being restored.  This will use the
1686   \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
1687   or later.
1688
1689   Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
1690   \texttt{/passwd}
1691
1692   Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
1693   you can use :
1694
1695 \begin{lstlisting}
1696  Strip Prefix = c:
1697  Add Prefix = d:
1698 \end{lstlisting}
1699
1700   \label{Director:Job:RegexWhere}
1701 \item [RegexWhere = \lt{}expressions\gt{}]
1702   \index[dir]{RegexWhere}
1703   \index[dir]{Directive!RegexWhere}
1704   This directive applies only to a Restore job and specifies a regex filename
1705   manipulation of all files being restored.  This will use \ilink{File
1706   Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
1707
1708   For more informations about how use this option, see
1709   \ilink{this}{useregexwhere}.
1710
1711    \label{Director:Job:Replace}
1712 \item [Replace = \lt{}replace-option\gt{}]
1713    \index[dir]{Replace}
1714    \index[dir]{Directive!Replace}
1715    This directive applies only to a Restore job and specifies what happens
1716    when Bacula wants to restore a file or directory that already exists.
1717    You have the following options for {\bf replace-option}:
1718
1719 \begin{description}
1720
1721 \item [always]
1722    \index[dir]{always}
1723   when the file to be restored already exists, it is deleted and then
1724   replaced by the copy that was backed up.  This is the default value.
1725
1726 \item [ifnewer]
1727 \index[dir]{ifnewer}
1728   if the backed up file (on tape) is newer than the existing file, the
1729   existing file is deleted and replaced by the back up.
1730
1731 \item [ifolder]
1732    \index[dir]{ifolder}
1733   if the backed up file (on tape) is older than the existing file, the
1734   existing file is deleted and replaced by the back up.
1735
1736 \item [never]
1737    \index[dir]{never}
1738   if the backed up file already exists, Bacula skips  restoring this file.
1739 \end{description}
1740
1741    \label{Director:Job:PrefixLinks}
1742 \item [Prefix Links=\lt{}yes\vb{}no\gt{}]
1743    \index[dir]{Prefix Links}
1744    \index[dir]{Directive!Prefix Links}
1745    If a {\bf Where} path prefix is specified for a recovery job, apply it
1746    to absolute links as well.  The default is {\bf No}.  When set to {\bf
1747    Yes} then while restoring files to an alternate directory, any absolute
1748    soft links will also be modified to point to the new alternate
1749    directory.  Normally this is what is desired -- i.e.  everything is self
1750    consistent.  However, if you wish to later move the files to their
1751    original locations, all files linked with absolute names will be broken.
1752
1753    \label{Director:Job:MaximumConcurrentJobs}
1754 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
1755    \index[dir]{Maximum Concurrent Jobs}
1756    \index[dir]{Directive!Maximum Concurrent Jobs}
1757    where \lt{}number\gt{} is the maximum number of Jobs from the current
1758    Job resource that can run concurrently.  Note, this directive limits
1759    only Jobs with the same name as the resource in which it appears.  Any
1760    other restrictions on the maximum concurrent jobs such as in the
1761    Director, Client, or Storage resources will also apply in addition to
1762    the limit specified here.  The default is set to 1, but you may set it
1763    to a larger number.  We strongly recommend that you read the WARNING
1764    documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
1765    Director's resource.
1766
1767    \label{Director:Job:RescheduleOnError}
1768 \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
1769    \index[dir]{Reschedule On Error}
1770    \index[dir]{Directive!Reschedule On Error}
1771    If this directive is enabled, and the job terminates in error, the job
1772    will be rescheduled as determined by the {\bf Reschedule Interval} and
1773    {\bf Reschedule Times} directives.  If you cancel the job, it will not
1774    be rescheduled.  The default is {\bf no} (i.e.  the job will not be
1775    rescheduled).
1776
1777    This specification can be useful for portables, laptops, or other
1778    machines that are not always connected to the network or switched on.
1779
1780    \label{Director:Job:RescheduleInterval}
1781 \item [Reschedule Interval = \lt{}time-specification\gt{}]
1782    \index[dir]{Reschedule Interval}
1783    \index[dir]{Directive!Reschedule Interval}
1784    If you have specified {\bf Reschedule On Error = yes} and the job
1785    terminates in error, it will be rescheduled after the interval of time
1786    specified by {\bf time-specification}.  See \ilink{the time
1787    specification formats}{Time} in the Configure chapter for details of
1788    time specifications.  If no interval is specified, the job will not be
1789    rescheduled on error.
1790
1791    \label{Director:Job:RescheduleTimes}
1792 \item [Reschedule Times = \lt{}count\gt{}]
1793    \index[dir]{Reschedule Times}
1794    \index[dir]{Directive!Reschedule Times}
1795    This directive specifies the maximum number of times to reschedule the
1796    job.  If it is set to zero (the default) the job will be rescheduled an
1797    indefinite number of times.
1798
1799 \label{Director:Job:AllowDuplicateJobs}
1800 \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
1801 \index[general]{Allow Duplicate Jobs}
1802
1803 \bsysimageH{duplicate-real}{Allow Duplicate Jobs usage}{fig:allowduplicatejobs}
1804
1805 A duplicate job in the sense we use it here means a second or subsequent job
1806 with the same name starts.  This happens most frequently when the first job
1807 runs longer than expected because no tapes are available.
1808
1809   If this directive is enabled duplicate jobs will be run.  If
1810   the directive is set to {\bf no} (default) then only one job of a given name
1811   may run at one time, and the action that Bacula takes to ensure only
1812   one job runs is determined by the other directives (see below).
1813
1814   If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1815   are present and none of the three directives given below permit
1816   cancelling a job, then the current job (the second one started)
1817   will be cancelled.
1818
1819 \label{Job:AllowHigherDuplicates}
1820 \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
1821 \index[general]{Allow Higher Duplicates}
1822   This directive was implemented in version 5.0.0, but does not work
1823   as expected. If used, it should always be set to no.  In later versions
1824   of Bacula the directive is disabled (disregarded).
1825
1826
1827 \label{Director:Job:CancelLowerLevelDuplicates}
1828 \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
1829 \index[general]{Cancel Lower Level Duplicates}
1830   If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
1831   directive is set to \textbf{yes}, Bacula will choose between duplicated
1832   jobs the one with the highest level.  For example, it will cancel a
1833   previous Incremental to run a Full backup.  It works only for Backup
1834   jobs.  The default is \texttt{no}. If the levels of the duplicated
1835   jobs are the same, nothing is done and the other
1836   Cancel XXX Duplicate directives will be examined.
1837
1838 \label{Director:Job:CancelQueuedDuplicates}
1839 \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
1840 \index[general]{Cancel Queued Duplicates}
1841   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1842   if this directive is set to {\bf yes} any job that is
1843   already queued to run but not yet running will be canceled.
1844   The default is {\bf no}.
1845
1846 \label{Director:Job:CancelRunningDuplicates}
1847 \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
1848 \index[general]{Cancel Running Duplicates}
1849   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1850   if this directive is set to {\bf yes} any job that is already running
1851   will be canceled.  The default is {\bf no}.
1852
1853
1854 %%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
1855 %%\index[general]{Duplicate Job Proximity}
1856 %%  This directive permits to determine if two jobs are really duplicated.
1857 %%  If the first one is running for long time, this is probably not a good
1858 %%  idea to cancel it.
1859
1860    \label{Director:Job:Run}
1861 \item [Run = \lt{}job-name\gt{}]
1862    \index[dir]{Run}
1863    \index[dir]{Directive!Run}
1864    \index[dir]{Clone a Job}
1865    The Run directive (not to be confused with the Run option in a
1866    Schedule) allows you to start other jobs or to clone jobs. By using the
1867    cloning keywords (see below), you can backup
1868    the same data (or almost the same data) to two or more drives
1869    at the same time. The {\bf job-name} is normally the same name
1870    as the current Job resource (thus creating a clone). However, it
1871    may be any Job name, so one job may start other related jobs.
1872
1873    The part after the equal sign must be enclosed in double quotes,
1874    and can contain any string or set of options (overrides) that you
1875    can specify when entering the Run command from the console. For
1876    example {\bf storage=DDS-4 \ldots{}}.  In addition, there are two special
1877    keywords that permit you to clone the current job. They are {\bf level=\%l}
1878    and {\bf since=\%s}. The \%l in the level keyword permits
1879    entering the actual level of the current job and the \%s in the since
1880    keyword permits putting the same time for comparison as used on the
1881    current job.  Note, in the case of the since keyword, the \%s must be
1882    enclosed in double quotes, and thus they must be preceded by a backslash
1883    since they are already inside quotes. For example:
1884
1885 \begin{lstlisting}
1886    run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
1887 \end{lstlisting}
1888
1889    A cloned job will not start additional clones, so it is not
1890    possible to recurse.
1891
1892    Please note that all cloned jobs, as specified in the Run directives are
1893    submitted for running before the original job is run (while it is being
1894    initialized). This means that any clone job will actually start before
1895    the original job, and may even block the original job from starting
1896    until the original job finishes unless you allow multiple simultaneous
1897    jobs.  Even if you set a lower priority on the clone job, if no other
1898    jobs are running, it will start before the original job.
1899
1900    If you are trying to prioritize jobs by using the clone feature (Run
1901    directive), you will find it much easier to do using a RunScript
1902    resource, or a RunBeforeJob directive.
1903 \label{Priority}
1904
1905    \label{Director:Job:Priority}
1906 \item [Priority = \lt{}number\gt{}]
1907    \index[dir]{Priority}
1908    \index[dir]{Directive!Priority}
1909    This directive permits you to control the order in which your jobs will
1910    be run by specifying a positive non-zero number. The higher the number,
1911    the lower the job priority. Assuming you are not running concurrent jobs,
1912    all queued jobs of priority 1 will run before queued jobs of priority 2
1913    and so on, regardless of the original scheduling order.
1914
1915    The priority only affects waiting jobs that are queued to run, not jobs
1916    that are already running.  If one or more jobs of priority 2 are already
1917    running, and a new job is scheduled with priority 1, the currently
1918    running priority 2 jobs must complete before the priority 1 job is
1919    run, unless Allow Mixed Priority is set.
1920
1921    The default priority is 10.
1922
1923    If you want to run concurrent jobs you should
1924    keep these points in mind:
1925
1926 \begin{bsysitemize}
1927 \item See \bsysxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup
1928    concurrent jobs in the \problemsman{}.
1929
1930 \item Bacula concurrently runs jobs of only one priority at a time.  It
1931    will not simultaneously run a priority 1 and a priority 2 job.
1932
1933 \item If Bacula is running a priority 2 job and a new priority 1 job is
1934    scheduled, it will wait until the running priority 2 job terminates even
1935    if the Maximum Concurrent Jobs settings would otherwise allow two jobs
1936    to run simultaneously.
1937
1938 \item Suppose that bacula is running a priority 2 job and a new priority 1
1939    job is scheduled and queued waiting for the running priority 2 job to
1940    terminate.  If you then start a second priority 2 job, the waiting
1941    priority 1 job will prevent the new priority 2 job from running
1942    concurrently with the running priority 2 job.  That is: as long as there
1943    is a higher priority job waiting to run, no new lower priority jobs will
1944    start even if the Maximum Concurrent Jobs settings would normally allow
1945    them to run.  This ensures that higher priority jobs will be run as soon
1946    as possible.
1947 \end{bsysitemize}
1948
1949 If you have several jobs of different priority, it may not best to start
1950 them at exactly the same time, because Bacula must examine them one at a
1951 time.  If by Bacula starts a lower priority job first, then it will run
1952 before your high priority jobs.  If you experience this problem, you may
1953 avoid it by starting any higher priority jobs a few seconds before lower
1954 priority ones.  This insures that Bacula will examine the jobs in the
1955 correct order, and that your priority scheme will be respected.
1956 \label{AllowMixedPriority}
1957
1958 \label{Director:Job:AllowMixedPriority}
1959 \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
1960 \index[dir]{Allow Mixed Priority}
1961    This directive is only implemented in version 2.5 and later.  When
1962    set to {\bf yes} (default {\bf no}), this job may run even if lower
1963    priority jobs are already running.  This means a high priority job
1964    will not have to wait for other jobs to finish before starting.
1965    The scheduler will only mix priorities when all running jobs have
1966    this set to true.
1967
1968    Note that only higher priority jobs will start early.  Suppose the
1969    director will allow two concurrent jobs, and that two jobs with
1970    priority 10 are running, with two more in the queue.  If a job with
1971    priority 5 is added to the queue, it will be run as soon as one of
1972    the running jobs finishes.  However, new priority 10 jobs will not
1973    be run until the priority 5 job has finished.
1974 \label{WritePartAfterJob}
1975
1976 \label{Director:Job:WritePartAfterJob}
1977 \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
1978 \index[dir]{Write Part After Job}
1979 \index[dir]{Directive!Write Part After Job}
1980    This directive is only implemented in version 1.37 and later.
1981    If this directive is set to {\bf yes} (default {\bf no}), a new part file
1982    will be created after the job is finished.
1983
1984    It should be set to {\bf yes} when writing to devices that require mount
1985    (for example DVD), so you are sure that the current part, containing
1986    this job's data, is written to the device, and that no data is left in
1987    the temporary file on the hard disk.  However, on some media, like DVD+R
1988    and DVD-R, a lot of space (about 10Mb) is lost every time a part is
1989    written.  So, if you run several jobs each after another, you could set
1990    this directive to {\bf no} for all jobs, except the last one, to avoid
1991    wasting too much space, but to ensure that the data is written to the
1992    medium when all jobs are finished.
1993
1994    This directive is ignored with tape and FIFO devices.
1995
1996 \end{description}
1997
1998 The following is an example of a valid Job resource definition:
1999
2000 \footnotesize
2001 \begin{lstlisting}
2002 Job {
2003   Name = "Minou"
2004   Type = Backup
2005   Level = Incremental                 # default
2006   Client = Minou
2007   FileSet="Minou Full Set"
2008   Storage = DLTDrive
2009   Pool = Default
2010   Schedule = "MinouWeeklyCycle"
2011   Messages = Standard
2012 }
2013 \end{lstlisting}
2014 \normalsize
2015
2016 \label{JobDefsResource}
2017 \section{The JobDefs Resource}
2018 \index[general]{JobDefs Resource}
2019 \index[general]{Resource!JobDefs}
2020
2021 The JobDefs resource permits all the same directives that can appear in a Job
2022 resource. However, a JobDefs resource does not create a Job, rather it can be
2023 referenced within a Job to provide defaults for that Job. This permits you to
2024 concisely define several nearly identical Jobs, each one referencing a JobDefs
2025 resource which contains the defaults. Only the changes from the defaults need to
2026 be mentioned in each Job.
2027
2028 \label{ScheduleResource}
2029 \section{The Schedule Resource}
2030 \index[general]{Resource!Schedule}
2031 \index[general]{Schedule Resource}
2032
2033 The Schedule resource provides a means of automatically scheduling a Job as
2034 well as the ability to override the default Level, Pool, Storage and Messages
2035 resources. If a Schedule resource is not referenced in a Job, the Job can only
2036 be run manually. In general, you specify an action to be taken and when.
2037
2038 \begin{description}
2039
2040 \item [Schedule]
2041 \index[dir]{Schedule}
2042 \index[dir]{Directive!Schedule}
2043    Start of the Schedule directives.  No {\bf Schedule} resource is
2044    required, but you will need at least one if you want Jobs to be
2045    automatically started.
2046
2047    \label{Director:Schedule:Name}
2048 \item [Name = \lt{}name\gt{}]
2049    \index[dir]{Name}
2050    \index[dir]{Directive!Name}
2051    The name of the schedule being defined.  The Name directive is required.
2052
2053    \label{Director:Schedule:Run}
2054 \item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
2055    \index[dir]{Run}
2056    \index[dir]{Directive!Run}
2057    The Run directive defines when a Job is to be run, and what overrides if
2058    any to apply.  You may specify multiple {\bf run} directives within a
2059    {\bf Schedule} resource.  If you do, they will all be applied (i.e.
2060    multiple schedules).  If you have two {\bf Run} directives that start at
2061    the same time, two Jobs will start at the same time (well, within one
2062    second of each other).
2063
2064    The {\bf Job-overrides} permit overriding the Level, the Storage, the
2065    Messages, and the Pool specifications provided in the Job resource.  In
2066    addition, the FullPool, the IncrementalPool, and the DifferentialPool
2067    specifications permit overriding the Pool specification according to
2068    what backup Job Level is in effect.
2069
2070    By the use of overrides, you may customize a particular Job.  For
2071    example, you may specify a Messages override for your Incremental
2072    backups that outputs messages to a log file, but for your weekly or
2073    monthly Full backups, you may send the output by email by using a
2074    different Messages override.
2075
2076    {\bf Job-overrides} are specified as: {\bf keyword=value} where the
2077    keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
2078    or IncrementalPool, and the {\bf value} is as defined on the respective
2079    directive formats for the Job resource.  You may specify multiple {\bf
2080    Job-overrides} on one {\bf Run} directive by separating them with one or
2081    more spaces or by separating them with a trailing comma.  For example:
2082
2083    \label{Director:Schedule:End}
2084 \begin{description}
2085
2086 \item [Level=Full]
2087    \index[dir]{Level}
2088    \index[dir]{Directive!Level}
2089    is all files in the FileSet whether or not  they have changed.
2090
2091 \item [Level=Incremental]
2092    \index[dir]{Level}
2093    \index[dir]{Directive!Level}
2094    is all files that have changed since  the last backup.
2095
2096 \item [Pool=Weekly]
2097    \index[dir]{Pool}
2098    \index[dir]{Directive!Pool}
2099    specifies to use the Pool named {\bf Weekly}.
2100
2101 \item [Storage=DLT\_Drive]
2102    \index[dir]{Storage}
2103    \index[dir]{Directive!Storage}
2104    specifies to use {\bf DLT\_Drive} for  the storage device.
2105
2106 \item [Messages=Verbose]
2107    \index[dir]{Messages}
2108    \index[dir]{Directive!Messages}
2109    specifies to use the {\bf Verbose}  message resource for the Job.
2110
2111 \item [FullPool=Full]
2112    \index[dir]{FullPool}
2113    \index[dir]{Directive!FullPool}
2114    specifies to use the Pool named {\bf Full}  if the job is a full backup, or
2115 is
2116 upgraded from another type  to a full backup.
2117
2118 \item [DifferentialPool=Differential]
2119    \index[dir]{DifferentialPool}
2120    \index[dir]{Directive!DifferentialPool}
2121    specifies to use the Pool named {\bf Differential} if the job is a
2122    differential  backup.
2123
2124 \item [IncrementalPool=Incremental]
2125    \index[dir]{IncrementalPool}
2126    \index[dir]{Directive!IncrementalPool}
2127    specifies to use the Pool  named {\bf Incremental} if the job is an
2128 incremental  backup.
2129
2130
2131 \item [WritePartAfterJob=yes\vb{}no]
2132    \index[dir]{WritePartAfterJob}
2133    \index[dir]{Directive!WritePartAfterJob}
2134    tells Bacula to request the Storage daemon to write the current part
2135    file to the device when the job is finished (see \ilink{Write Part After
2136    Job directive in the Job resource}{WritePartAfterJob}).  Please note,
2137    this directive is implemented only in version 1.37 and later.  The
2138    default is yes.  We strongly recommend that you keep this set to yes
2139    otherwise, when the last job has finished one part will remain in the
2140    spool file and restore may or may not work.
2141
2142 \end{description}
2143
2144 {\bf Date-time-specification} determines when the  Job is to be run. The
2145 specification is a repetition, and as  a default Bacula is set to run a job at
2146 the beginning of the  hour of every hour of every day of every week of every
2147 month  of every year. This is not normally what you want, so you  must specify
2148 or limit when you want the job to run. Any  specification given is assumed to
2149 be repetitive in nature and  will serve to override or limit the default
2150 repetition. This  is done by specifying masks or times for the hour, day of the
2151 month, day of the week, week of the month, week of the year,  and month when
2152 you want the job to run. By specifying one or  more of the above, you can
2153 define a schedule to repeat at  almost any frequency you want.
2154
2155 Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and  {\bf
2156 minute} the Job is to be run. Of these four items to be specified,  {\bf day}
2157 is special in that you may either specify a day of the month  such as 1, 2,
2158 \ldots{} 31, or you may specify a day of the week such  as Monday, Tuesday, \ldots{}
2159 Sunday. Finally, you may also specify a  week qualifier to restrict the
2160 schedule to the first, second, third,  fourth, or fifth week of the month.
2161
2162 For example, if you specify only a day of the week, such as {\bf Tuesday}  the
2163 Job will be run every hour of every Tuesday of every Month. That  is the {\bf
2164 month} and {\bf hour} remain set to the defaults of  every month and all
2165 hours.
2166
2167 Note, by default with no other specification, your job will run  at the
2168 beginning of every hour. If you wish your job to run more than  once in any
2169 given hour, you will need to specify multiple {\bf run}  specifications each
2170 with a different minute.
2171
2172 The date/time to run the Job can be specified in the following way  in
2173 pseudo-BNF:
2174
2175 \footnotesize
2176 \begin{lstlisting}
2177 <void-keyword>    = on
2178 <at-keyword>      = at
2179 <week-keyword>    = 1st | 2nd | 3rd | 4th | 5th | first |
2180                     second | third | fourth | fifth
2181 <wday-keyword>    = sun | mon | tue | wed | thu | fri | sat |
2182                     sunday | monday | tuesday | wednesday |
2183                     thursday | friday | saturday
2184 <week-of-year-keyword> = w00 | w01 | ... w52 | w53
2185 <month-keyword>   = jan | feb | mar | apr | may | jun | jul |
2186                     aug | sep | oct | nov | dec | january |
2187                     february | ... | december
2188 <daily-keyword>   = daily
2189 <weekly-keyword>  = weekly
2190 <monthly-keyword> = monthly
2191 <hourly-keyword>  = hourly
2192 <digit>           = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
2193 <number>          = <digit> | <digit><number>
2194 <12hour>          = 0 | 1 | 2 | ... 12
2195 <hour>            = 0 | 1 | 2 | ... 23
2196 <minute>          = 0 | 1 | 2 | ... 59
2197 <day>             = 1 | 2 | ... 31
2198 <time>            = <hour>:<minute> |
2199                     <12hour>:<minute>am |
2200                     <12hour>:<minute>pm
2201 <time-spec>       = <at-keyword> <time> |
2202                     <hourly-keyword>
2203 <date-keyword>    = <void-keyword>  <weekly-keyword>
2204 <day-range>       = <day>-<day>
2205 <month-range>     = <month-keyword>-<month-keyword>
2206 <wday-range>      = <wday-keyword>-<wday-keyword>
2207 <range>           = <day-range> | <month-range> |
2208                           <wday-range>
2209 <date>            = <date-keyword> | <day> | <range>
2210 <date-spec>       = <date> | <date-spec>
2211 <day-spec>        = <day> | <wday-keyword> |
2212                     <day> | <wday-range> |
2213                     <week-keyword> <wday-keyword> |
2214                     <week-keyword> <wday-range> |
2215                     <daily-keyword>
2216 <month-spec>      = <month-keyword> | <month-range> |
2217                     <monthly-keyword>
2218 <date-time-spec>  = <month-spec> <day-spec> <time-spec>
2219 \end{lstlisting}
2220 \normalsize
2221
2222 \end{description}
2223
2224 Note, the Week of Year specification wnn follows the ISO standard definition
2225 of the week of the year, where Week 1 is the week in which the first Thursday
2226 of the year occurs, or alternatively, the week which contains the 4th of
2227 January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
2228 precedes the first ISO week (i.e. has the first few days of the year if any
2229 occur before Thursday). w00 is not defined by the ISO specification. A week
2230 starts with Monday and ends with Sunday.
2231
2232 According to the NIST (US National Institute of Standards and Technology),
2233 12am and 12pm are ambiguous and can be defined to anything.  However,
2234 12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
2235 defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon).  You can avoid
2236 this abiguity (confusion) by using 24 hour time specifications (i.e.  no
2237 am/pm). This is the definition in Bacula version 2.0.3 and later.
2238
2239 An example schedule resource that is named {\bf WeeklyCycle} and runs a job
2240 with level full each Sunday at 2:05am and an incremental job Monday through
2241 Saturday at 2:05am is:
2242
2243 \footnotesize
2244 \begin{lstlisting}
2245 Schedule {
2246   Name = "WeeklyCycle"
2247   Run = Level=Full sun at 2:05
2248   Run = Level=Incremental mon-sat at 2:05
2249 }
2250 \end{lstlisting}
2251 \normalsize
2252
2253 An example of a possible monthly cycle is as follows:
2254
2255 \footnotesize
2256 \begin{lstlisting}
2257 Schedule {
2258   Name = "MonthlyCycle"
2259   Run = Level=Full Pool=Monthly 1st sun at 2:05
2260   Run = Level=Differential 2nd-5th sun at 2:05
2261   Run = Level=Incremental Pool=Daily mon-sat at 2:05
2262 }
2263 \end{lstlisting}
2264 \normalsize
2265
2266 The first of every month:
2267
2268 \footnotesize
2269 \begin{lstlisting}
2270 Schedule {
2271   Name = "First"
2272   Run = Level=Full on 1 at 2:05
2273   Run = Level=Incremental on 2-31 at 2:05
2274 }
2275 \end{lstlisting}
2276 \normalsize
2277
2278 Every 10 minutes:
2279
2280 \footnotesize
2281 \begin{lstlisting}
2282 Schedule {
2283   Name = "TenMinutes"
2284   Run = Level=Full hourly at 0:05
2285   Run = Level=Full hourly at 0:15
2286   Run = Level=Full hourly at 0:25
2287   Run = Level=Full hourly at 0:35
2288   Run = Level=Full hourly at 0:45
2289   Run = Level=Full hourly at 0:55
2290 }
2291 \end{lstlisting}
2292 \normalsize
2293
2294 \section{Technical Notes on Schedules}
2295 \index[general]{Schedules!Technical Notes on}
2296 \index[general]{Technical Notes on Schedules}
2297
2298 Internally Bacula keeps a schedule as a bit mask. There are six masks and a
2299 minute field to each schedule. The masks are hour, day of the month (mday),
2300 month, day of the week (wday), week of the month (wom), and week of the year
2301 (woy). The schedule is initialized to have the bits of each of these masks
2302 set, which means that at the beginning of every hour, the job will run. When
2303 you specify a month for the first time, the mask will be cleared and the bit
2304 corresponding to your selected month will be selected. If you specify a second
2305 month, the bit corresponding to it will also be added to the mask. Thus when
2306 Bacula checks the masks to see if the bits are set corresponding to the
2307 current time, your job will run only in the two months you have set. Likewise,
2308 if you set a time (hour), the hour mask will be cleared, and the hour you
2309 specify will be set in the bit mask and the minutes will be stored in the
2310 minute field.
2311
2312 For any schedule you have defined, you can see how these bits are set by doing
2313 a {\bf show schedules} command in the Console program. Please note that the
2314 bit mask is zero based, and Sunday is the first day of the week (bit zero).
2315
2316 \input{fileset}
2317 \input{bsplugins}
2318
2319 \label{ClientResource}
2320 \section{The Client Resource}
2321 \index[general]{Resource!Client}
2322 \index[general]{Client Resource}
2323
2324 The Client resource defines the attributes of the Clients that are served by
2325 this Director; that is the machines that are to be backed up. You will need
2326 one Client resource definition for each machine to be backed up.
2327
2328 \begin{description}
2329
2330 \item [Client (or FileDaemon)]
2331    \index[dir]{Client (or FileDaemon)}
2332    \index[dir]{Directive!Client (or FileDaemon)}
2333    Start of the Client directives.
2334
2335    \label{Director:Client:Name}
2336 \item [Name = \lt{}name\gt{}]
2337    \index[dir]{Name}
2338    \index[dir]{Directive!Name}
2339    The client name which will be used in the  Job resource directive or in the
2340 console run command.  This directive is required.
2341
2342    \label{Director:Client:Address}
2343 \item [Address = \lt{}address\gt{}]
2344    \index[dir]{Address}
2345    \index[dir]{Directive!FD Address}
2346    \index[dir]{File Daemon Address}
2347    \index[dir]{Client Address}
2348    Where the address is a host name, a fully qualified domain name, or a
2349    network address in dotted quad notation for a Bacula File server daemon.
2350    This directive is required.
2351
2352    \label{Director:Client:FdPort}
2353 \item [FD Port = \lt{}port-number\gt{}]
2354    \index[dir]{FD Port}
2355    \index[dir]{Directive!FD Port}
2356    Where the port is a port  number at which the Bacula File server daemon can
2357    be contacted.  The default is 9102.
2358
2359    \label{Director:Client:Catalog}
2360 \item [Catalog = \lt{}Catalog-resource-name\gt{}]
2361    \index[dir]{Catalog}
2362    \index[dir]{Directive!Catalog}
2363    This specifies the  name of the catalog resource to be used for this Client.
2364    This directive is required.
2365
2366    \label{Director:Client:Password}
2367 \item [Password = \lt{}password\gt{}]
2368    \index[dir]{Password}
2369    \index[dir]{Directive!Password}
2370    This is the password to be  used when establishing a connection with the File
2371    services, so  the Client configuration file on the machine to be backed up
2372    must  have the same password defined for this Director. This directive is
2373    required.  If you have either {\bf /dev/random}  {\bf bc} on your machine,
2374    Bacula will generate a random  password during the configuration process,
2375    otherwise it will  be left blank.
2376
2377    The password is plain text.  It is not generated through any special
2378    process, but it is preferable for security reasons to make the text
2379    random.
2380 \label{FileRetention}
2381
2382    \label{FileRetention}
2383    \label{Director:Client:FileRetention}
2384 \item [File Retention = \lt{}time-period-specification\gt{}]
2385    \index[dir]{File Retention}
2386    \index[dir]{Directive!File Retention}
2387    The File Retention directive defines the length of time that  Bacula will
2388    keep File records in the Catalog database after the End time of the
2389    Job corresponding to the File records.
2390    When this time period expires, and if
2391    {\bf AutoPrune} is set to  {\bf yes} Bacula will prune (remove) File records
2392    that  are older than the specified File Retention period. Note, this  affects
2393    only records in the catalog database. It does not  affect your archive
2394    backups.
2395
2396    File records  may actually be retained for a shorter period than you specify
2397    on  this directive if you specify either a shorter {\bf Job Retention}  or a
2398    shorter {\bf Volume Retention} period. The shortest  retention period of the
2399    three takes precedence.  The time may be expressed in seconds, minutes,
2400    hours, days, weeks, months, quarters, or years. See the
2401    \ilink{ Configuration chapter}{Time} of this  manual for
2402    additional details of time specification.
2403
2404    The  default is 60 days.
2405
2406    \label{JobRetention}
2407    \label{Director:Client:JobRetention}
2408 \item [Job Retention = \lt{}time-period-specification\gt{}]
2409    \index[dir]{Job Retention}
2410    \index[dir]{Directive!Job Retention}
2411    The Job Retention directive defines the length of time that  Bacula will keep
2412    Job records in the Catalog database after the Job End time.  When
2413    this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
2414    Bacula will prune (remove) Job records that are older than the specified
2415    File Retention period.  As with the other retention periods, this
2416    affects only records in the catalog and not data in your archive backup.
2417
2418    If a Job record is selected for pruning, all associated File and JobMedia
2419    records will also be pruned regardless of the File Retention period set.
2420    As a consequence, you normally will set the File retention period to be
2421    less than the Job retention period.  The Job retention period can actually
2422    be less than the value you specify here if you set the {\bf Volume
2423    Retention} directive in the Pool resource to a smaller duration.  This is
2424    because the Job retention period and the Volume retention period are
2425    independently applied, so the smaller of the two takes precedence.
2426
2427    The Job retention period is specified as seconds,  minutes, hours, days,
2428    weeks, months,  quarters, or years.  See the
2429    \ilink{ Configuration chapter}{Time} of this manual for
2430    additional details of  time specification.
2431
2432    The default is 180 days.
2433 \label{AutoPrune}
2434
2435    \label{Director:Client:AutoPrune}
2436 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
2437    \index[dir]{AutoPrune}
2438    \index[dir]{Directive!AutoPrune}
2439    If AutoPrune is set to  {\bf yes} (default), Bacula (version 1.20 or greater)
2440    will  automatically apply the File retention period and the Job  retention
2441    period for the Client at the end of the Job.  If you set {\bf AutoPrune = no},
2442    pruning will not be done,  and your Catalog will grow in size each time you
2443    run a Job.  Pruning affects only information in the catalog and not data
2444    stored in the backup archives (on Volumes).
2445
2446    \label{Director:Client:MaximumConcurrentJobs}
2447 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2448    \index[dir]{Maximum Concurrent Jobs}
2449    \index[dir]{Directive!Maximum Concurrent Jobs}
2450    where \lt{}number\gt{}  is the maximum number of Jobs with the current Client
2451    that  can run concurrently. Note, this directive limits only Jobs  for Clients
2452    with the same name as the resource in which it appears. Any  other
2453    restrictions on the maximum concurrent jobs such as in  the Director, Job, or
2454    Storage resources will also apply in addition to  any limit specified here.
2455    The  default is set to 1, but you may set it to a larger number.
2456
2457 \label{Director:Client:MaximumBandwidthPerJob}
2458 \item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
2459 \index[dir]{Maximum Bandwidth Per Job}
2460 \index[dir]{Directive!Maximum Bandwidth Per Job}
2461
2462 The speed parameter specifies the maximum allowed bandwidth that a job may use
2463 when started for this Client. The speed parameter should be specified in
2464 k/s, Kb/s, m/s or Mb/s.
2465
2466 % \item [FD Storage Address = \lt{}address\gt{}]
2467 %    \index[dir]{FDStorageAddress}
2468 %    \index[dir]{Directive!FD Storage Address}
2469 %    \index[dir]{Storage daemon Address}
2470 %
2471 %    Where the address is a host name, a {\bf fully qualified domain name}, or an
2472 %    {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
2473 %    will be transmitted to the File daemon instead of the Storage
2474 %    \texttt{Address} who will then use it to contact the Storage daemon. This
2475 %    directive can be used in NAT environment where the configuration of the
2476 %    Client resolver is not possible. Note that using this directive will not allow
2477 %    to use multiple Storage Daemon for Backup/Restore jobs.
2478 %
2479
2480    \label{Director:Client:Priority}
2481 \item [Priority = \lt{}number\gt{}]
2482    \index[dir]{Priority}
2483    \index[dir]{Directive!Priority}
2484    The number specifies the  priority of this client relative to other clients
2485    that the  Director is processing simultaneously. The priority can range  from
2486    1 to 1000. The clients are ordered such that the smaller  number priorities
2487    are performed first (not currently  implemented).
2488 \end{description}
2489
2490    The following is an example of a valid Client resource definition:
2491
2492 \footnotesize
2493 \begin{lstlisting}
2494 Client {
2495   Name = Minimatou
2496   FDAddress = minimatou
2497   Catalog = MySQL
2498   Password = very_good
2499 }
2500 \end{lstlisting}
2501 \normalsize
2502
2503 \label{StorageResource}
2504 \section{The Storage Resource}
2505 \index[general]{Resource!Storage}
2506 \index[general]{Storage Resource}
2507
2508 The Storage resource defines which Storage daemons are available for use by
2509 the Director.
2510
2511 \begin{description}
2512
2513 \item [Storage]
2514    \index[dir]{Storage}
2515    \index[dir]{Directive!Storage}
2516    Start of the Storage resources. At least one  storage resource must be
2517    specified.
2518
2519    \label{Director:Storage:Name}
2520 \item [Name = \lt{}name\gt{}]
2521    \index[dir]{Name}
2522    \index[dir]{Directive!Name}
2523    The name of the storage resource. This  name appears on the Storage directive
2524    specified in the Job resource and is required.
2525
2526    \label{Director:Storage:Address}
2527 \item [Address = \lt{}address\gt{}]
2528    \index[dir]{Address}
2529    \index[dir]{Directive!SD Address}
2530    \index[dir]{Storage daemon Address}
2531    Where the address is a host name,  a {\bf fully qualified domain name}, or an
2532    {\bf IP address}. Please note  that the \lt{}address\gt{} as specified here
2533    will be transmitted to  the File daemon who will then use it to contact the
2534    Storage daemon. Hence,  it is {\bf not}, a good idea to use {\bf localhost} as
2535    the  name but rather a fully qualified machine name or an IP address.  This
2536    directive is required.
2537
2538    \label{Director:Storage:FdStorageAddress}
2539  \item [FD Storage Address = \lt{}address\gt{}]
2540    \index[dir]{FDStorageAddress}
2541    \index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
2542      Address} Where the address is a host name, a {\bf fully qualified domain
2543      name}, or an {\bf IP address}. Please note that the \lt{}address\gt{} as
2544    specified here will be transmitted to the File daemon instead of the
2545    \texttt{Address} who will then use it to contact the Storage daemon. This
2546    directive can be used in NAT environment where the configuration of the
2547    Client resolver is not possible.
2548
2549 \bsysimageH{BackupOverWan1}{Backup over WAN using FD Storage Address}{figdirdconf:backupwan}
2550
2551    \label{Director:Storage:SdPort}
2552 \item [SD Port = \lt{}port\gt{}]
2553    \index[dir]{SD Port}
2554    \index[dir]{Directive!SD Port}
2555    Where port is the port to use to  contact the storage daemon for information
2556    and to start jobs.  This same port number must appear in the Storage resource
2557    of the  Storage daemon's configuration file. The default is 9103.
2558
2559    \label{Director:Storage:Password}
2560 \item [Password = \lt{}password\gt{}]
2561    \index[dir]{Password}
2562    \index[dir]{Directive!Password}
2563    This is the password to be used  when establishing a connection with the
2564    Storage services. This  same password also must appear in the Director
2565    resource of the Storage  daemon's configuration file. This directive is
2566    required.  If you have either {\bf /dev/random}  {\bf bc} on your machine,
2567    Bacula will generate a random  password during the configuration process,
2568    otherwise it will  be left blank.
2569
2570    The password is plain text.  It is not generated through any special
2571    process, but it is preferable for security reasons to use random text.
2572
2573    \label{Director:Storage:Device}
2574 \item [Device = \lt{}device-name\gt{}]
2575    \index[dir]{Device}
2576    \index[dir]{Directive!Device}
2577    This directive specifies the Storage daemon's name of the device
2578    resource to be used for the storage.  If you are using an Autochanger,
2579    the name specified here should be the name of the Storage daemon's
2580    Autochanger resource rather than the name of an individual device.  This
2581    name is not the physical device name, but the logical device name as
2582    defined on the {\bf Name} directive contained in the {\bf Device} or the
2583    {\bf Autochanger} resource definition of the {\bf Storage daemon}
2584    configuration file.  You can specify any name you would like (even the
2585    device name if you prefer) up to a maximum of 127 characters in length.
2586    The physical device name associated with this device is specified in the
2587    {\bf Storage daemon} configuration file (as {\bf Archive Device}).
2588    Please take care not to define two different Storage resource directives
2589    in the Director that point to the same Device in the Storage daemon.
2590    Doing so may cause the Storage daemon to block (or hang) attempting to
2591    open the same device that is already open.  This directive is required.
2592 \label{MediaType}
2593
2594    \label{Director:Storage:MediaType}
2595 \item [Media Type = \lt{}MediaType\gt{}]
2596    \index[dir]{Media Type}
2597    \index[dir]{Directive!Media Type}
2598    This directive specifies the Media Type to be used to store the data.
2599    This is an arbitrary string of characters up to 127 maximum that you
2600    define.  It can be anything you want.  However, it is best to make it
2601    descriptive of the storage media (e.g.  File, DAT, ``HP DLT8000'', 8mm,
2602    \ldots{}).  In addition, it is essential that you make the {\bf Media Type}
2603    specification unique for each storage media type.  If you have two DDS-4
2604    drives that have incompatible formats, or if you have a DDS-4 drive and
2605    a DDS-4 autochanger, you almost certainly should specify different {\bf
2606    Media Types}.  During a restore, assuming a {\bf DDS-4} Media Type is
2607    associated with the Job, Bacula can decide to use any Storage daemon
2608    that supports Media Type {\bf DDS-4} and on any drive that supports it.
2609
2610    If you are writing to disk Volumes, you must make doubly sure that each
2611    Device resource defined in the Storage daemon (and hence in the
2612    Director's conf file) has a unique media type.  Otherwise for Bacula
2613    versions 1.38 and older, your restores may not work because Bacula
2614    will assume that you can mount any Media Type with the same name on
2615    any Device associated with that Media Type. This is possible with
2616    tape drives, but with disk drives, unless you are very clever you
2617    cannot mount a Volume in any directory -- this can be done by creating
2618    an appropriate soft link.
2619
2620    Currently Bacula permits only a single Media Type per Storage
2621    and Device definition. Consequently, if
2622    you have a drive that supports more than one Media Type, you can
2623    give a unique string to Volumes with different intrinsic Media
2624    Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
2625    those volumes will only be mounted on drives indicated with the
2626    dual type (DDS-3-4).
2627
2628    If you want to tie Bacula to using a single Storage daemon or drive, you
2629    must specify a unique Media Type for that drive.  This is an important
2630    point that should be carefully understood.  Note, this applies equally
2631    to Disk Volumes.  If you define more than one disk Device resource in
2632    your Storage daemon's conf file, the Volumes on those two devices are in
2633    fact incompatible because one can not be mounted on the other device
2634    since they are found in different directories.  For this reason, you
2635    probably should use two different Media Types for your two disk Devices
2636    (even though you might think of them as both being File types).  You can
2637    find more on this subject in the \ilink{Basic Volume
2638    Management}{DiskChapter} chapter of this manual.
2639
2640    The {\bf MediaType} specified in the Director's Storage resource, {\bf
2641    must} correspond to the {\bf Media Type} specified in the {\bf Device}
2642    resource of the {\bf Storage daemon} configuration file.  This directive
2643    is required, and it is used by the Director and the Storage daemon to
2644    ensure that a Volume automatically selected from the Pool corresponds to
2645    the physical device.  If a Storage daemon handles multiple devices (e.g.
2646    will write to various file Volumes on different partitions), this
2647    directive allows you to specify exactly which device.
2648
2649    As mentioned above, the value specified in the Director's Storage
2650    resource must agree with the value specified in the Device resource in
2651    the {\bf Storage daemon's} configuration file.  It is also an additional
2652    check so that you don't try to write data for a DLT onto an 8mm device.
2653 \label{Autochanger1}
2654
2655    \label{Director:Storage:Autochanger}
2656 \item [Autochanger = \lt{}yes\vb{}no\gt{}]
2657    \index[dir]{Autochanger}
2658    \index[dir]{Directive!Autochanger}
2659    If you specify {\bf yes} for this command (the default is {\bf no}),
2660    when you use the {\bf label} command or the {\bf add} command to create
2661    a new Volume, {\bf Bacula} will also request the Autochanger Slot
2662    number.  This simplifies creating database entries for Volumes in an
2663    autochanger.  If you forget to specify the Slot, the autochanger will
2664    not be used.  However, you may modify the Slot associated with a Volume
2665    at any time by using the {\bf update volume} or {\bf update slots}
2666    command in the console program.  When {\bf autochanger} is enabled, the
2667    algorithm used by Bacula to search for available volumes will be
2668    modified to consider only Volumes that are known to be in the
2669    autochanger's magazine.  If no {\bf in changer} volume is found, Bacula
2670    will attempt recycling, pruning, \ldots{}, and if still no volume is found,
2671    Bacula will search for any volume whether or not in the magazine.  By
2672    privileging in changer volumes, this procedure minimizes operator
2673    intervention.  The default is {\bf no}.
2674
2675    For the autochanger to be used, you must also specify {\bf Autochanger =
2676    yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
2677    configuration file as well as other important Storage daemon
2678    configuration information.  Please consult the \ilink{Using
2679    Autochangers}{AutochangersChapter} manual of this chapter for the
2680    details of using autochangers.
2681
2682    \label{Director:Storage:MaximumConcurrentJobs}
2683 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
2684    \index[dir]{Maximum Concurrent Jobs}
2685    \index[dir]{Directive!Maximum Concurrent Jobs}
2686    where \lt{}number\gt{}  is the maximum number of Jobs with the current
2687    Storage resource that can run concurrently.  Note, this directive limits
2688    only Jobs for Jobs using this Storage daemon.  Any other restrictions on
2689    the maximum concurrent jobs such as in the Director, Job, or Client
2690    resources will also apply in addition to any limit specified here.  The
2691    default is set to 1, but you may set it to a larger number.  However, if
2692    you set the Storage daemon's number of concurrent jobs greater than one,
2693    we recommend that you read the waring documented under \ilink{Maximum
2694    Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
2695    turn data spooling on as documented in the \ilink{Data
2696    Spooling}{SpoolingChapter} chapter of this manual.
2697
2698   \label{AllowCompression}
2699    \label{Director:Storage:AllowCompression}
2700 \item [AllowCompression = \lt{}yes\vb{}no\gt{}]
2701    \index[dir]{AllowCompression}
2702    \index[dir]{Directive!AllowCompression}
2703
2704    This directive is optional, and if you specify {\bf No} (the default is {\bf
2705      Yes}), it will cause backups jobs running on this storage resource to run
2706    without client File Daemon compression.  This effectively overrides
2707    compression options in FileSets used by jobs which use this storage
2708    resource.
2709
2710    \label{Director:Storage:HeartbeatInterval}
2711 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
2712    \index[dir]{Heartbeat Interval}
2713    \index[dir]{Directive!Heartbeat}
2714    This directive is optional and if specified will cause the Director to
2715    set a keepalive interval (heartbeat) in seconds on each of the sockets
2716    it opens for the Storage resource.  This value will override any
2717    specified at the Director level.  It is implemented only on systems
2718    (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
2719    The default value is zero, which means no change is made to the socket.
2720
2721    \label{Director:Storage:End}
2722 \end{description}
2723
2724 The following is an example of a valid Storage resource definition:
2725
2726 \footnotesize
2727 \begin{lstlisting}
2728 # Definition of tape storage device
2729 Storage {
2730   Name = DLTDrive
2731   Address = lpmatou
2732   Password = storage_password # password for Storage daemon
2733   Device = "HP DLT 80"    # same as Device in Storage daemon
2734   Media Type = DLT8000    # same as MediaType in Storage daemon
2735 }
2736 \end{lstlisting}
2737 \normalsize
2738
2739 \label{PoolResource}
2740 \section{The Pool Resource}
2741 \index[general]{Resource!Pool}
2742 \index[general]{Pool Resource}
2743
2744 The Pool resource defines the set of storage Volumes (tapes or files) to be
2745 used by Bacula to write the data. By configuring different Pools, you can
2746 determine which set of Volumes (media) receives the backup data. This permits,
2747 for example, to store all full backup data on one set of Volumes and all
2748 incremental backups on another set of Volumes. Alternatively, you could assign
2749 a different set of Volumes to each machine that you backup. This is most
2750 easily done by defining multiple Pools.
2751
2752 Another important aspect of a Pool is that it contains the default attributes
2753 (Maximum Jobs, Retention Period, Recycle flag, \ldots{}) that will be given to a
2754 Volume when it is created. This avoids the need for you to answer a large
2755 number of questions when labeling a new Volume. Each of these attributes can
2756 later be changed on a Volume by Volume basis using the {\bf update} command in
2757 the console program. Note that you must explicitly specify which Pool Bacula
2758 is to use with each Job. Bacula will not automatically search for the correct
2759 Pool.
2760
2761 Most often in Bacula installations all backups for all machines (Clients) go
2762 to a single set of Volumes. In this case, you will probably only use the {\bf
2763 Default} Pool. If your backup strategy calls for you to mount a different tape
2764 each day, you will probably want to define a separate Pool for each day. For
2765 more information on this subject, please see the
2766 \ilink{Backup Strategies}{StrategiesChapter} chapter of this
2767 manual.
2768
2769
2770 To use a Pool, there are three distinct steps. First the Pool must be defined
2771 in the Director's configuration file. Then the Pool must be written to the
2772 Catalog database. This is done automatically by the Director each time that it
2773 starts, or alternatively can be done using the {\bf create} command in the
2774 console program. Finally, if you change the Pool definition in the Director's
2775 configuration file and restart Bacula, the pool will be updated alternatively
2776 you can use the {\bf update pool} console command to refresh the database
2777 image. It is this database image rather than the Director's resource image
2778 that is used for the default Volume attributes. Note, for the pool to be
2779 automatically created or updated, it must be explicitly referenced by a Job
2780 resource.
2781
2782 Next the physical media must be labeled. The labeling can either be done with
2783 the {\bf label} command in the {\bf console} program or using the {\bf btape}
2784 program. The preferred method is to use the {\bf label} command in the {\bf
2785 console} program.
2786
2787 Finally, you must add Volume names (and their attributes) to the Pool. For
2788 Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
2789 archive device specified for the job (i.e. if you are going to back up to a
2790 DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
2791 mounted on a DLT drive). The {\bf Media Type} has particular importance if you
2792 are backing up to files. When running a Job, you must explicitly specify which
2793 Pool to use. Bacula will then automatically select the next Volume to use from
2794 the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
2795 from the Pool is identical to that required by the Storage resource you have
2796 specified for the Job.
2797
2798 If you use the {\bf label} command in the console program to label the
2799 Volumes, they will automatically be added to the Pool, so this last step is
2800 not normally required.
2801
2802 It is also possible to add Volumes to the database without explicitly labeling
2803 the physical volume. This is done with the {\bf add} console command.
2804
2805 As previously mentioned, each time Bacula starts, it scans all the Pools
2806 associated with each Catalog, and if the database record does not already
2807 exist, it will be created from the Pool Resource definition. {\bf Bacula}
2808 probably should do an {\bf update pool} if you change the Pool definition, but
2809 currently, you must do this manually using the {\bf update pool} command in
2810 the Console program.
2811
2812 The Pool Resource defined in the Director's configuration file
2813 (bacula-dir.conf) may contain the following directives:
2814
2815 \begin{description}
2816
2817 \item [Pool]
2818    \index[dir]{Pool}
2819    \index[dir]{Directive!Pool}
2820    Start of the Pool resource.  There must be at least one Pool resource
2821    defined.
2822
2823
2824    \label{Director:Pool:Name}
2825 \item [Name = \lt{}name\gt{}]
2826    \index[dir]{Name}
2827    \index[dir]{Directive!Name}
2828    The name of the pool.  For most applications, you will use the default
2829    pool name {\bf Default}.  This directive is required.
2830 \label{MaxVolumes}
2831
2832    \label{Director:Pool:MaximumVolumes}
2833 \item [Maximum Volumes = \lt{}number\gt{}]
2834    \index[dir]{Maximum Volumes}
2835    \index[dir]{Directive!Maximum Volumes}
2836    This directive specifies the maximum number of volumes (tapes or files)
2837    contained in the pool.  This directive is optional, if omitted or set to
2838    zero, any number of volumes will be permitted.  In general, this
2839    directive is useful for Autochangers where there is a fixed number of
2840    Volumes, or for File storage where you wish to ensure that the backups
2841    made to disk files do not become too numerous or consume too much space.
2842
2843    \label{Director:Pool:PoolType}
2844 \item [Pool Type = \lt{}type\gt{}]
2845    \index[dir]{Pool Type}
2846    \index[dir]{Directive!Pool Type}
2847    This directive defines the pool type, which corresponds to the type of
2848    Job being run.  It is required and may be one of the following:
2849
2850 \begin{bsysitemize}
2851   \item [Backup]
2852   \item [*Archive]
2853   \item [*Cloned]
2854   \item [*Migration]
2855   \item [*Copy]
2856   \item [*Save]
2857 \end{bsysitemize}
2858    Note, only Backup is current implemented.
2859
2860 \label{Director:Pool:Storage}
2861 \item [Storage = \lt{}storage-resource-name\gt{}]
2862 \index[dir]{Storage}
2863 \index[dir]{Directive!Storage}
2864    The Storage directive defines the name of the storage services where you
2865    want to backup the FileSet data.  For additional details, see the
2866    \ilink{Storage Resource Chapter}{StorageResource} of this manual.
2867    The Storage resource may also be specified in the Job resource,
2868    but the value, if any, in the Pool resource overrides any value
2869    in the Job. This Storage resource definition is not required by either
2870    the Job resource or in the Pool, but it must be specified in
2871    one or the other.  If not configuration error will result.
2872
2873    \label{Director:Pool:UseVolumeOnce}
2874 \item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
2875    \index[dir]{Use Volume Once}
2876    \index[dir]{Directive!Use Volume Once}
2877    This directive if set to {\bf yes} specifies that each volume is to be
2878    used only once.  This is most useful when the Media is a file and you
2879    want a new file for each backup that is done.  The default is {\bf no}
2880    (i.e.  use volume any number of times).  This directive will most likely
2881    be phased out (deprecated), so you are recommended to use {\bf Maximum
2882    Volume Jobs = 1} instead.
2883
2884    The value defined by this directive in the bacula-dir.conf file is the
2885    default value used when a Volume is created.  Once the volume is
2886    created, changing the value in the bacula-dir.conf file will not change
2887    what is stored for the Volume.  To change the value for an existing
2888    Volume you must use the {\bf update} command in the Console.
2889
2890    Please see the notes below under {\bf Maximum Volume Jobs} concerning
2891    using this directive with multiple simultaneous jobs.
2892
2893    \label{Director:Pool:MaximumVolumeJobs}
2894 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
2895    \index[dir]{Maximum Volume Jobs}
2896    \index[dir]{Directive!Maximum Volume Jobs}
2897    This directive specifies the maximum number of Jobs that can be written
2898    to the Volume.  If you specify zero (the default), there is no limit.
2899    Otherwise, when the number of Jobs backed up to the Volume equals {\bf
2900    positive-integer} the Volume will be marked {\bf Used}.  When the Volume
2901    is marked {\bf Used} it can no longer be used for appending Jobs, much
2902    like the {\bf Full} status but it can be recycled if recycling is
2903    enabled, and thus used again.  By setting {\bf MaximumVolumeJobs} to
2904    one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
2905
2906    The value defined by this directive in the  bacula-dir.conf
2907    file is the default value used when a Volume  is created. Once the volume is
2908    created, changing the value  in the bacula-dir.conf file will not change what
2909    is stored  for the Volume. To change the value for an existing Volume  you
2910    must use the {\bf update} command in the Console.
2911
2912    If you are running multiple simultaneous jobs, this directive may not
2913    work correctly because when a drive is reserved for a job, this
2914    directive is not taken into account, so multiple jobs may try to
2915    start writing to the Volume. At some point, when the Media record is
2916    updated, multiple simultaneous jobs may fail since the Volume can no
2917    longer be written.
2918
2919    \label{Director:Pool:MaximumVolumeFiles}
2920 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
2921    \index[dir]{Maximum Volume Files}
2922    \index[dir]{Directive!Maximum Volume Files}
2923    This directive specifies the maximum number of files that can be written
2924    to the Volume.  If you specify zero (the default), there is no limit.
2925    Otherwise, when the number of files written to the Volume equals {\bf
2926    positive-integer} the Volume will be marked {\bf Used}.  When the Volume
2927    is marked {\bf Used} it can no longer be used for appending Jobs, much
2928    like the {\bf Full} status but it can be recycled if recycling is
2929    enabled and thus used again.  This value is checked and the {\bf Used}
2930    status is set only at the end of a job that writes to the particular
2931    volume.
2932
2933    The value defined by this directive in the bacula-dir.conf file is the
2934    default value used when a Volume is created.  Once the volume is
2935    created, changing the value in the bacula-dir.conf file will not change
2936    what is stored for the Volume.  To change the value for an existing
2937    Volume you must use the {\bf update} command in the Console.
2938
2939    \label{Director:Pool:MaximumVolumeBytes}
2940 \item [Maximum Volume Bytes = \lt{}size\gt{}]
2941    \index[dir]{Maximum Volume Bytes}
2942    \index[dir]{Directive!Maximum Volume Bytes}
2943    This directive specifies the maximum number of bytes that can be written
2944    to the Volume.  If you specify zero (the default), there is no limit
2945    except the physical size of the Volume.  Otherwise, when the number of
2946    bytes written to the Volume equals {\bf size} the Volume will be marked
2947    {\bf Used}.  When the Volume is marked {\bf Used} it can no longer be
2948    used for appending Jobs, much like the {\bf Full} status but it can be
2949    recycled if recycling is enabled, and thus the Volume can be re-used
2950    after recycling.  This value is checked and the {\bf Used} status set
2951    while the job is writing to the particular volume.
2952
2953    This directive is particularly useful for restricting the size
2954    of disk volumes, and will work correctly even in the case of
2955    multiple simultaneous jobs writing to the volume.
2956
2957    The value defined by this directive in the bacula-dir.conf file is the
2958    default value used when a Volume is created.  Once the volume is
2959    created, changing the value in the bacula-dir.conf file will not change
2960    what is stored for the Volume.  To change the value for an existing
2961    Volume you must use the {\bf update} command in the Console.
2962
2963    \label{Director:Pool:VolumeUseDuration}
2964 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
2965    \index[dir]{Volume Use Duration}
2966    \index[dir]{Directive!Volume Use Duration}
2967    The Volume Use Duration directive defines the time period that the
2968    Volume can be written beginning from the time of first data write to the
2969    Volume.  If the time-period specified is zero (the default), the Volume
2970    can be written indefinitely.  Otherwise, the next time a job
2971    runs that wants to access this Volume, and the time period from the
2972    first write to the volume (the first Job written) exceeds the
2973    time-period-specification, the Volume will be marked {\bf Used}, which
2974    means that no more Jobs can be appended to the Volume, but it may be
2975    recycled if recycling is enabled. Using the command {\bf
2976    status dir} applies algorithms similar to running jobs, so
2977    during such a command, the Volume status may also be changed.
2978    Once the Volume is
2979    recycled, it will be available for use again.
2980
2981    You might use this directive, for example, if you have a Volume used for
2982    Incremental backups, and Volumes used for Weekly Full backups.  Once the
2983    Full backup is done, you will want to use a different Incremental
2984    Volume.  This can be accomplished by setting the Volume Use Duration for
2985    the Incremental Volume to six days.  I.e.  it will be used for the 6
2986    days following a Full save, then a different Incremental volume will be
2987    used.  Be careful about setting the duration to short periods such as 23
2988    hours, or you might experience problems of Bacula waiting for a tape
2989    over the weekend only to complete the backups Monday morning when an
2990    operator mounts a new tape.
2991
2992    The use duration is checked and the {\bf Used} status is set only at the
2993    end of a job that writes to the particular volume, which means that even
2994    though the use duration may have expired, the catalog entry will not be
2995    updated until the next job that uses this volume is run. This
2996    directive is not intended to be used to limit volume sizes
2997    and will not work correctly (i.e. will fail jobs) if the use
2998    duration expires while multiple simultaneous jobs are writing
2999    to the volume.
3000
3001    Please note that the value defined by this directive in the  bacula-dir.conf
3002    file is the default value used when a Volume  is created. Once the volume is
3003    created, changing the value  in the bacula-dir.conf file will not change what
3004    is stored  for the Volume. To change the value for an existing Volume  you
3005    must use the
3006    \bsysxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
3007
3008    \label{Director:Pool:CatalogFiles}
3009 \item [Catalog Files = \lt{}yes\vb{}no\gt{}]
3010    \index[dir]{Catalog Files}
3011    \index[dir]{Directive!Catalog Files}
3012    This directive defines whether or not you want the names of the files
3013    that were saved to be put into the catalog.  The default is {\bf yes}.
3014    The advantage of specifying {\bf Catalog Files = No} is that you will
3015    have a significantly smaller Catalog database.  The disadvantage is that
3016    you will not be able to produce a Catalog listing of the files backed up
3017    for each Job (this is often called Browsing).  Also, without the File
3018    entries in the catalog, you will not be able to use the Console {\bf
3019    restore} command nor any other command that references File entries.
3020 \label{PoolAutoPrune}
3021
3022    \label{Director:Pool:AutoPrune}
3023 \item [AutoPrune = \lt{}yes\vb{}no\gt{}]
3024    \index[dir]{AutoPrune}
3025    \index[dir]{Directive!AutoPrune}
3026    If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
3027    greater) will automatically apply the Volume Retention period when new
3028    Volume is needed and no appendable Volumes exist in the Pool.  Volume
3029    pruning causes expired Jobs (older than the {\bf Volume Retention}
3030    period) to be deleted from the Catalog and permits possible recycling of
3031    the Volume.
3032 \label{VolRetention}
3033
3034    \label{Director:Pool:VolumeRetention}
3035 \item [Volume Retention = \lt{}time-period-specification\gt{}]
3036    \index[dir]{Volume Retention}
3037    \index[dir]{Directive!Volume Retention}
3038    The Volume Retention directive defines the length of time that {\bf
3039    Bacula} will keep records associated with the Volume in
3040    the Catalog database after the End time of each Job written to the
3041    Volume.  When this time period expires, and if {\bf AutoPrune} is set to
3042    {\bf yes} Bacula may prune (remove) Job records that are older than the
3043    specified Volume Retention period if it is necessary to free up a
3044    Volume.  Recycling will not occur until it is absolutely necessary to
3045    free up a volume (i.e. no other writable volume exists).
3046    All File records associated with pruned Jobs are also
3047    pruned.  The time may be specified as seconds, minutes, hours, days,
3048    weeks, months, quarters, or years.  The {\bf Volume Retention} is
3049    applied independently of the {\bf Job Retention} and the {\bf File
3050    Retention} periods defined in the Client resource.  This means that all
3051    the retentions periods are applied in turn and that the shorter period
3052    is the one that effectively takes precedence.  Note, that when the {\bf
3053    Volume Retention} period has been reached, and it is necessary to obtain
3054    a new volume, Bacula will prune both the Job and the File records.  This
3055    pruning could also occur during a {\bf status dir} command because it
3056    uses similar algorithms for finding the next available Volume.
3057
3058    It is important to know that when the Volume Retention period expires,
3059    Bacula does not automatically recycle a Volume. It attempts to keep the
3060    Volume data intact as long as possible before over writing the Volume.
3061
3062    By defining multiple Pools with different Volume Retention periods, you
3063    may effectively have a set of tapes that is recycled weekly, another
3064    Pool of tapes that is recycled monthly and so on.  However, one must
3065    keep in mind that if your {\bf Volume Retention} period is too short, it
3066    may prune the last valid Full backup, and hence until the next Full
3067    backup is done, you will not have a complete backup of your system, and
3068    in addition, the next Incremental or Differential backup will be
3069    promoted to a Full backup.  As a consequence, the minimum {\bf Volume
3070    Retention} period should be at twice the interval of your Full backups.
3071    This means that if you do a Full backup once a month, the minimum Volume
3072    retention period should be two months.
3073
3074    The default Volume retention period is 365 days, and either the default
3075    or the value defined by this directive in the bacula-dir.conf file is
3076    the default value used when a Volume is created.  Once the volume is
3077    created, changing the value in the bacula-dir.conf file will not change
3078    what is stored for the Volume.  To change the value for an existing
3079    Volume you must use the {\bf update} command in the Console.
3080
3081 \label{Director:Pool:ActionOnPurge}
3082 \item [Action On Purge = \lt{Truncate}]
3083 \index[dir]{actiononpurge}
3084
3085 This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
3086 volume when it is purged with the \texttt{purge volume action=truncate}
3087 command. It is useful to prevent disk based volumes from consuming too much
3088 space.
3089
3090 \begin{lstlisting}
3091 Pool {
3092   Name = Default
3093   Action On Purge = Truncate
3094   ...
3095 }
3096 \end{lstlisting}
3097
3098 You can schedule the truncate operation at the end of your CatalogBackup job
3099 like in this example:
3100
3101 \begin{lstlisting}
3102 Job {
3103  Name = CatalogBackup
3104  ...
3105  RunScript {
3106    RunsWhen=After
3107    RunsOnClient=No
3108    Console = "purge volume action=all allpools storage=File"
3109  }
3110 }
3111 \end{lstlisting}
3112 \label{PoolScratchPool}
3113
3114    \label{Director:Pool:ScratchPool}
3115 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
3116    \index[dir]{ScrachPool}
3117    \index[dir]{Directive!ScrachPool}
3118    This directive permits to specify a dedicate \textsl{Scratch} for the
3119    current pool. This pool will replace the special pool named \textsl{Scrach}
3120    for volume selection. For more information about \textsl{Scratch} see
3121    \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful
3122    when using multiple storage sharing the same mediatype or when you want to
3123    dedicate volumes to a particular set of pool.
3124 \label{PoolRecyclePool}
3125
3126    \label{Director:Pool:RecyclePool}
3127 \item [RecyclePool = \lt{}pool-resource-name\gt{}]
3128    \index[dir]{RecyclePool}
3129    \index[dir]{Directive!RecyclePool}
3130    This directive defines to which pool
3131    the Volume will be placed (moved) when it is recycled. Without
3132    this directive, a Volume will remain in the same pool when it is
3133    recycled. With this directive, it can be moved automatically to any
3134    existing pool during a recycle. This directive is probably most
3135    useful when defined in the Scratch pool, so that volumes will
3136    be recycled back into the Scratch pool. For more on the see the
3137    \ilink{Scratch Pool}{TheScratchPool} section of this manual.
3138
3139    Although this directive is called RecyclePool, the Volume in
3140    question is actually moved from its current pool to the one
3141    you specify on this directive when Bacula prunes the Volume and
3142    discovers that there are no records left in the catalog and hence
3143    marks it as {\bf Purged}.
3144
3145 \label{PoolRecycle}
3146
3147    \label{Director:Pool:Recycle}
3148 \item [Recycle = \lt{}yes\vb{}no\gt{}]
3149    \index[dir]{Recycle}
3150    \index[dir]{Directive!Recycle}
3151    This directive specifies whether or not Purged Volumes may be recycled.
3152    If it is set to {\bf yes} (default) and Bacula needs a volume but finds
3153    none that are appendable, it will search for and recycle (reuse) Purged
3154    Volumes (i.e.  volumes with all the Jobs and Files expired and thus
3155    deleted from the Catalog).  If the Volume is recycled, all previous data
3156    written to that Volume will be overwritten. If Recycle is set to {\bf
3157    no}, the Volume will not be recycled, and hence, the data will remain
3158    valid.  If you want to reuse (re-write) the Volume, and the recycle flag
3159    is no (0 in the catalog), you may manually set the recycle flag (update
3160    command) for a Volume to be reused.
3161
3162    Please note that the value defined by this directive in the
3163    bacula-dir.conf file is the default value used when a Volume is created.
3164    Once the volume is created, changing the value in the bacula-dir.conf
3165    file will not change what is stored for the Volume.  To change the value
3166    for an existing Volume you must use the {\bf update} command in the
3167    Console.
3168
3169    When all Job and File records have been pruned or purged from the
3170    catalog for a particular Volume, if that Volume is marked as
3171    Append, Full, Used, or Error, it will then be marked as Purged. Only
3172    Volumes marked as Purged will be considered to be converted to the
3173    Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
3174
3175 \label{RecycleOldest}
3176
3177    \label{Director:Pool:RecycleOldestVolume}
3178 \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
3179    \index[dir]{Recycle Oldest Volume}
3180    \index[dir]{Directive!Recycle Oldest Volume}
3181    This directive instructs the Director to search for the oldest used
3182    Volume in the Pool when another Volume is requested by the Storage
3183    daemon and none are available.  The catalog is then {\bf pruned}
3184    respecting the retention periods of all Files and Jobs written to this
3185    Volume.  If all Jobs are pruned (i.e. the volume is Purged), then the
3186    Volume is recycled and will be used as the next Volume to be written.
3187    This directive respects any Job, File, or Volume retention periods that
3188    you may have specified, and as such it is {\bf much} better to use this
3189    directive than the Purge Oldest Volume.
3190
3191    This directive can be useful if you have a fixed number of Volumes in the
3192    Pool and you want to cycle through them and you have specified the correct
3193    retention periods.
3194
3195    However, if you use this directive and have only one
3196    Volume in the Pool, you will immediately recycle your Volume if you fill
3197    it and Bacula needs another one. Thus your backup will be totally invalid.
3198    Please use this directive with care. The default is {\bf no}.
3199 \label{RecycleCurrent}
3200
3201
3202    \label{Director:Pool:RecycleCurrentVolume}
3203 \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
3204    \index[dir]{Recycle Current Volume}
3205    \index[dir]{Directive!Recycle Current Volume}
3206    If Bacula needs a new Volume, this directive instructs Bacula to Prune
3207    the volume respecting the Job and File retention periods.  If all Jobs
3208    are pruned (i.e.  the volume is Purged), then the Volume is recycled and
3209    will be used as the next Volume to be written.  This directive respects
3210    any Job, File, or Volume retention periods that you may have specified,
3211    and thus it is {\bf much} better to use it rather than the Purge Oldest
3212    Volume directive.
3213
3214    This directive can be useful if you have: a fixed number of Volumes in
3215    the Pool, you want to cycle through them, and you have specified
3216    retention periods that prune Volumes before you have cycled through the
3217    Volume in the Pool.
3218
3219    However, if you use this directive and have only one Volume in the Pool,
3220    you will immediately recycle your Volume if you fill it and Bacula needs
3221    another one.  Thus your backup will be totally invalid.  Please use this
3222    directive with care.  The default is {\bf no}.
3223 \label{PurgeOldest}
3224
3225
3226    \label{Director:Pool:PurgeOldestVolume}
3227 \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
3228    \index[dir]{Purge Oldest Volume}
3229    \index[dir]{Directive!Purge Oldest Volume}
3230    This directive instructs the Director to search for the oldest used
3231    Volume in the Pool when another Volume is requested by the Storage
3232    daemon and none are available.  The catalog is then {\bf purged}
3233    irrespective of retention periods of all Files and Jobs written to this
3234    Volume.  The Volume is then recycled and will be used as the next Volume
3235    to be written.  This directive overrides any Job, File, or Volume
3236    retention periods that you may have specified.
3237
3238    This directive can be useful if you have a fixed number of Volumes in
3239    the Pool and you want to cycle through them and reusing the oldest one
3240    when all Volumes are full, but you don't want to worry about setting
3241    proper retention periods.  However, by using this option you risk losing
3242    valuable data.
3243
3244    Please be aware that {\bf Purge Oldest Volume} disregards all retention
3245    periods. If you have only a single Volume defined and you turn this
3246    variable on, that Volume will always be immediately overwritten when it
3247    fills!  So at a minimum, ensure that you have a decent number of Volumes
3248    in your Pool before running any jobs.  If you want retention periods to
3249    apply do not use this directive.  To specify a retention period, use the
3250    {\bf Volume Retention} directive (see above).
3251
3252    We {\bf highly} recommend against using this directive, because it is
3253    sure that some day, Bacula will recycle a Volume that contains current
3254    data.  The default is {\bf no}.
3255
3256    \label{Director:Pool:FileRetention}
3257 \item [File Retention = \lt{}time-period-specification\gt{}]
3258    \index[dir]{File Retention}
3259    \index[dir]{Directive!File Retention}
3260    The File Retention directive defines the length of time that  Bacula will
3261    keep File records in the Catalog database after the End time of the
3262    Job corresponding to the File records.
3263
3264    This directive takes precedence over Client directives of the same name. For
3265    example, you can decide to increase Retention times for Archive or OffSite
3266    Pool.
3267
3268    Note, this affects only records in the catalog database. It does not affect
3269    your archive backups.
3270
3271    For more information see Client documentation about
3272    \ilink{FileRetention}{FileRetention}
3273
3274    \label{Director:Pool:JobRetention}
3275 \item [Job Retention = \lt{}time-period-specification\gt{}]
3276    \index[dir]{Job Retention}
3277    \index[dir]{Directive!Job Retention}
3278
3279    The Job Retention directive defines the length of time that Bacula will keep
3280    Job records in the Catalog database after the Job End time.  As with the
3281    other retention periods, this affects only records in the catalog and not
3282    data in your archive backup.
3283
3284    This directive takes precedence over Client directives of the same name.
3285    For example, you can decide to increase Retention times for Archive or
3286    OffSite Pool.
3287
3288    For more information see Client side documentation
3289    \ilink{JobRetention}{JobRetention}
3290
3291    \label{Director:Pool:CleaningPrefix}
3292 \item [Cleaning Prefix = \lt{}string\gt{}]
3293    \index[dir]{Cleaning Prefix}
3294    \index[dir]{Directive!Cleaning Prefix}
3295    This directive defines a prefix string, which if it matches the
3296    beginning of a Volume name during labeling of a Volume, the Volume will
3297    be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
3298    never attempt to use this tape.  This is primarily for use with
3299    autochangers that accept barcodes where the convention is that barcodes
3300    beginning with {\bf CLN} are treated as cleaning tapes.
3301 \label{Label}
3302
3303    \label{Director:Pool:LabelFormat}
3304 \item [Label Format = \lt{}format\gt{}]
3305    \index[dir]{Label Format}
3306    \index[dir]{Directive!Label Format}
3307    This directive specifies the format of the labels contained in this
3308    pool.  The format directive is used as a sort of template to create new
3309    Volume names during automatic Volume labeling.
3310
3311    The {\bf format} should be specified in double quotes, and consists of
3312    letters, numbers and the special characters hyphen ({\bf -}), underscore
3313    ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
3314    characters for a Volume name.  The {\bf format} should be enclosed in
3315    double quotes (").
3316
3317    In addition, the format may contain a number of variable expansion
3318    characters which will be expanded by a complex algorithm allowing you to
3319    create Volume names of many different formats.  In all cases, the
3320    expansion process must resolve to the set of characters noted above that
3321    are legal Volume names.  Generally, these variable expansion characters
3322    begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}).  If you
3323    specify variable expansion characters, you should always enclose the
3324    format with double quote characters ({\bf "}).  For more details on
3325    variable expansion, please see the \bsysxrlink{Variable
3326    Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
3327
3328    If no variable expansion characters are found in the string, the Volume
3329    name will be formed from the {\bf format} string appended with the
3330    a unique number that increases.  If you do not remove volumes from the
3331    pool, this number should be the number of volumes plus one, but this
3332    is not guaranteed. The unique number will be edited as four
3333    digits with leading zeros.  For example, with a {\bf Label Format =
3334    "File-"}, the first volumes will be named {\bf File-0001}, {\bf
3335    File-0002}, \ldots{}
3336
3337    With the exception of Job specific variables, you can test your {\bf
3338    LabelFormat} by using the \bsysxrlink{var}{var}{console}{command} in the
3339  \consoleman{}.
3340
3341    In almost all cases, you should enclose the format specification (part
3342    after the equal sign) in double quotes.  Please note that this directive
3343    is deprecated and is replaced in version 1.37 and greater with a Python
3344    script for creating volume names.
3345
3346 \label{Director:Pool:End}
3347 \end{description}
3348
3349 In order for a Pool to be used during a Backup Job, the Pool must have at
3350 least one Volume associated with it.  Volumes are created for a Pool using
3351 the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
3352 program.  In addition to adding Volumes to the Pool (i.e.  putting the
3353 Volume names in the Catalog database), the physical Volume must be labeled
3354 with a valid Bacula software volume label before {\bf Bacula} will accept
3355 the Volume.  This will be automatically done if you use the {\bf label}
3356 command.  Bacula can automatically label Volumes if instructed to do so,
3357 but this feature is not yet fully implemented.
3358
3359 The following is an example of a valid Pool resource definition:
3360
3361 \footnotesize
3362 \begin{lstlisting}
3363
3364 Pool {
3365   Name = Default
3366   Pool Type = Backup
3367 }
3368 \end{lstlisting}
3369 \normalsize
3370
3371 \label{TheScratchPool}
3372 \subsection{The Scratch Pool}
3373 \index[general]{Scratch Pool}
3374 In general, you can give your Pools any name you wish, but there is one
3375 important restriction: the Pool named {\bf Scratch}, if it exists behaves
3376 like a scratch pool of Volumes in that when Bacula needs a new Volume for
3377 writing and it cannot find one, it will look in the Scratch pool, and if
3378 it finds an available Volume, it will move it out of the Scratch pool into
3379 the Pool currently being used by the job.
3380
3381
3382 \label{CatalogResource}
3383 \section{The Catalog Resource}
3384 \index[general]{Resource!Catalog}
3385 \index[general]{Catalog Resource}
3386
3387 The Catalog Resource defines what catalog to use for the current job.
3388 Currently, Bacula can only handle a single database server (SQLite, MySQL,
3389 PostgreSQL) that is defined when configuring {\bf Bacula}.  However, there
3390 may be as many Catalogs (databases) defined as you wish.  For example, you
3391 may want each Client to have its own Catalog database, or you may want
3392 backup jobs to use one database and verify or restore jobs to use another
3393 database.
3394
3395 Since SQLite is compiled in, it always runs on the same machine
3396 as the Director and the database must be directly accessible (mounted) from
3397 the Director.  However, since both MySQL and PostgreSQL are networked
3398 databases, they may reside either on the same machine as the Director
3399 or on a different machine on the network.  See below for more details.
3400
3401 \begin{description}
3402
3403 \item [Catalog]
3404    \index[dir]{Catalog}
3405    \index[dir]{Directive!Catalog}
3406    Start of the Catalog resource.  At least one Catalog resource must be
3407 defined.
3408
3409
3410    \label{Director:Catalog:Name}
3411 \item [Name = \lt{}name\gt{}]
3412    \index[dir]{Name}
3413    \index[dir]{Directive!Name}
3414    The name of the Catalog.  No necessary relation to the database server
3415    name.  This name will be specified in the Client resource directive
3416    indicating that all catalog data for that Client is maintained in this
3417    Catalog.  This directive is required.
3418
3419    \label{Director:Catalog:Password}
3420 \item [password = \lt{}password\gt{}]
3421    \index[dir]{password}
3422    \index[dir]{Directive!password}
3423    This specifies the password to use when logging into the database.  This
3424    directive is required.
3425
3426    \label{Director:Catalog:DbName}
3427 \item [DB Name = \lt{}name\gt{}]
3428    \index[dir]{DB Name}
3429    \index[dir]{Directive!DB Name}
3430    This specifies the name of the database.  If you use multiple catalogs
3431    (databases), you specify which one here.  If you are using an external
3432    database server rather than the internal one, you must specify a name
3433    that is known to the server (i.e.  you explicitly created the Bacula
3434    tables using this name.  This directive is required.
3435
3436    \label{Director:Catalog:User}
3437 \item [user = \lt{}user\gt{}]
3438    \index[dir]{user}
3439    \index[dir]{Directive!user}
3440    This specifies what user name to use to log into the database.  This
3441    directive is required.
3442
3443    \label{Director:Catalog:DbSocket}
3444 \item [DB Socket = \lt{}socket-name\gt{}]
3445    \index[dir]{DB Socket}
3446    \index[dir]{Directive!DB Socket}
3447    This is the name of  a socket to use on the local host to connect to the
3448    database. This directive is used only by MySQL and is ignored by  SQLite.
3449    Normally, if neither {\bf DB Socket} or {\bf DB Address}  are specified, MySQL
3450    will use the default socket. If the DB Socket is specified, the
3451    MySQL server must reside on the same machine as the Director.
3452
3453    \label{Director:Catalog:DBAddress}
3454 \item [DB Address = \lt{}address\gt{}]
3455    \index[dir]{DB Address}
3456    \index[dir]{Directive!DB Address}
3457    This is the host address  of the database server. Normally, you would specify
3458    this instead  of {\bf DB Socket} if the database server is on another machine.
3459    In that case, you will also specify {\bf DB Port}. This directive  is used
3460    only by MySQL and PostgreSQL and is ignored by SQLite if provided.
3461    This directive is optional.
3462
3463    \label{Director:Catalog:DbPort}
3464 \item [DB Port = \lt{}port\gt{}]
3465    \index[dir]{DB Port}
3466    \index[dir]{Directive!DB Port}
3467    This defines the port to  be used in conjunction with {\bf DB Address} to
3468    access the  database if it is on another machine. This directive is used  only
3469    by MySQL and PostgreSQL and is ignored by SQLite if provided.  This
3470    directive is optional.
3471
3472 \label{Director:Catalog:End}
3473
3474 %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
3475
3476 %% \index[dir]{Directive!Multiple Connections}
3477 %% By default, this  directive is set to no. In that case, each job that uses
3478 the
3479 %% same Catalog will use a single connection to the catalog. It will  be shared,
3480 %% and Bacula will allow only one Job at a time to  communicate. If you set this
3481 %% directive to yes, Bacula will  permit multiple connections to the database,
3482 %% and the database  must be multi-thread capable. For SQLite and PostgreSQL,
3483 %% this is  no problem. For MySQL, you must be *very* careful to have the
3484 %% multi-thread version of the client library loaded on your system.  When this
3485 %% directive is set yes, each Job will have a separate  connection to the
3486 %% database, and the database will control the  interaction between the
3487 different
3488 %% Jobs. This can significantly  speed up the database operations if you are
3489 %% running multiple  simultaneous jobs. In addition, for SQLite and PostgreSQL,
3490 %% Bacula  will automatically enable transactions. This can significantly  speed
3491 %% up insertion of attributes in the database either for  a single Job or
3492 %% multiple simultaneous Jobs.
3493
3494 %% This directive has not been tested. Please test carefully  before running it
3495 %% in production and report back your results.
3496
3497 \end{description}
3498
3499 The following is an example of a valid Catalog resource definition:
3500
3501 \footnotesize
3502 \begin{lstlisting}
3503 Catalog
3504 {
3505   Name = SQLite
3506   dbname = bacula;
3507   user = bacula;
3508   password = ""                       # no password = no security
3509 }
3510 \end{lstlisting}
3511 \normalsize
3512
3513 or for a Catalog on another machine:
3514
3515 \footnotesize
3516 \begin{lstlisting}
3517 Catalog
3518 {
3519   Name = MySQL
3520   dbname = bacula
3521   user = bacula
3522   password = ""
3523   DB Address = remote.acme.com
3524   DB Port = 1234
3525 }
3526 \end{lstlisting}
3527 \normalsize
3528
3529 \label{MessagesResource2}
3530 \section{The Messages Resource}
3531 \index[general]{Resource!Messages}
3532 \index[general]{Messages Resource}
3533
3534 For the details of the Messages Resource, please see the
3535 \ilink{Messages Resource Chapter}{MessagesChapter} of this
3536 manual.
3537
3538 \label{ConsoleResource1}
3539 \section{The Console Resource}
3540 \index[general]{Console Resource}
3541 \index[general]{Resource!Console}
3542
3543 As of Bacula version 1.33 and higher, there are three different kinds of
3544 consoles, which the administrator or user can use to interact with the
3545 Director. These three kinds of consoles comprise three different security
3546 levels.
3547
3548 \begin{bsysitemize}
3549 \item The first console type is an {\bf anonymous} or {\bf default}  console,
3550    which has full privileges.  There is no console resource necessary for
3551    this type since the password is specified in the Director's resource and
3552    consequently such consoles do not have a name as defined on a {\bf Name
3553    =} directive.  This is the kind of console that was initially
3554    implemented in versions prior to 1.33 and remains valid.  Typically you
3555    would use it only for  administrators.
3556
3557 \item The second type of console, and new to version 1.33 and  higher is a
3558    ``named'' console defined within a Console resource in both the Director's
3559    configuration file and in the Console's configuration file.  Both the
3560    names and the passwords in these two entries must match much as is the
3561    case for Client programs.
3562
3563    This second type of console begins with absolutely no privileges except
3564    those explicitly specified in the Director's Console resource.  Thus you
3565    can have multiple Consoles with different names and passwords, sort of
3566    like multiple users, each with different privileges.  As a default,
3567    these consoles can do absolutely nothing -- no commands whatsoever.  You
3568    give them privileges or rather access to commands and resources by
3569    specifying access control lists in the Director's Console resource.  The
3570    ACLs are specified by a directive followed by a list of access names.
3571    Examples of this are shown below.
3572
3573 \item The third type of console is similar to the above mentioned  one in that
3574    it requires a Console resource definition in both the Director and the
3575    Console.  In addition, if the console name, provided on the {\bf Name =}
3576    directive, is the same as a Client name, that console is permitted to
3577    use the {\bf SetIP} command to change the Address directive in the
3578    Director's client resource to the IP address of the Console.  This
3579    permits portables or other machines using DHCP (non-fixed IP addresses)
3580    to ``notify'' the Director of their current IP address.
3581 \end{bsysitemize}
3582
3583 The Console resource is optional and need not be specified. The following
3584 directives are permitted within the Director's configuration resource:
3585
3586 \begin{description}
3587
3588    \label{Director:Console:Name}
3589 \item [Name = \lt{}name\gt{}]
3590    \index[dir]{Name}
3591    \index[dir]{Directive!Name}
3592    The name of the console. This  name must match the name specified in the
3593 Console's configuration  resource (much as is the case with Client
3594 definitions).
3595
3596    \label{Director:Console:Password}
3597 \item [Password = \lt{}password\gt{}]
3598    \index[dir]{Password}
3599    \index[dir]{Directive!Password}
3600    Specifies the password that must be supplied for a named Bacula Console
3601    to be authorized.  The same password must appear in the {\bf Console}
3602    resource of the Console configuration file.  For added security, the
3603    password is never actually passed across the network but rather a
3604    challenge response hash code created with the password.  This directive
3605    is required.  If you have either {\bf /dev/random} {\bf bc} on your
3606    machine, Bacula will generate a random password during the configuration
3607    process, otherwise it will be left blank.
3608
3609    The password is plain text.  It is not generated through any special
3610    process.  However, it is preferable for security reasons to choose
3611    random text.
3612
3613    \label{Director:Console:JobAcl}
3614 \item [JobACL = \lt{}name-list\gt{}]
3615    \index[dir]{JobACL}
3616    \index[dir]{Directive!JobACL}
3617    This directive is used to specify a list of Job resource names that can
3618    be accessed by the console.  Without this directive, the console cannot
3619    access any of the Director's Job resources.  Multiple Job resource names
3620    may be specified by separating them with commas, and/or by specifying
3621    multiple JobACL directives.  For example, the directive may be specified
3622    as:
3623
3624 \footnotesize
3625 \begin{lstlisting}
3626     JobACL = kernsave, "Backup client 1", "Backup client 2"
3627     JobACL = "RestoreFiles"
3628
3629 \end{lstlisting}
3630 \normalsize
3631
3632 With the above specification, the console can access the Director's  resources
3633 for the four jobs named on the JobACL directives,  but for no others.
3634
3635    \label{Director:Console:ClientAcl}
3636 \item [ClientACL = \lt{}name-list\gt{}]
3637    \index[dir]{ClientACL}
3638    \index[dir]{Directive!ClientACL}
3639    This directive is used to  specify a list of Client resource names that can
3640 be
3641 accessed by  the console.
3642
3643    \label{Director:Console:StorageAcl}
3644 \item [StorageACL = \lt{}name-list\gt{}]
3645    \index[dir]{StorageACL}
3646    \index[dir]{Directive!StorageACL}
3647    This directive is used to  specify a list of Storage resource names that can
3648 be accessed by  the console.
3649
3650    \label{Director:Console:ScheduleAcl}
3651 \item [ScheduleACL = \lt{}name-list\gt{}]
3652    \index[dir]{ScheduleACL}
3653    \index[dir]{Directive!ScheduleACL}
3654    This directive is used to  specify a list of Schedule resource names that can
3655    be accessed by the console.
3656
3657    \label{Director:Console:PoolAcl}
3658 \item [PoolACL = \lt{}name-list\gt{}]
3659    \index[dir]{PoolACL}
3660    \index[dir]{Directive!PoolACL}
3661    This directive is used to  specify a list of Pool resource names that can be
3662    accessed by the console.
3663
3664    \label{Director:Console:FileSetAcl}
3665 \item [FileSetACL = \lt{}name-list\gt{}]
3666    \index[dir]{FileSetACL}
3667    \index[dir]{Directive!FileSetACL}
3668    This directive is used to specify a list of FileSet resource names that
3669    can be accessed by the console.
3670
3671    \label{Director:Console:CatalogAcl}
3672 \item [CatalogACL = \lt{}name-list\gt{}]
3673    \index[dir]{CatalogACL}
3674    \index[dir]{Directive!CatalogACL}
3675    This directive is used to specify a list of Catalog resource names that
3676    can be accessed by the console.
3677
3678    \label{Director:Console:CommandAcl}
3679 \item [CommandACL = \lt{}name-list\gt{}]
3680    \index[dir]{CommandACL}
3681    \index[dir]{Directive!CommandACL}
3682    This directive is used to specify a list of of console commands that can
3683    be executed by the console.
3684
3685    \label{Director:Console:WhereAcl}
3686 \item [WhereACL = \lt{}string\gt{}]
3687    \index[dir]{WhereACL}
3688    \index[dir]{Directive!WhereACL}
3689    This directive permits you to specify where a restricted console
3690    can restore files. If this directive is not specified, only the
3691    default restore location is permitted (normally {\bf
3692    /tmp/bacula-restores}. If {\bf *all*} is specified any path the
3693    user enters will be accepted (not very secure), any other
3694    value specified (there may be multiple WhereACL directives) will
3695    restrict the user to use that path. For example, on a Unix system,
3696    if you specify ``/'', the file will be restored to the original
3697    location.  This directive is untested.
3698
3699 \end{description}
3700
3701 Aside from Director resource names and console command names, the special
3702 keyword {\bf *all*} can be specified in any of the above access control lists.
3703 When this keyword is present, any resource or command name (which ever is
3704 appropriate) will be accepted. For an example configuration file, please see
3705 the
3706 \ilink{Console Configuration}{ConsoleConfChapter} chapter of this
3707 manual.
3708
3709 \label{CounterResource}
3710 \section{The Counter Resource}
3711 \index[general]{Resource!Counter}
3712 \index[general]{Counter Resource}
3713
3714 The Counter Resource defines a counter variable that can be accessed by
3715 variable expansion used for creating Volume labels with the {\bf LabelFormat}
3716 directive. See the
3717 \ilink{LabelFormat}{Label} directive in this chapter for more
3718 details.
3719
3720 \begin{description}
3721
3722 \item [Counter]
3723    \index[dir]{Counter}
3724    \index[dir]{Directive!Counter}
3725    Start of the Counter resource.  Counter directives are optional.
3726
3727    \label{Director:Counter:Name}
3728 \item [Name = \lt{}name\gt{}]
3729    \index[dir]{Name}
3730    \index[dir]{Directive!Name}
3731    The name of the Counter.  This is the name you will use in the variable
3732 expansion  to reference the counter value.
3733
3734    \label{Director:Counter:Minimum}
3735 \item [Minimum = \lt{}integer\gt{}]
3736    \index[dir]{Minimum}
3737    \index[dir]{Directive!Minimum}
3738    This specifies the minimum  value that the counter can have. It also becomes
3739 the default.  If not supplied, zero is assumed.
3740
3741    \label{Director:Counter:Maximum}
3742 \item [Maximum = \lt{}integer\gt{}]
3743    \index[dir]{Maximum}
3744    \index[dir]{Directive!Maximum}
3745    \index[dir]{Directive!Maximum}
3746    This is the maximum value  value that the counter can have. If not specified
3747 or set to  zero, the counter can have a maximum value of 2,147,483,648  (2 to
3748 the 31 power). When the counter is incremented past  this value, it is reset
3749 to the Minimum.
3750
3751    \label{Director:Counter:*WrapCounter}
3752 \item [*WrapCounter = \lt{}counter-name\gt{}]
3753    \index[dir]{*WrapCounter}
3754    \index[dir]{Directive!*WrapCounter}
3755    If this value  is specified, when the counter is incremented past the
3756 maximum
3757 and thus reset to the minimum, the counter specified on the  {\bf WrapCounter}
3758 is incremented. (This is not currently  implemented).
3759
3760    \label{Director:Counter:Catalog}
3761 \item [Catalog = \lt{}catalog-name\gt{}]
3762    \index[dir]{Catalog}
3763    \index[dir]{Directive!Catalog}
3764    If this directive is  specified, the counter and its values will be saved in
3765 the specified catalog. If this directive is not present, the  counter will be
3766 redefined each time that Bacula is started.
3767
3768 \label{Director:Counter:End}
3769 \end{description}
3770
3771 \label{SampleDirectorConfiguration}
3772 \section{Example Director Configuration File}
3773 \index[general]{File!Example Director Configuration}
3774 \index[general]{Example Director Configuration File}
3775
3776 An example Director configuration file might be the following:
3777
3778 \footnotesize
3779 \begin{lstlisting}
3780 #
3781 # Default Bacula Director Configuration file
3782 #
3783 #  The only thing that MUST be changed is to add one or more
3784 #   file or directory names in the Include directive of the
3785 #   FileSet resource.
3786 #
3787 #  For Bacula release 1.15 (5 March 2002) -- redhat
3788 #
3789 #  You might also want to change the default email address
3790 #   from root to your address.  See the "mail" and "operator"
3791 #   directives in the Messages resource.
3792 #
3793 Director {                            # define myself
3794   Name = rufus-dir
3795   QueryFile = "/home/kern/bacula/bin/query.sql"
3796   WorkingDirectory = "/home/kern/bacula/bin/working"
3797   PidDirectory = "/home/kern/bacula/bin/working"
3798   Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
3799 }
3800 # Define the backup Job
3801 Job {
3802   Name = "NightlySave"
3803   Type = Backup
3804   Level = Incremental                 # default
3805   Client=rufus-fd
3806   FileSet="Full Set"
3807   Schedule = "WeeklyCycle"
3808   Storage = DLTDrive
3809   Messages = Standard
3810   Pool = Default
3811 }
3812 Job {
3813   Name = "Restore"
3814   Type = Restore
3815   Client=rufus-fd
3816   FileSet="Full Set"
3817   Where = /tmp/bacula-restores
3818   Storage = DLTDrive
3819   Messages = Standard
3820   Pool = Default
3821 }
3822
3823 # List of files to be backed up
3824 FileSet {
3825   Name = "Full Set"
3826   Include {
3827     Options { signature=SHA1}
3828 #
3829 #  Put your list of files here, one per line or include an
3830 #    external list with:
3831 #
3832 #    @file-name
3833 #
3834 #  Note: / backs up everything
3835   File = /
3836 }
3837   Exclude {}
3838 }
3839 # When to do the backups
3840 Schedule {
3841   Name = "WeeklyCycle"
3842   Run = level=Full sun at 2:05
3843   Run = level=Incremental mon-sat at 2:05
3844 }
3845 # Client (File Services) to backup
3846 Client {
3847   Name = rufus-fd
3848   Address = rufus
3849   Catalog = MyCatalog
3850   Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
3851   File Retention = 60d      # sixty day file retention
3852   Job Retention = 1y        # 1 year Job retention
3853   AutoPrune = yes           # Auto apply retention periods
3854 }
3855 # Definition of DLT tape storage device
3856 Storage {
3857   Name = DLTDrive
3858   Address = rufus
3859   Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3860   Device = "HP DLT 80"      # same as Device in Storage daemon
3861   Media Type = DLT8000      # same as MediaType in Storage daemon
3862 }
3863 # Definition for a DLT autochanger device
3864 Storage {
3865   Name = Autochanger
3866   Address = rufus
3867   Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3868   Device = "Autochanger"    # same as Device in Storage daemon
3869   Media Type = DLT-8000     # Different from DLTDrive
3870   Autochanger = yes
3871 }
3872 # Definition of DDS tape storage device
3873 Storage {
3874   Name = SDT-10000
3875   Address = rufus
3876   Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3877   Device = SDT-10000        # same as Device in Storage daemon
3878   Media Type = DDS-4        # same as MediaType in Storage daemon
3879 }
3880 # Definition of 8mm tape storage device
3881 Storage {
3882   Name = "8mmDrive"
3883   Address = rufus
3884   Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3885   Device = "Exabyte 8mm"
3886   MediaType = "8mm"
3887 }
3888 # Definition of file storage device
3889 Storage {
3890   Name = File
3891   Address = rufus
3892   Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
3893   Device = FileStorage
3894   Media Type = File
3895 }
3896 # Generic catalog service
3897 Catalog {
3898   Name = MyCatalog
3899   dbname = bacula; user = bacula; password = ""
3900 }
3901 # Reasonable message delivery -- send most everything to
3902 #   the email address and to the console
3903 Messages {
3904   Name = Standard
3905   mail = root@localhost = all, !skipped, !terminate
3906   operator = root@localhost = mount
3907   console = all, !skipped, !saved
3908 }
3909
3910 # Default pool definition
3911 Pool {
3912   Name = Default
3913   Pool Type = Backup
3914   AutoPrune = yes
3915   Recycle = yes
3916 }
3917 #
3918 # Restricted console used by tray-monitor to get the status of the director
3919 #
3920 Console {
3921   Name = Monitor
3922   Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
3923   CommandACL = status, .status
3924 }
3925 \end{lstlisting}
3926 \normalsize