1 \chapter{New Features in 7.2.0}
2 This chapter presents the new features that have been added to
3 the various versions of Bacula.
5 \section{New Features in 7.2.0}
7 \subsection{New Job Edit Codes \%E \%R}
8 In various places such as RunScripts, you have now access to \%E to get the
9 number of non-fatal errors for the current Job and \%R to get the number of
10 bytes read from disk or from the network during a job.
12 \subsection{Enable/Disable commands}
13 The \textbf{bconsole} \textbf{enable} and \textbf{disable} commands have
14 been extended from enabling/disabling Jobs to include Clients, Schedule,
15 and Storage devices. Examples:
18 disable Job=NightlyBackup Client=Windows-fd
21 will disable the Job named \textbf{NightlyBackup} as well as the
22 client named \textbf{Windows-fd}.
25 disable Storage=LTO-changer Drive=1
28 will disable the first drive in the autochanger named \textbf{LTO-changer}.
30 Please note that doing a \textbf{reload} command will set any values
31 changed by the enable/disable commands back to the values in the
34 The Client and Schedule resources in the bacula-dir.conf file now permit
35 the directive Enable = yes or Enable = no.
40 \subsection{Snapshot Management}
42 Bacula 7.2 is now able to handle Snapshots on Linux/Unix
43 systems. Snapshots can be automatically created and used to backup files. It is
44 also possible to manage Snapshots from Bacula's \texttt{bconsole} tool through a
47 \subsubsection{Application Quiescing}
49 When using Snapshots, it is very important to quiesce applications that are
50 running on the system. The simplest way to quiesce an application is to stop
51 it. Usually, taking the Snapshot is very fast, and the downtime is only about a
52 couple of seconds. If downtime is not possible and/or the application provides
53 a way to quiesce, a more advanced script can be used. An example is
54 described on \vref{SnapRunScriptExample}.
56 \subsubsection{New Director Directives}
58 The use of the Snapshot Engine on the FileDaemon is determined by the
59 new \textbf{Enable Snapshot} FileSet directive. The default is \textbf{no}.
68 Options = { Compression = LZO }
74 By default, Snapshots are deleted from the Client at the end of the backup. To
75 keep Snapshots on the Client and record them in the Catalog for a determined
76 period, it is possible to use the \textbf{Snapshot Retention} directive in the
77 Client or in the Job resource. The default value is 0 secconds. If, for a given Job,
78 both Client and Job \textbf{Snapshot Retention} directives are set, the Job
79 directive will be used.
86 Snapshot Retention = 5 days
90 To automatically prune Snapshots, it is possible to use the following RunScript
100 Console = "prune snapshot client=%c yes"
111 In RunScripts, the \texttt{AfterSnapshot} keyword for the \texttt{RunsWhen} directive will
112 allow a command to be run just after the Snapshot creation. \texttt{AfterSnapshot} is a
113 synonym for the \texttt{AfterVSS} keyword.
115 \label{SnapRunScriptExample}
120 Command = "/etc/init.d/mysql start"
121 RunsWhen = AfterSnapshot
125 Command = "/etc/init.d/mysql stop"
132 \subsubsection{Job Output Information}
134 Information about Snapshots are displayed in the Job output. The list of all
135 devices used by the Snapshot Engine is displayed, and the Job summary
136 indicates if Snapshots were available.
139 JobId 3: Create Snapshot of /home/build
140 JobId 3: Create Snapshot of /home/build/subvol
141 JobId 3: Delete snapshot of /home/build
142 JobId 3: Delete snapshot of /home/build/subvol
144 JobId 3: Bacula 127.0.0.1-dir 7.2.0 (23Jul15):
145 Build OS: x86_64-unknown-linux-gnu archlinux
147 Job: Incremental.2015-02-24_11.20.27_08
152 Termination: Backup OK
156 \subsubsection{New ``snapshot'' Bconsole Commands}
158 The new \textbf{snapshot} command will display by default the following menu:
162 1: List snapshots in Catalog
163 2: List snapshots on Client
166 5: Update snapshot parameters
167 6: Update catalog with Client snapshots
169 Select action to perform on Snapshot Engine (1-7):
172 The \textbf{snapshot} command can also have the following parameters:
174 [client=<client-name> | job=<job-name> | jobid=<jobid>]
175 [delete | list | listclient | prune | sync | update]
178 It is also possible to use traditional \texttt{list}, \texttt{llist},
179 \texttt{update}, \texttt{prune} or \texttt{delete} commands on Snapshots.
182 *llist snapshot jobid=5
184 name: NightlySave.2015-02-24_12.01.00_04
185 createdate: 2015-02-24 12:01:03
189 volume: /home/.snapshots/NightlySave.2015-02-24_12.01.00_04
197 * snapshot listclient
198 Automatically selected Client: 127.0.0.1-fd
199 Connecting to Client 127.0.0.1-fd at 127.0.0.1:8102
200 Snapshot NightlySave.2015-02-24_12.01.00_04:
201 Volume: /home/.snapshots/NightlySave.2015-02-24_12.01.00_04
203 CreateDate: 2015-02-24 12:01:03
211 With the \textsl{Update catalog with Client snapshots} option (or
212 \textbf{snapshot sync}), the Director contacts the FileDaemon, lists snapshots
213 of the system and creates catalog records of the Snapshots.
217 Automatically selected Client: 127.0.0.1-fd
218 Connecting to Client 127.0.0.1-fd at 127.0.0.1:8102
219 Snapshot NightlySave.2015-02-24_12.35.47_06:
220 Volume: /home/.snapshots/NightlySave.2015-02-24_12.35.47_06
222 CreateDate: 2015-02-24 12:35:47
226 Snapshot added in Catalog
230 name: NightlySave.2015-02-24_12.35.47_06
231 createdate: 2015-02-24 12:35:47
235 volume: /home/.snapshots/NightlySave.2015-02-24_12.35.47_06
249 \subsubsection{LVM Backend Restrictions}
252 LVM Snapshots are quite primitive compared to ZFS, BTRFS, NetApp and other
253 systems. For example, it is not possible to use Snapshots if the Volume Group
254 (VG) is full. The administrator must keep some free space in the VG
255 to create Snapshots. The amount of free space required depends on the activity of the
256 Logical Volume (LV). \textbf{bsnapshot} uses 10\% of the LV by
257 default. This number can be configured per LV in the
258 \textbf{bsnapshot.conf} file.
261 [root@system1]# vgdisplay
270 Alloc PE / Size 125 / 500,00 MiB
271 Free PE / Size 7507 / 29,32 GiB
275 It is also not advisable to leave snapshots on the LVM backend. Having multiple
276 snapshots of the same LV on LVM will slow down the system.
278 \subsubsection{Debug Options}
280 To get low level information about the Snapshot Engine, the debug tag ``snapshot''
281 should be used in the \textbf{setdebug} command.
284 * setdebug level=10 tags=snapshot client
285 * setdebug level=10 tags=snapshot dir
288 \subsection{Minor Enhancements}
289 \subsubsection{Storage Daemon Reports Disk Usage}
291 The \texttt{status storage} command now reports the space available on disk devices:
296 Device file: "FileStorage" (/bacula/arch1) is not open.
297 Available Space=5.762 GB
300 Device file: "FileStorage1" (/bacula/arch2) is not open.
301 Available Space=5.862 GB
304 \subsection{Data Encryption Cipher Configuration}
305 Bacula Enterprise version 8.0 and later now allows configuration of the data
306 encryption cipher and the digest algorithm. Previously, the cipher was forced to AES 128,
307 but it is now possible to choose between the following ciphers:
310 \item AES128 (default)
316 The digest algorithm was set to SHA1 or SHA256 depending on the local OpenSSL
317 options. We advise you to not modify the PkiDigest default setting. Please,
318 refer to the OpenSSL documentation to understand the pros and cons regarding these options.
327 \subsubsection*{New Option Letter ``M'' for Accurate Directive in FileSet}
329 % waa - 20150317 - is 8.0.5 correct here?
330 Added in version 8.0.5, the new ``M'' option letter for the Accurate directive
331 in the FileSet Options block, which allows comparing the modification time and/or
332 creation time against the last backup timestamp. This is in contrast to the
333 existing options letters ``m'' and/or ``c'', mtime and ctime, which are checked
334 against the stored catalog values, which can vary accross different machines
335 when using the BaseJob feature.
337 The advantage of the new ``M'' option letter for Jobs that refer to BaseJobs is
338 that it will instruct Bacula to backup files based on the last backup time, which
339 is more useful because the mtime/ctime timestamps may differ on various Clients,
340 causing files to be needlessly backed up.
373 Accurate = Ms # check for mtime/ctime of last backup timestamp and Size
382 \subsubsection*{New Debug Options}
384 In Bacula Enterprise version 8.0 and later, we introduced a new \texttt{options} parameter for
385 the \texttt{setdebug} bconsole command.
389 The following arguments to the new \texttt{option} parameter are available to control debug functions.
392 \item [0] Clear debug flags
393 \item [i] Turn off, ignore bwrite() errors on restore on File Daemon
394 \item [d] Turn off decomp of BackupRead() streams on File Daemon
395 \item [t] Turn on timestamps in traces
396 \item [T] Turn off timestamps in traces
398 % waa - 20150306 - does this "c" item mean to say "Truncate trace file if one exists, otherwise append to it" ???
399 \item [c] Truncate trace file if trace file is activated
401 \item [l] Turn on recoding events on P() and V()
402 \item [p] Turn on the display of the event ring when doing a bactrace
407 The following command will enable debugging for the File Daemon, truncate an existing trace file,
408 and turn on timestamps when writing to the trace file.
411 * setdebug level=10 trace=1 options=ct fd
416 It is now possible to use a \textsl{class} of debug messages called \texttt{tags}
417 to control the debug output of Bacula daemons.
420 \item [all] Display all debug messages
421 \item [bvfs] Display BVFS debug messages
422 \item [sql] Display SQL related debug messages
423 \item [memory] Display memory and poolmem allocation messages
424 \item [scheduler] Display scheduler related debug messages
428 * setdebug level=10 tags=bvfs,sql,memory
429 * setdebug level=10 tags=!bvfs
431 # bacula-dir -t -d 200,bvfs,sql
434 The \texttt{tags} option is composed of a list of tags. Tags are separated by
435 ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
436 in front of the tag. Note that more tags are planned for future versions.
438 %%\LTXtable{\linewidth}{table_debugtags}
440 \subsection{Read Only Storage Devices}
441 This version of Bacula allows you to define a Storage deamon device
442 to be read-only. If the {\bf Read Only} directive is specified and
443 enabled, the drive can only be used for read operations.
444 The {\bf Read Only} directive can be defined in any bacula-sd.conf
445 Device resource, and is most useful for reserving one or more
446 drives for restores. An example is:
452 \subsection{Catalog Performance Improvements}
453 There is a new Bacula database format (schema) in this version
454 of Bacula that eliminates the FileName table by placing the
455 Filename into the File record of the File table.
456 This substantiallly improves performance,
457 particularly for large (1GB or greater) databases.
459 % waa - 20150317 - Is 1GB _really_ considered to be a large database? Do we mean to say 100GB??
461 The \texttt{update\_xxx\_catalog} script will automatically update the
462 Bacula database format, but you should realize that for
463 very large databases (greater than 1GB), it may take some
464 time, and there are several different options for doing the
465 update: 1. Shudown the database and update it. 2. Update the
466 database while production jobs are running. See the Bacula Systems
467 White Paper ``Migration-to-6.6'' on this subject.
470 This database format change can provide very significant improvements in
471 the speed of metadata insertion into the database, and in some cases
472 (backup of large email servers) can significantly reduce the size of the
475 \subsection{New Truncate Command}
476 We have added a new truncate command to bconsole which
477 will truncate a volume if the volume is purged, and if
478 the volume is also marked {\bf Action On Purge = Truncate}.
479 This feature was originally added in Bacula version 5.0.1,
480 but the mechanism for actually doing the truncate required
481 the user to enter a complicated command such as:
484 purge volume action=truncate storage=File pool=Default
487 The above command is now simplified to be:
490 truncate storage=File pool=Default
493 \subsection{New Resume Command}
494 The new \texttt{resume} command does exactly the same thing as a
495 {\bf restart} command, but for some users the
496 name may be more logical because in general the
497 {\bf restart} command is used to resume running
498 a Job that was incomplete.
500 \subsection{New Prune ``Expired'' Volume Command}
501 In Bacula Enterprise 6.4, it is now possible to prune all volumes
502 (from a pool, or globally) that are ``expired''. This option can be
503 scheduled after or before the backup of the catalog and can be
504 combined with the \texttt{Truncate On Purge} option. The \texttt{prune expired volme} command may
505 be used instead of the \texttt{manual\_prune.pl} script.
508 * prune expired volume
510 * prune expired volume pool=FullPool
513 To schedule this option automatically, it can be added to the Catalog backup job
521 Console = "prune expired volume yes"
528 \subsection{New Job Edit Codes \%P \%C}
529 In various places such as RunScripts, you have now access to \%P to get the
530 current Bacula process ID (PID) and \%C to know if the current job is a
533 \subsection{Enhanced Status and Error Messages}
534 We have enhanced the Storage daemon status output to be more
535 readable. This is important when there are a large number of
536 devices. In addition to formatting changes, it also includes more
537 details on which devices are reading and writing.
539 A number of error messages have been enhanced to have more specific
540 data on what went wrong.
542 If a file changes size while being backed up the old and new size
545 \subsection{Miscellaneous New Features}
547 \item Allow unlimited line lengths in .conf files (previously limited
550 \item Allow /dev/null in ChangerCommand to indicated a Virtual Autochanger.
552 \item Add a --fileprune option to the manual\_prune.pl script.
554 \item Add a -m option to make\_catalog\_backup.pl to do maintenance
557 \item Safer code that cleans up the working directory when starting
558 the daemons. It limits what files can be deleted, hence enhances
561 \item Added a new .ls command in bconsole to permit browsing a client's
564 \item Fixed a number of bugs, includes some obscure seg faults, and a
565 race condition that occurred infrequently when running Copy, Migration,
566 or Virtual Full backups.
568 \item Upgraded to a newer version of Qt4 for bat. All indications
569 are that this will improve bat's stability on Windows machines.
571 \item The Windows installers now detect and refuse to install on
572 an OS that does not match the 32/64 bit value of the installer.
575 \subsection{FD Storage Address}
577 When the Director is behind a NAT, in a WAN area, to connect to
579 the StorageDaemon, the Director uses an ``external'' ip address,
580 and the FileDaemon should use an ``internal'' IP address to contact the
583 The normal way to handle this situation is to use a canonical name such as
584 ``storage-server'' that will be resolved on the Director side as the WAN
585 address and on the Client side as the LAN address. This is now possible to
586 configure this parameter using the new directive \texttt{FDStorageAddress} in
587 the Storage or Client resource.
590 %%\bsysimageH{BackupOverWan1}{Backup Over WAN}{figbs6:fdstorageaddress}
591 % \label{fig:fdstorageaddress}
597 FD Storage Address = 10.0.0.1
603 % # or in the Client resouce
610 FD Storage Address = 10.0.0.1
616 Note that using the Client \texttt{FDStorageAddress} directive will not allow
617 to use multiple Storage Daemon, all Backup or Restore requests will be sent to
618 the specified \texttt{FDStorageAddress}.
620 \subsection{Maximum Concurrent Read Jobs}
621 This is a new directive that can be used in the {\bf bacula-dir.conf} file
622 in the Storage resource. The main purpose is to limit the number
623 of concurrent Copy, Migration, and VirtualFull jobs so that
624 they don't monopolize all the Storage drives causing a deadlock situation
625 where all the drives are allocated for reading but none remain for
626 writing. This deadlock situation can occur when running multiple
627 simultaneous Copy, Migration, and VirtualFull jobs.
630 The default value is set to 0 (zero), which means there is no
631 limit on the number of read jobs. Note, limiting the read jobs
632 does not apply to Restore jobs, which are normally started by
633 hand. A reasonable value for this directive is one half the number
634 of drives that the Storage resource has rounded down. Doing so,
635 will leave the same number of drives for writing and will generally
636 avoid over committing drives and a deadlock.
638 \subsection{Incomplete Jobs}
639 During a backup, if the Storage daemon experiences disconnection
640 with the File daemon during backup (normally a comm line problem
641 or possibly an FD failure), under conditions that the SD determines
642 to be safe it will make the failed job as Incomplete rather than
643 failed. This is done only if there is sufficient valid backup
644 data that was written to the Volume. The advantage of an Incomplete
645 job is that it can be restarted by the new bconsole {\bf restart}
646 command from the point where it left off rather than from the
647 beginning of the jobs as is the case with a cancel.
649 \subsection{The Stop Command}
650 Bacula has been enhanced to provide a {\bf stop} command,
651 very similar to the {\bf cancel} command with the main difference
652 that the Job that is stopped is marked as Incomplete so that
653 it can be restarted later by the {\bf restart} command where
654 it left off (see below). The {\bf stop} command with no
655 arguments, will like the cancel command, prompt you with the
656 list of running jobs allowing you to select one, which might
657 look like the following:
662 1: JobId=3 Job=Incremental.2012-03-26_12.04.26_07
663 2: JobId=4 Job=Incremental.2012-03-26_12.04.30_08
664 3: JobId=5 Job=Incremental.2012-03-26_12.04.36_09
665 Choose Job to stop (1-3): 2
666 2001 Job "Incremental.2012-03-26_12.04.30_08" marked to be stopped.
667 3000 JobId=4 Job="Incremental.2012-03-26_12.04.30_08" marked to be stopped.
670 \subsection{The Restart Command}
671 The new {\bf Restart command} allows console users to restart
672 a canceled, failed, or incomplete Job. For canceled and failed
673 Jobs, the Job will restart from the beginning. For incomplete
674 Jobs the Job will restart at the point that it was stopped either
675 by a stop command or by some recoverable failure.
678 If you enter the {\bf restart} command in bconsole, you will get the
683 You have the following choices:
688 Select termination code: (1-4):
691 If you select the {\bf All} option, you may see something like:
694 Select termination code: (1-4): 4
695 +-------+-------------+---------------------+------+-------+----------+-----------+-----------+
696 | jobid | name | starttime | type | level | jobfiles |
697 jobbytes | jobstatus |
698 +-------+-------------+---------------------+------+-------+----------+-----------+-----------+
699 | 1 | Incremental | 2012-03-26 12:15:21 | B | F | 0 |
701 | 2 | Incremental | 2012-03-26 12:18:14 | B | F | 350 |
703 | 3 | Incremental | 2012-03-26 12:18:30 | B | F | 0 |
705 | 4 | Incremental | 2012-03-26 12:18:38 | B | F | 331 |
707 +-------+-------------+---------------------+------+-------+----------+-----------+-----------+
708 Enter the JobId list to select:
711 Then you may enter one or more JobIds to be restarted, which may
712 take the form of a list of JobIds separated by commas, and/or JobId
713 ranges such as {\bf 1-4}, which indicates you want to restart JobIds
714 1 through 4, inclusive.
716 \subsection{Job Bandwidth Limitation}
718 The new {\bf Job Bandwidth Limitation} directive may be added to the File
719 daemon's and/or Director's configuration to limit the bandwidth used by a
720 Job on a Client. It can be set in the File daemon's conf file for all Jobs
721 run in that File daemon, or it can be set for each Job in the Director's
722 conf file. The speed is always specified in bytes per second.
728 Working Directory = /some/path
729 Pid Directory = /some/path
731 Maximum Bandwidth Per Job = 5Mb/s
735 The above example would cause any jobs running with the FileDaemon to not
736 exceed 5 megabytes per second of throughput when sending data to the
737 Storage Daemon. Note, the speed is always specified in bytes per second
738 (not in bits per second), and the case (upper/lower) of the specification
739 characters is ignored (i.e. 1MB/s = 1Mb/s).
741 You may specify the following speed parameter modifiers:
742 k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
743 m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).
749 FileSet = FS_localhost
752 Maximum Bandwidth = 5Mb/s
757 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
758 of throughput when sending data from the File daemon to the Storage daemon.
760 A new console command \texttt{setbandwidth} permits to set dynamically the
761 maximum throughput of a running Job or for future jobs of a Client.
764 * setbandwidth limit=1000 jobid=10
767 Please note that the value specified for the \texttt{limit} command
768 line parameter is always in units of 1024 bytes (i.e. the number
769 is multiplied by 1024 to give the number of bytes per second). As
770 a consequence, the above limit of 1000 will be interpreted as a
771 limit of 1000 * 1024 = 1,024,000 bytes per second.
773 \subsection{Always Backup a File}
775 When the Accurate mode is turned on, you can decide to always backup a file
776 by using then new {\bf A} Accurate option in your FileSet. For example:
799 This project was funded by Bacula Systems based on an idea of James Harper and
800 is available with the Bacula Enterprise Edition.
802 \subsection{Setting Accurate Mode at Runtime}
804 You are now able to specify the Accurate mode on the \texttt{run} command and
805 in the Schedule resource.
808 * run accurate=yes job=Test
814 Run = Full 1st sun at 23:05
815 Run = Differential accurate=yes 2nd-5th sun at 23:05
816 Run = Incremental accurate=no mon-sat at 23:05
820 It can allow you to save memory and and CPU resources on the catalog server in
824 These advanced tuning options are available with the Bacula Enterprise Edition.
826 % Common with community
827 \subsection{Additions to RunScript variables}
828 You can have access to JobBytes, JobFiles and Director name using \%b, \%F and \%D
829 in your runscript command. The Client address is now available through \%h.
832 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h Dir=%D"
835 \subsection{LZO Compression}
837 LZO compression was added in the Unix File Daemon. From the user point of view,
838 it works like the GZIP compression (just replace {\bf compression=GZIP} with
839 {\bf compression=LZO}).
844 Options { compression=LZO }
850 LZO provides much faster compression and decompression speed but lower
851 compression ratio than GZIP. It is a good option when you backup to disk. For
852 tape, the built-in compression may be a better option.
854 LZO is a good alternative for GZIP1 when you don't want to slow down your
855 backup. On a modern CPU it should be able to run almost as fast as:
858 \item your client can read data from disk. Unless you have very fast disks like
859 SSD or large/fast RAID array.
860 \item the data transfers between the file daemon and the storage daemon even on
864 Note that bacula only use one compression level LZO1X-1.
867 The code for this feature was contributed by Laurent Papier.
869 \subsection{Purge Migration Job}
871 The new {\bf Purge Migration Job} directive may be added to the Migration
872 Job definition in the Director's configuration file. When it is enabled
873 the Job that was migrated during a migration will be purged at
874 the end of the migration job.
882 Client = localhost-fd
885 Storage = DiskChanger
888 Selection Pattern = ".*Save"
890 Purge Migration Job = yes
896 This project was submitted by Dunlap Blake; testing and documentation was funded
899 \subsection{Changes in the Pruning Algorithm}
901 We rewrote the job pruning algorithm in this version. Previously, in some users
902 reported that the pruning process at the end of jobs was very long. It should
903 not be longer the case. Now, Bacula won't prune automatically a Job if this
904 particular Job is needed to restore data. Example:
908 JobId: 2 Level: Incremental
909 JobId: 3 Level: Incremental
910 JobId: 4 Level: Differential
911 .. Other incrementals up to now
914 In this example, if the Job Retention defined in the Pool or in the Client
915 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
916 detect that JobId 1 and 4 are essential to restore data at the current state
917 and will prune only JobId 2 and 3.
919 \texttt{Important}, this change affect only the automatic pruning step after a
920 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
921 \texttt{VolumeRetention} period, important jobs can be pruned.
923 \subsection{Ability to Verify any specified Job}
924 You now have the ability to tell Bacula which Job should verify instead of
925 automatically verify just the last one.
927 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
929 To verify a given job, just specify the Job jobid in argument when starting the
932 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
934 JobName: VerifyVolume
935 Level: VolumeToCatalog
938 Pool: Default (From Job resource)
939 Storage: File (From Job resource)
940 Verify Job: VerifyVol.2010-09-08_14.17.17_03
941 Verify List: /tmp/regress/working/VerifyVol.bsr
942 When: 2010-09-08 14:17:31
944 OK to run? (yes/mod/no):
949 \chapter{New Features in 7.0.0}
950 This chapter presents the new features that have been added to
951 the various versions of Bacula.
953 \section{New Features in 7.0.0}
955 \subsection{Storage daemon to Storage daemon}
956 Bacula version 7.0 permits SD to SD transfer of Copy and Migration
957 Jobs. This permits what is commonly referred to as replication or
958 off-site transfer of Bacula backups. It occurs automatically, if
959 the source SD and destination SD of a Copy or Migration job are
960 different. The following picture shows how this works.
962 \includegraphics[width=0.8\linewidth]{sd-to-sd}
964 \subsection{SD Calls Client}
965 If the {\bf SD Calls Client} directive is set to true in a Client resource
966 any Backup, Restore, Verify, Copy, or Migration Job where the client
967 is involved, the client will wait for the Storage daemon to contact it.
968 By default this directive is set to false, and the Client will call
969 the Storage daemon. This directive can be useful if your Storage daemon
970 is behind a firewall that permits outgoing connections but not incoming
971 one. The following picture shows the communications connection paths in
974 \includegraphics[width=0.8\linewidth]{sd-calls-client}
976 \subsection{Next Pool}
977 In previous versions of Bacula the Next Pool directive could be
978 specified in the Pool resource for use with Migration and Copy Jobs.
979 The Next Pool concept has been
980 extended in Bacula version 7.0.0 to allow you to specify the
981 Next Pool directive in the Job resource as well. If specified in
982 the Job resource, it will override any value specified in the Pool
985 In addition to being permitted in the Job resource, the
986 {\bf nextpool=xxx} specification can be specified as a run
987 override in the {\bf run} directive of a Schedule resource.
988 Any {\bf nextpool} specification in a {\bf run}
989 directive will override any other specification in either
992 In general, more information is displayed in the Job log
993 on exactly which Next Pool specification is ultimately used.
995 \subsection{status storage}
996 The bconsole {\bf status storage} has been modified to attempt to eliminate
997 duplicate storage resources and only show one that references any given
998 storage daemon. This might be confusing at first, but tends to make a
999 much more compact list of storage resource from which to select if there
1000 are multiple storage devices in the same storage daemon.
1002 If you want the old behavior (always display all storage resources) simply
1003 add the keyword {\bf select} to the command -- i.e. use
1004 {\bf status select storage}.
1010 \subsection{status schedule}
1011 A new status command option called {\bf scheduled} has been implemented
1012 in bconsole. By default it will display 20 lines of the next scheduled
1013 jobs. For example, with the default bacula-dir.conf configuration file,
1014 a bconsole command {\bf status scheduled} produces:
1018 Level Type Pri Scheduled Job Name Schedule
1019 ======================================================================
1020 Differential Backup 10 Sun 30-Mar 23:05 BackupClient1 WeeklyCycle
1021 Incremental Backup 10 Mon 24-Mar 23:05 BackupClient1 WeeklyCycle
1022 Incremental Backup 10 Tue 25-Mar 23:05 BackupClient1 WeeklyCycle
1024 Full Backup 11 Mon 24-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
1025 Full Backup 11 Wed 26-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
1030 Note, the output is listed by the Jobs found, and is not sorted
1034 This command has a number of options, most of which act as filters:
1036 \item {\bf days=nn} This specifies the number of days to list. The default is
1037 10 but can be set from 0 to 500.
1038 \item {\bf limit=nn} This specifies the limit to the number of lines to print.
1039 The default is 100 but can be any number in the range 0 to 2000.
1040 \item {\bf time="YYYY-MM-DD HH:MM:SS"} Sets the start time for listing the
1041 scheduled jobs. The default is to use the current time. Note, the
1042 time value must be specified inside double quotes and must be in
1043 the exact form shown above.
1044 \item {\bf schedule=schedule-name} This option restricts the output to
1046 \item {\bf job=job-name} This option restricts the output to the specified
1050 \subsection{Data Encryption Cipher Configuration}
1051 Bacula version 7.0 and later now allows to configure the data
1052 encryption cipher and the digest algorithm. The cipher was forced to AES
1053 128, and it is now possible to choose between the following ciphers:
1056 \item AES128 (default)
1062 The digest algorithm was set to SHA1 or SHA256 depending on the local
1064 options. We advise you to not modify the PkiDigest default setting. Please,
1065 refer to OpenSSL documentation to know about pro and cons on these options.
1074 \subsection{New Truncate Command}
1075 We have added a new truncate command to bconsole, which
1076 will truncate a Volume if the Volume is purged and if
1077 the Volume is also marked {\bf Action On Purge = Truncate}.
1078 This feature was originally added in Bacula version 5.0.1,
1079 but the mechanism for actually doing the truncate required
1080 the user to enter a command such as:
1083 purge volume action=truncate storage=File pool=Default
1086 The above command is now simplified to be:
1089 truncate storage=File pool=Default
1092 \subsection{Migration/Copy/VirtualFull Performance Enhancements}
1093 The Bacula Storage daemon now permits multiple jobs to simultaneously read
1094 the same disk Volume, which gives substantial performance enhancements when
1095 running Migration, Copy, or VirtualFull jobs that read disk Volumes. Our
1096 testing shows that when running multiple simultaneous jobs, the jobs can
1097 finish up to ten times faster with this version of Bacula. This is
1098 built-in to the Storage daemon, so it happens automatically and
1101 \subsection{VirtualFull Backup Consolidation Enhancements}
1102 By default Bacula selects jobs automatically for a VirtualFull,
1103 however, you may want to create the Virtual backup based on a
1104 particular backup (point in time) that exists.
1106 For example, if you have the following backup Jobs in your catalog:
1108 +-------+---------+-------+----------+----------+-----------+
1109 | JobId | Name | Level | JobFiles | JobBytes | JobStatus |
1110 +-------+---------+-------+----------+----------+-----------+
1111 | 1 | Vbackup | F | 1754 | 50118554 | T |
1112 | 2 | Vbackup | I | 1 | 4 | T |
1113 | 3 | Vbackup | I | 1 | 4 | T |
1114 | 4 | Vbackup | D | 2 | 8 | T |
1115 | 5 | Vbackup | I | 1 | 6 | T |
1116 | 6 | Vbackup | I | 10 | 60 | T |
1117 | 7 | Vbackup | I | 11 | 65 | T |
1118 | 8 | Save | F | 1758 | 50118564 | T |
1119 +-------+---------+-------+----------+----------+-----------+
1122 and you want to consolidate only the first 3 jobs and create a
1123 virtual backup equivalent to Job 1 + Job 2 + Job 3, you will use
1124 \texttt{jobid=3} in the \texttt{run} command, then Bacula will select the
1125 previous Full backup, the previous Differential (if any) and all subsequent
1129 run job=Vbackup jobid=3 level=VirtualFull
1132 If you want to consolidate a specific job list, you must specify the exact
1133 list of jobs to merge in the run command line. For example, to consolidate
1134 the last Differential and all subsequent Incremental, you will use
1135 \texttt{jobid=4,5,6,7} or \texttt{jobid=4-7} on the run command line. As one
1136 of the Job in the list is a Differential backup, Bacula will set the new job
1137 level to Differential. If the list is composed only with Incremental jobs,
1138 the new job will have a level set to Incremental.
1141 run job=Vbackup jobid=4-7 level=VirtualFull
1144 When using this feature, Bacula will automatically discard jobs that are
1145 not related to the current Job. For example, specifying
1146 \texttt{jobid=7,8}, Bacula will discard JobId 8 because it is not
1147 part of the same backup Job.
1149 We do not recommend it, but really want to consolidate jobs that have
1150 different names (so probably different clients, filesets, etc...), you must
1151 use \texttt{alljobid=} keyword instead of \texttt{jobid=}.
1154 run job=Vbackup alljobid=1-3,6-8 level=VirtualFull
1158 \subsection{FD Storage Address}
1160 When the Director is behind a NAT, in a WAN area, to connect to
1162 the StorageDaemon, the Director uses an ``external'' ip address,
1163 and the FileDaemon should use an ``internal'' IP address to contact the
1166 The normal way to handle this situation is to use a canonical name such as
1167 ``storage-server'' that will be resolved on the Director side as the WAN
1168 address and on the Client side as the LAN address. This is now possible to
1169 configure this parameter using the new directive \texttt{FDStorageAddress} in
1170 the Storage or Client resource.
1173 \includegraphics[width=0.8\linewidth]{BackupOverWan1}
1174 \label{fig:fdstorageaddress}
1180 FD Storage Address = 10.0.0.1
1186 % # or in the Client resouce
1193 FD Storage Address = 10.0.0.1
1199 Note that using the Client \texttt{FDStorageAddress} directive will not allow
1200 to use multiple Storage Daemon, all Backup or Restore requests will be sent to
1201 the specified \texttt{FDStorageAddress}.
1203 \subsection{Job Bandwidth Limitation}
1205 The new {\bf Job Bandwidth Limitation} directive may be added to the File
1206 daemon's and/or Director's configuration to limit the bandwidth used by a
1207 Job on a Client. It can be set in the File daemon's conf file for all Jobs
1208 run in that File daemon, or it can be set for each Job in the Director's
1209 conf file. The speed is always specified in bytes per second.
1215 Working Directory = /some/path
1216 Pid Directory = /some/path
1218 Maximum Bandwidth Per Job = 5Mb/s
1222 The above example would cause any jobs running with the FileDaemon to not
1223 exceed 5 megabytes per second of throughput when sending data to the
1224 Storage Daemon. Note, the speed is always specified in bytes per second
1225 (not in bits per second), and the case (upper/lower) of the specification
1226 characters is ignored (i.e. 1MB/s = 1Mb/s).
1228 You may specify the following speed parameter modifiers:
1229 k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
1230 m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).
1235 Name = locahost-data
1236 FileSet = FS_localhost
1239 Maximum Bandwidth = 5Mb/s
1244 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
1245 of throughput when sending data from the File daemon to the Storage daemon.
1247 A new console command \texttt{setbandwidth} permits to set dynamically the
1248 maximum throughput of a running Job or for future jobs of a Client.
1251 * setbandwidth limit=1000 jobid=10
1254 Please note that the value specified for the \texttt{limit} command
1255 line parameter is always in units of 1024 bytes (i.e. the number
1256 is multiplied by 1024 to give the number of bytes per second). As
1257 a consequence, the above limit of 1000 will be interpreted as a
1258 limit of 1000 * 1024 = 1,024,000 bytes per second.
1261 This project was funded by Bacula Systems.
1264 \subsection{Maximum Concurrent Read Jobs}
1265 This is a new directive that can be used in the {\bf bacula-dir.conf} file
1266 in the Storage resource. The main purpose is to limit the number
1267 of concurrent Copy, Migration, and VirtualFull jobs so that
1268 they don't monopolize all the Storage drives causing a deadlock situation
1269 where all the drives are allocated for reading but none remain for
1270 writing. This deadlock situation can occur when running multiple
1271 simultaneous Copy, Migration, and VirtualFull jobs.
1274 The default value is set to 0 (zero), which means there is no
1275 limit on the number of read jobs. Note, limiting the read jobs
1276 does not apply to Restore jobs, which are normally started by
1277 hand. A reasonable value for this directive is one half the number
1278 of drives that the Storage resource has rounded down. Doing so,
1279 will leave the same number of drives for writing and will generally
1280 avoid over committing drives and a deadlock.
1283 \subsection{Director job Codes in Message Resource Commands}
1284 Before submitting the specified mail command to the operating system, Bacula
1285 performs character substitution like in Runscript commands. Bacula will now
1286 perform also specific Director character substitution.
1289 The code for this feature was contributed by Bastian Friedrich.
1291 \subsection{Additions to RunScript variables}
1292 The following variables are now available in runscripts:
1294 \item current PID using \%P
1295 \item if the job is a clone job using \%C
1299 RunAfterJob = "/bin/echo Pid=%P isCloned=%C"
1303 \subsection{Read Only Storage Devices}
1304 This version of Bacula permits defining a Storage daemon device
1305 to be read-only. That is if the {\bf ReadOnly} directive is specified and
1306 enabled, the drive can only be used for read operations.
1307 The the {\bf ReadOnly} directive can be defined in any bacula-sd.conf
1308 Device resource, and is most useful to reserve one or more
1309 drives for restores. An example is:
1315 \subsection{New Prune ``Expired'' Volume Command}
1316 It is now possible to prune all volumes
1317 (from a pool, or globally) that are ``expired''. This option can be
1318 scheduled after or before the backup of the Catalog and can be
1319 combined with the Truncate On Purge option. The Expired Prune option can
1320 be used instead of the \texttt{manual\_prune.pl} script.
1323 * prune expired volumes
1325 * prune expired volumes pool=FullPool
1328 To schedule this option automatically, it can be added to the BackupCatalog job
1333 Name = CatalogBackup
1336 Console = "prune expired volume yes"
1342 \subsection{Hardlink Performance Enhancements}
1343 If you use a program such as Cyrus IMAP that creates very large numbers
1344 of hardlinks, the time to build the interactive restore tree can be
1345 excessively long. This version of Bacula has a new feature that
1346 automatically keeps the hardlinks associated with the restore tree
1347 in memory, which consumes a bit more memory but vastly speeds up
1348 building the tree. If the memory usage is too big for your system, you
1349 can reduce the amount of memory used during the restore command by
1350 adding the option {\bf optimizespeed=false} on the bconsole run
1353 This feature was developed by Josip Almasi, and enhanced to be runtime
1354 dynamic by Kern Sibbald.
1356 \subsection{DisableCommand Directive}
1357 There is a new Directive named {\bf Disable Command} that
1358 can be put in the File daemon Client or Director resource.
1359 If it is in the Client, it applies globally, otherwise the
1360 directive applies only to the Director in which it is found.
1361 The Disable Command adds security to your File daemon by
1362 disabling certain commands. The commands that can be
1388 On or more of these command keywords can be placed in quotes and separated
1389 by spaces on the Disable Command directive line. Note: the commands must
1390 be written exactly as they appear above.
1392 \subsection{Multiple Console Directors}
1393 Support for multiple bconsole and bat Directors in the bconsole.conf and
1394 bat.conf files has been implemented and/or improved.
1396 \subsection{Restricted Consoles}
1397 Better support for Restricted consoles has been implement for bconsole and
1400 \subsection{Configuration Files}
1401 In previous versions of Bacula the configuration files for each component
1402 were limited to a maximum of 499 bytes per configuration file line. This
1403 version of Bacula permits unlimited input line lengths. This can be
1404 especially useful for specifying more complicated Migration/Copy SQL
1405 statements and in creating long restricted console ACL lists.
1407 \subsection{Maximum Spawned Jobs}
1408 The Job resource now permits specifying a number of {\bf Maximum Spawn
1409 Jobs}. The default is 300. This directive can be useful if you have
1410 big hardware and you do a lot of Migration/Copy jobs which start
1411 at the same time. In prior versions of Bacula, Migration/Copy
1412 was limited to spawning a maximum of 100 jobs at a time.
1414 \subsection{Progress Meter}
1415 The new File daemon has been enhanced to send its progress (files
1416 processed and bytes written) to the Director every 30 seconds. These
1417 figures can then be displayed with a bconsole {\bf status dir}
1420 \subsection{Scheduling a 6th Week}
1421 Prior version of Bacula permits specifying 1st through 5th week of
1422 a month (first through fifth) as a keyword on the {\bf run}
1423 directive of a Schedule resource. This version of Bacula also permits
1424 specifying the 6th week of a month with the keyword {\bf sixth} or
1427 \subsection{Scheduling the Last Day of a Month}
1428 This version of Bacula now permits specifying the {\bf lastday}
1429 keyword in the {\bf run} directive of a Schedule resource.
1430 If {\bf lastday} is specified, it will apply only to those months
1431 specified on the {\bf run} directive. Note: by default all months
1434 \subsection{Improvements to Cancel and Restart bconsole Commands}
1435 The Restart bconsole command now allow selection of either
1436 canceled or failed jobs to be restarted. In addition both the
1437 {\bf cancel} and {\bf restart} bconsole commands permit entering
1438 a number of JobIds separated by commas or a range of JobIds indicated
1439 by a dash between the begin and end range (e.g. 3-10). Finally the
1440 two commands also allow one to enter the special keyword {\bf all}
1441 to select all the appropriate Jobs.
1443 \subsection{bconsole Performance Improvements}
1444 In previous versions of Bacula certain bconsole commands could wait a long
1445 time due to catalog lock contention. This was especially noticeable
1446 when a large number of jobs were running and putting their attributes
1447 into the catalog. This version uses a separate catalog connection that
1448 should significantly enhance performance.
1450 \subsection{New .bvfs\_decode\_lstat Command}
1451 There is a new bconsole command, which is
1452 {\bf .bvfs\_decode\_lstat} it requires one argument, which
1453 is {\bf lstat="lstat value to decode"}. An example command
1454 in bconsole and the output might be:
1458 .bvfs_decode_lstat lstat="A A EHt B A A A JP BAA B BTL/A7 BTL/A7 BTL/A7 A A C"
1476 \subsection*{New Debug Options}
1478 In Bacula Enterprise version 8.0 and later, we introduced new options to
1479 the \texttt{setdebug} command.
1483 If the \texttt{options} parameter is set, the following arguments can be
1484 used to control debug functions.
1487 \item [0] clear debug flags
1488 \item [i] Turn off, ignore bwrite() errors on restore on File Daemon
1489 \item [d] Turn off decomp of BackupRead() streams on File Daemon
1490 \item [t] Turn on timestamp in traces
1491 \item [T] Turn off timestamp in traces
1492 \item [c] Truncate trace file if trace file is activated
1493 \item [l] Turn on recoding events on P() and V()
1494 \item [p] Turn on the display of the event ring when doing a bactrace
1499 The following command will truncate the trace file and will turn on timestamps
1503 * setdebug level=10 trace=1 options=ct fd
1508 It is now possible to use \textsl{class} of debug messages called \texttt{tags}
1509 to control the debug output of Bacula daemons.
1512 \item [all] Display all debug messages
1513 \item [bvfs] Display BVFS debug messages
1514 \item [sql] Display SQL related debug messages
1515 \item [memory] Display memory and poolmem allocation messages
1516 \item [scheduler] Display scheduler related debug messages
1520 * setdebug level=10 tags=bvfs,sql,memory
1521 * setdebug level=10 tags=!bvfs
1523 # bacula-dir -t -d 200,bvfs,sql
1526 The \texttt{tags} option is composed of a list of tags, tags are separated by
1527 ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
1528 in front of the tag. Note that more tags will come in future versions.
1530 %\LTXtable{\linewidth}{table_debugtags}
1533 \chapter{New Features in 5.2.13}
1534 This chapter presents the new features that have been added to the current
1535 Community version of Bacula that is now released.
1537 \subsection{Additions to RunScript variables}
1538 You can have access to Director name using \%D in your runscript
1542 RunAfterJob = "/bin/echo Director=%D
1545 \section{New Features in 5.2.1}
1546 This chapter presents the new features were added in the
1547 Community release version 5.2.1.
1549 There are additional features (plugins) available in the Enterprise version
1550 that are described in another chapter. A subscription to Bacula Systems
1551 is required for the Enterprise version.
1553 \subsection{LZO Compression}
1555 LZO compression has been to the File daemon. From the user's point of view,
1556 it works like the GZIP compression (just replace {\bf compression=GZIP} with
1557 {\bf compression=LZO}).
1562 Options {compression=LZO }
1568 LZO provides a much faster compression and decompression speed but lower
1569 compression ratio than GZIP. It is a good option when you backup to disk. For
1570 tape, the hardware compression is almost always a better option.
1572 LZO is a good alternative for GZIP1 when you don't want to slow down your
1573 backup. With a modern CPU it should be able to run almost as fast as:
1576 \item your client can read data from disk. Unless you have very fast disks like
1577 SSD or large/fast RAID array.
1578 \item the data transfers between the file daemon and the storage daemon even on
1582 Note, Bacula uses compression level LZO1X-1.
1585 The code for this feature was contributed by Laurent Papier.
1587 \subsection{New Tray Monitor}
1589 Since the old integrated Windows tray monitor doesn't work with
1590 recent Windows versions, we have written a new Qt Tray Monitor that is available
1591 for both Linux and Windows. In addition to all the previous features,
1592 this new version allows you to run Backups from
1593 the tray monitor menu.
1595 \begin{figure}[htbp]
1597 \includegraphics[width=0.8\linewidth]{tray-monitor}
1598 \label{fig:traymonitor}
1599 \caption{New tray monitor}
1602 \begin{figure}[htbp]
1604 \includegraphics[width=0.8\linewidth]{tray-monitor1}
1605 \label{fig:traymonitor1}
1606 \caption{Run a Job through the new tray monitor}
1610 To be able to run a job from the tray monitor, you need to
1611 allow specific commands in the Director monitor console:
1616 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
1617 ClientACL = *all* # you can restrict to a specific host
1629 This project was funded by Bacula Systems and is available with Bacula
1630 the Enterprise Edition and the Community Edition.
1632 \subsection{Purge Migration Job}
1634 The new {\bf Purge Migration Job} directive may be added to the Migration
1635 Job definition in the Director's configuration file. When it is enabled
1636 the Job that was migrated during a migration will be purged at
1637 the end of the migration job.
1642 Name = "migrate-job"
1645 Client = localhost-fd
1646 FileSet = "Full Set"
1648 Storage = DiskChanger
1650 Selection Type = Job
1651 Selection Pattern = ".*Save"
1653 Purge Migration Job = yes
1659 This project was submitted by Dunlap Blake; testing and documentation was funded
1662 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
1664 Bat has now a bRestore panel that uses Bvfs to display files and
1667 \begin{figure}[htbp]
1669 \includegraphics[width=0.8\linewidth]{bat-brestore}
1670 \label{fig:batbrestore}
1671 \caption{Bat Brestore Panel}
1674 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
1677 This project was funded by Bacula Systems.
1679 \subsubsection*{General notes}
1682 \item All fields are separated by a tab
1683 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
1684 records in very big directories
1685 \item All operations (except cache creation) are designed to run instantly
1686 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
1687 can contribute new faster SQL queries we will be happy, else don't complain
1689 \item The cache creation is dependent of the number of directories. As Bvfs
1690 shares information across jobs, the first creation can be slow
1691 \item All fields are separated by a tab
1692 \item Due to potential encoding problem, it's advised to always use pathid in
1696 \subsubsection*{Get dependent jobs from a given JobId}
1698 Bvfs allows you to query the catalog against any combination of jobs. You
1699 can combine all Jobs and all FileSet for a Client in a single session.
1701 To get all JobId needed to restore a particular job, you can use the
1702 \texttt{.bvfs\_get\_jobids} command.
1705 .bvfs_get_jobids jobid=num [all]
1709 .bvfs_get_jobids jobid=10
1711 .bvfs_get_jobids jobid=10 all
1715 In this example, a normal restore will need to use JobIds 1,2,5,10 to
1716 compute a complete restore of the system.
1718 With the \texttt{all} option, the Director will use all defined FileSet for
1721 \subsubsection*{Generating Bvfs cache}
1723 The \texttt{.bvfs\_update} command computes the directory cache for jobs
1724 specified in argument, or for all jobs if unspecified.
1727 .bvfs_update [jobid=numlist]
1732 .bvfs_update jobid=1,2,3
1735 You can run the cache update process in a RunScript after the catalog backup.
1737 \subsubsection*{Get all versions of a specific file}
1739 Bvfs allows you to find all versions of a specific file for a given Client with
1740 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
1741 function uses only PathId and FilenameId. The jobid argument is mandatory but
1745 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
1746 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
1747 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
1754 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
1755 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
1758 \subsubsection*{List directories}
1760 Bvfs allows you to list directories in a specific path.
1762 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
1763 PathId FilenameId FileId JobId LStat Path
1764 PathId FilenameId FileId JobId LStat Path
1765 PathId FilenameId FileId JobId LStat Path
1769 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
1770 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
1771 listed is a directory.
1774 .bvfs_lsdirs pathid=4 jobid=1,11,12
1775 4 0 0 0 A A A A A A A A A A A A A A .
1776 5 0 0 0 A A A A A A A A A A A A A A ..
1777 3 0 0 0 A A A A A A A A A A A A A A regress/
1780 In this example, to list directories present in \texttt{regress/}, you can use
1782 .bvfs_lsdirs pathid=3 jobid=1,11,12
1783 3 0 0 0 A A A A A A A A A A A A A A .
1784 4 0 0 0 A A A A A A A A A A A A A A ..
1785 2 0 0 0 A A A A A A A A A A A A A A tmp/
1788 \subsubsection*{List files}
1790 Bvfs allows you to list files in a specific path.
1792 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
1793 PathId FilenameId FileId JobId LStat Path
1794 PathId FilenameId FileId JobId LStat Path
1795 PathId FilenameId FileId JobId LStat Path
1799 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
1800 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
1804 .bvfs_lsfiles pathid=4 jobid=1,11,12
1805 4 0 0 0 A A A A A A A A A A A A A A .
1806 5 0 0 0 A A A A A A A A A A A A A A ..
1807 1 0 0 0 A A A A A A A A A A A A A A regress/
1810 In this example, to list files present in \texttt{regress/}, you can use
1812 .bvfs_lsfiles pathid=1 jobid=1,11,12
1813 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
1814 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
1815 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
1816 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
1817 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
1820 \subsubsection*{Restore set of files}
1822 Bvfs allows you to create a SQL table that contains files that you want to
1823 restore. This table can be provided to a restore command with the file option.
1826 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
1828 restore file=?b2num ...
1831 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
1832 select all files. This query could be time consuming.
1834 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
1835 fileindex). This information can be found in the LinkFI field of the LStat
1838 The \texttt{path} argument represents the name of the table that Bvfs will
1839 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
1840 b2 and followed by digits).
1845 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
1849 \subsubsection*{Cleanup after Restore}
1851 To drop the table used by the restore command, you can use the
1852 \texttt{.bvfs\_cleanup} command.
1855 .bvfs_cleanup path=b20001
1858 \subsubsection*{Clearing the BVFS Cache}
1860 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
1863 .bvfs_clear_cache yes
1867 \subsection{Changes in the Pruning Algorithm}
1869 We rewrote the job pruning algorithm in this version. Previously, in some users
1870 reported that the pruning process at the end of jobs was very long. It should
1871 not be longer the case. Now, Bacula won't prune automatically a Job if this
1872 particular Job is needed to restore data. Example:
1875 JobId: 1 Level: Full
1876 JobId: 2 Level: Incremental
1877 JobId: 3 Level: Incremental
1878 JobId: 4 Level: Differential
1879 .. Other incrementals up to now
1882 In this example, if the Job Retention defined in the Pool or in the Client
1883 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
1884 detect that JobId 1 and 4 are essential to restore data at the current state
1885 and will prune only JobId 2 and 3.
1887 \texttt{Important}, this change affect only the automatic pruning step after a
1888 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
1889 \texttt{VolumeRetention} period, important jobs can be pruned.
1891 \subsection{Ability to Verify any specified Job}
1892 You now have the ability to tell Bacula which Job should verify instead of
1893 automatically verify just the last one.
1895 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
1897 To verify a given job, just specify the Job jobid in argument when starting the
1900 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
1902 JobName: VerifyVolume
1903 Level: VolumeToCatalog
1904 Client: 127.0.0.1-fd
1906 Pool: Default (From Job resource)
1907 Storage: File (From Job resource)
1908 Verify Job: VerifyVol.2010-09-08_14.17.17_03
1909 Verify List: /tmp/regress/working/VerifyVol.bsr
1910 When: 2010-09-08 14:17:31
1912 OK to run? (yes/mod/no):
1916 This project was funded by Bacula Systems and is available with Bacula
1917 Enterprise Edition and Community Edition.
1919 \subsection{Additions to RunScript variables}
1920 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
1921 command. The Client address is now available through \%h.
1924 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
1927 %\subsection{Changes in drivetype.exe}
1929 %Now the \texttt{drivetype.exe} program allows you to list all local hard
1930 %drives. It can help to build dynamic FileSet on Windows.
1933 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
1937 \subsection{Additions to the Plugin API}
1938 The bfuncs structure has been extended to include a number of
1941 \subsubsection{bfuncs}
1942 The bFuncs structure defines the callback entry points within Bacula
1943 that the plugin can use register events, get Bacula values, set
1944 Bacula values, and send messages to the Job output or debug output.
1946 The exact definition as of this writing is:
1948 typedef struct s_baculaFuncs {
1951 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
1952 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
1953 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
1954 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
1955 int type, utime_t mtime, const char *fmt, ...);
1956 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
1957 int level, const char *fmt, ...);
1958 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
1960 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
1962 /* New functions follow */
1963 bRC (*AddExclude)(bpContext *ctx, const char *file);
1964 bRC (*AddInclude)(bpContext *ctx, const char *file);
1965 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
1966 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
1967 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
1968 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
1974 \item [AddExclude] can be called to exclude a file. The file
1975 string passed may include wildcards that will be interpreted by
1976 the {\bf fnmatch} subroutine. This function can be called
1977 multiple times, and each time the file specified will be added
1978 to the list of files to be excluded. Note, this function only
1979 permits adding excludes of specific file or directory names,
1980 or files matched by the rather simple fnmatch mechanism.
1981 See below for information on doing wild-card and regex excludes.
1983 \item [NewPreInclude] can be called to create a new Include block. This
1984 block will be added after the current defined Include block. This
1985 function can be called multiple times, but each time, it will create
1986 a new Include section (not normally needed). This function should
1987 be called only if you want to add an entirely new Include block.
1989 \item [NewInclude] can be called to create a new Include block. This
1990 block will be added before any user defined Include blocks. This
1991 function can be called multiple times, but each time, it will create
1992 a new Include section (not normally needed). This function should
1993 be called only if you want to add an entirely new Include block.
1995 \item [AddInclude] can be called to add new files/directories to
1996 be included. They are added to the current Include block. If
1997 NewInclude has not been included, the current Include block is
1998 the last one that the user created. This function
1999 should be used only if you want to add totally new files/directories
2000 to be included in the backup.
2002 \item [NewOptions] adds a new Options block to the current Include
2003 in front of any other Options blocks. This permits the plugin to
2004 add exclude directives (wild-cards and regexes) in front of the
2005 user Options, and thus prevent certain files from being backed up.
2006 This can be useful if the plugin backs up files, and they should
2007 not be also backed up by the main Bacula code. This function
2008 may be called multiple times, and each time, it creates a new
2009 prepended Options block. Note: normally you want to call this
2010 entry point prior to calling AddOptions, AddRegex, or AddWild.
2012 \item [AddOptions] allows the plugin it set options in
2013 the current Options block, which is normally created with the
2014 NewOptions call just prior to adding Include Options.
2015 The permitted options are passed as a character string, where
2016 each character has a specific meaning as defined below:
2019 \item [a] always replace files (default).
2020 \item [e] exclude rather than include.
2021 \item [h] no recursion into subdirectories.
2022 \item [H] do not handle hard links.
2023 \item [i] ignore case in wildcard and regex matches.
2024 \item [M] compute an MD5 sum.
2025 \item [p] use a portable data format on Windows (not recommended).
2026 \item [R] backup resource forks and Findr Info.
2027 \item [r] read from a fifo
2028 \item [S1] compute an SHA1 sum.
2029 \item [S2] compute an SHA256 sum.
2030 \item [S3] comput an SHA512 sum.
2031 \item [s] handle sparse files.
2032 \item [m] use st\_mtime only for file differences.
2033 \item [k] restore the st\_atime after accessing a file.
2034 \item [A] enable ACL backup.
2035 \item [Vxxx:] specify verify options. Must terminate with :
2036 \item [Cxxx:] specify accurate options. Must terminate with :
2037 \item [Jxxx:] specify base job Options. Must terminate with :
2038 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
2040 \item [Zn] specify gzip compression level n.
2041 \item [K] do not use st\_atime in backup decision.
2042 \item [c] check if file changed during backup.
2043 \item [N] honor no dump flag.
2044 \item [X] enable backup of extended attributes.
2047 \item [AddRegex] adds a regex expression to the current Options block.
2048 The following options are permitted:
2050 \item [ ] (a blank) regex applies to whole path and filename.
2051 \item [F] regex applies only to the filename (directory or path stripped).
2052 \item [D] regex applies only to the directory (path) part of the name.
2055 \item [AddWild] adds a wildcard expression to the current Options block.
2056 The following options are permitted:
2058 \item [ ] (a blank) regex applies to whole path and filename.
2059 \item [F] regex applies only to the filename (directory or path stripped).
2060 \item [D] regex applies only to the directory (path) part of the name.
2063 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
2064 that can use Accurate code to compare the file information in argument with
2065 the previous file information. The \texttt{delta\_seq} attribute of the
2066 \texttt{save\_pkt} will be updated, and the call will return
2067 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
2072 \subsubsection{Bacula events}
2073 The list of events has been extended to include:
2079 bEventStartBackupJob = 3,
2080 bEventEndBackupJob = 4,
2081 bEventStartRestoreJob = 5,
2082 bEventEndRestoreJob = 6,
2083 bEventStartVerifyJob = 7,
2084 bEventEndVerifyJob = 8,
2085 bEventBackupCommand = 9,
2086 bEventRestoreCommand = 10,
2091 bEventCancelCommand = 13,
2092 bEventVssBackupAddComponents = 14,
2093 bEventVssRestoreLoadComponentMetadata = 15,
2094 bEventVssRestoreSetComponentsSelected = 16,
2095 bEventRestoreObject = 17,
2096 bEventEndFileSet = 18,
2097 bEventPluginCommand = 19,
2098 bEventVssBeforeCloseRestore = 20,
2099 bEventVssPrepareSnapshot = 21
2105 \item [bEventCancelCommand] is called whenever the currently
2106 running Job is canceled */
2108 \item [bEventVssBackupAddComponents]
2110 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
2111 provides a char[27] table where the plugin can add Windows drives that will
2112 be used during the Job. You need to add them without duplicates, and you can
2113 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
2117 \subsection{ACL enhancements}
2119 The following enhancements are made to the Bacula Filed with regards to
2120 Access Control Lists (ACLs)
2123 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
2124 POSIX and NFSv4 ACLs.
2125 \item Added support for new acl types on FreeBSD 8.1 and later which supports
2126 POSIX and NFSv4 ACLs.
2127 \item Some generic cleanups for internal ACL handling.
2128 \item Fix for acl storage on OSX
2129 \item Cleanup of configure checks for ACL detection, now configure only
2130 tests for a certain interface type based on the operating system
2131 this should give less false positives on detection. Also when ACLs
2132 are detected no other acl checks are performed anymore.
2136 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
2137 and is available with Bacula Enterprise Edition and Community Edition.
2139 \subsection{XATTR enhancements}
2141 The following enhancements are made to the Bacula Filed with regards to
2142 Extended Attributes (XATTRs)
2145 \item Added support for IRIX extended attributes using the attr\_get interface.
2146 \item Added support for Tru64 (OSF1) extended attributes using the
2147 getproplist interface.
2148 \item Added support for AIX extended attributes available in AIX 6.x
2149 and higher using the listea/getea/setea interface.
2150 \item Added some debugging to generic xattr code so it easier to
2152 \item Cleanup of configure checks for XATTR detection, now configure only
2153 tests for a certain interface type based on the operating system
2154 this should give less false positives on detection. Also when xattrs
2155 are detected no other xattr checks are performed anymore.
2159 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
2160 and is available with Bacula Enterprise Edition and Community Edition.
2162 \subsection{Class Based Database Backend Drivers}
2164 The main Bacula Director code is independent of the SQL backend
2165 in version 5.2.0 and greater. This means that the Bacula Director can be
2166 packaged by itself, then each of the different SQL backends supported can
2167 be packaged separately. It is possible to build all the DB backends at the
2168 same time by including multiple database options at the same time.
2170 ./configure can be run with multiple database configure options.
2177 Order of testing for databases is:
2184 Each configured backend generates a file named:
2185 \verb+libbaccats-<sql_backend_name>-<version>.so+
2186 A dummy catalog library is created named libbaccats-version.so
2188 At configure time the first detected backend is used as the so called
2189 default backend and at install time the dummy
2190 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
2192 If you configure all three backends you get three backend libraries and the
2193 postgresql gets installed as the default.
2195 When you want to switch to another database, first save any old catalog you
2196 may have then you can copy one of the three backend libraries over the
2197 \verb+libbaccats-<version>.so+ e.g.
2199 An actual command, depending on your Bacula version might be:
2201 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
2204 where the \verb+5.2.2+ must be replaced by the Bacula release
2207 Then you must update the default backend in the following files:
2210 create_bacula_database
2211 drop_bacula_database
2213 grant_bacula_privileges
2216 update_bacula_tables
2219 And re-run all the above scripts. Please note, this means
2220 you will have a new empty database and if you had a previous
2221 one it will be lost.
2223 All current database backend drivers for catalog information are rewritten
2224 to use a set of multi inherited C++ classes which abstract the specific
2225 database specific internals and make sure we have a more stable generic
2226 interface with the rest of SQL code. From now on there is a strict
2227 boundary between the SQL code and the low-level database functions. This
2228 new interface should also make it easier to add a new backend for a
2229 currently unsupported database. As part of the rewrite the SQLite 2 code
2230 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
2231 new code is that you can configure multiple backends in the configure and
2232 build all backends in one compile session and select the correct database
2233 backend at install time. This should make it a lot easier for packages
2239 We also added cursor support for PostgreSQL backend, this improves memory
2240 usage for large installation.
2243 This project was implemented by Planets Communications B.V. and ELM
2244 Consultancy B.V. and Bacula Systems and is available with both the Bacula
2245 Enterprise Edition and the Community Edition.
2247 \subsection{Hash List Enhancements}
2249 The htable hash table class has been extended with extra hash functions for
2250 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
2251 Also the hash table initialization routines have been enhanced with
2252 support for passing a hint as to the number of initial pages to use
2253 for the size of the hash table. Until now the hash table always used
2254 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
2255 cache have been rewritten to use the new htable class with a small memory
2259 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
2260 and Bacula Systems and is available with Bacula Enterprise Edition and
2265 %%% =====================================================================
2270 \section{Release Version 5.0.3}
2272 There are no new features in version 5.0.2. This version simply fixes a
2273 number of bugs found in version 5.0.1 during the ongoing development
2276 \section{Release Version 5.0.2}
2278 There are no new features in version 5.0.2. This version simply fixes a
2279 number of bugs found in version 5.0.1 during the ongoing development
2285 \section{New Features in 5.0.1}
2287 This chapter presents the new features that are in the released Bacula version
2288 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
2289 the ongoing development process.
2291 \subsection{Truncate Volume after Purge}
2292 \label{sec:actiononpurge}
2294 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
2295 the volume when it is purged with the new command \texttt{purge volume
2296 action}. It is useful to prevent disk based volumes from consuming too much
2302 Action On Purge = Truncate
2307 As usual you can also set this property with the \texttt{update volume} command
2309 *update volume=xxx ActionOnPurge=Truncate
2310 *update volume=xxx actiononpurge=None
2313 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
2314 following command in interactive mode or in a RunScript as shown after:
2316 *purge volume action=truncate storage=File allpools
2317 # or by default, action=all
2318 *purge volume action storage=File pool=Default
2321 This is possible to specify the volume name, the media type, the pool, the
2322 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
2323 idle when you decide to run this command.
2327 Name = CatalogBackup
2332 Console = "purge volume action=all allpools storage=File"
2337 \textbf{Important note}: This feature doesn't work as
2338 expected in version 5.0.0. Please do not use it before version 5.0.1.
2340 \subsection{Allow Higher Duplicates}
2341 This directive did not work correctly and has been depreciated
2342 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
2343 file as it will be removed in a future release.
2345 \subsection{Cancel Lower Level Duplicates}
2346 This directive was added in Bacula version 5.0.1. It compares the
2347 level of a new backup job to old jobs of the same name, if any,
2348 and will kill the job which has a lower level than the other one.
2349 If the levels are the same (i.e. both are Full backups), then
2350 nothing is done and the other Cancel XXX Duplicate directives
2353 \section{New Features in 5.0.0}
2355 \subsection{Maximum Concurrent Jobs for Devices}
2356 \label{sec:maximumconcurrentjobdevice}
2358 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
2359 Daemon configuration permits setting the maximum number of Jobs that can
2360 run concurrently on a specified Device. Using this directive, it is
2361 possible to have different Jobs using multiple drives, because when the
2362 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
2363 Jobs on any other available compatible drive. This facilitates writing to
2364 multiple drives with multiple Jobs that all use the same Pool.
2366 This project was funded by Bacula Systems.
2368 \subsection{Restore from Multiple Storage Daemons}
2369 \index[general]{Restore}
2371 Previously, you were able to restore from multiple devices in a single Storage
2372 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
2373 example, if your full backup runs on a Storage Daemon with an autochanger, and
2374 your incremental jobs use another Storage Daemon with lots of disks, Bacula
2375 will switch automatically from one Storage Daemon to an other within the same
2378 You must upgrade your File Daemon to version 3.1.3 or greater to use this
2381 This project was funded by Bacula Systems with the help of Equiinet.
2383 \subsection{File Deduplication using Base Jobs}
2384 A base job is sort of like a Full save except that you will want the FileSet to
2385 contain only files that are unlikely to change in the future (i.e. a snapshot
2386 of most of your system after installing it). After the base job has been run,
2387 when you are doing a Full save, you specify one or more Base jobs to be used.
2388 All files that have been backed up in the Base job/jobs but not modified will
2389 then be excluded from the backup. During a restore, the Base jobs will be
2390 automatically pulled in where necessary.
2392 This is something none of the competition does, as far as we know (except
2393 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
2394 win for the user, it makes Bacula stand out as offering a unique optimization
2395 that immediately saves time and money. Basically, imagine that you have 100
2396 nearly identical Windows or Linux machine containing the OS and user files.
2397 Now for the OS part, a Base job will be backed up once, and rather than making
2398 100 copies of the OS, there will be only one. If one or more of the systems
2399 have some files updated, no problem, they will be automatically restored.
2401 See the \ilink{Base Job Chapter}{basejobs} for more information.
2403 This project was funded by Bacula Systems.
2405 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
2406 \index[dir]{AllowCompression}
2408 This new directive may be added to Storage resource within the Director's
2409 configuration to allow users to selectively disable the client compression for
2410 any job which writes to this storage resource.
2416 Address = ultrium-tape
2417 Password = storage_password # Password for Storage Daemon
2420 AllowCompression = No # Tape drive has hardware compression
2423 The above example would cause any jobs running with the UltriumTape storage
2424 resource to run without compression from the client file daemons. This
2425 effectively overrides any compression settings defined at the FileSet level.
2427 This feature is probably most useful if you have a tape drive which supports
2428 hardware compression. By setting the \texttt{AllowCompression = No} directive
2429 for your tape drive storage resource, you can avoid additional load on the file
2430 daemon and possibly speed up tape backups.
2432 This project was funded by Collaborative Fusion, Inc.
2434 \subsection{Accurate Fileset Options}
2435 \label{sec:accuratefileset}
2437 In previous versions, the accurate code used the file creation and modification
2438 times to determine if a file was modified or not. Now you can specify which
2439 attributes to use (time, size, checksum, permission, owner, group, \dots),
2440 similar to the Verify options.
2456 \item {\bf i} compare the inodes
2457 \item {\bf p} compare the permission bits
2458 \item {\bf n} compare the number of links
2459 \item {\bf u} compare the user id
2460 \item {\bf g} compare the group id
2461 \item {\bf s} compare the size
2462 \item {\bf a} compare the access time
2463 \item {\bf m} compare the modification time (st\_mtime)
2464 \item {\bf c} compare the change time (st\_ctime)
2465 \item {\bf d} report file size decreases
2466 \item {\bf 5} compare the MD5 signature
2467 \item {\bf 1} compare the SHA1 signature
2470 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
2471 the File Daemon will have to read all files even if they normally would not
2472 be saved. This increases the I/O load, but also the accuracy of the
2473 deduplication. By default, Bacula will check modification/creation time
2476 This project was funded by Bacula Systems.
2478 \subsection{Tab-completion for Bconsole}
2479 \label{sec:tabcompletion}
2481 If you build \texttt{bconsole} with readline support, you will be able to use
2482 the new auto-completion mode. This mode supports all commands, gives help
2483 inside command, and lists resources when required. It works also in the restore
2486 To use this feature, you should have readline development package loaded on
2487 your system, and use the following option in configure.
2489 ./configure --with-readline=/usr/include/readline --disable-conio ...
2492 The new bconsole won't be able to tab-complete with older directors.
2494 This project was funded by Bacula Systems.
2496 \subsection{Pool File and Job Retention}
2497 \label{sec:poolfilejobretention}
2499 We added two new Pool directives, \texttt{FileRetention} and
2500 \texttt{JobRetention}, that take precedence over Client directives of the same
2501 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
2502 example, you can decide to increase Retention times for Archive or OffSite Pool.
2504 It seems obvious to us, but apparently not to some users, that given the
2505 definition above that the Pool File and Job Retention periods is a global
2506 override for the normal Client based pruning, which means that when the
2507 Job is pruned, the pruning will apply globally to that particular Job.
2509 Currently, there is a bug in the implementation that causes any Pool
2510 retention periods specified to apply to {\bf all} Pools for that
2511 particular Client. Thus we suggest that you avoid using these two
2512 directives until this implementation problem is corrected.
2514 \subsection{Read-only File Daemon using capabilities}
2515 \label{sec:fdreadonly}
2516 This feature implements support of keeping \textbf{ReadAll} capabilities after
2517 UID/GID switch, this allows FD to keep root read but drop write permission.
2519 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
2520 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
2523 root@localhost:~# bacula-fd -k -u nobody -g nobody
2526 The code for this feature was contributed by our friends at AltLinux.
2528 \subsection{Bvfs API}
2531 To help developers of restore GUI interfaces, we have added new \textsl{dot
2532 commands} that permit browsing the catalog in a very simple way.
2535 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
2536 the Bvfs cache in the catalog. You need to run it before any access to the
2539 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
2540 will list all directories in the specified \texttt{path} or
2541 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
2542 encoding of path/filenames.
2544 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
2545 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
2546 \texttt{pathid} avoids problems with character encoding.
2549 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
2550 data that will be displayed.
2553 * .bvfs_update jobid=1,2
2555 * .bvfs_lsdir path=/ jobid=1,2
2558 This project was funded by Bacula Systems.
2560 \subsection{Testing your Tape Drive}
2561 \label{sec:btapespeed}
2563 To determine the best configuration of your tape drive, you can run the new
2564 \texttt{speed} command available in the \texttt{btape} program.
2566 This command can have the following arguments:
2568 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
2569 (between 1 and 5GB). This counter is in GB.
2570 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
2571 of data should be greater than your memory ($file\_size*nb\_file$).
2572 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
2574 \item[\texttt{skip\_random}] This flag permits to skip tests with random
2576 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
2577 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
2582 *speed file_size=3 skip_raw
2583 btape.c:1078 Test with zero data and bacula block structure.
2584 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
2585 ++++++++++++++++++++++++++++++++++++++++++
2586 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
2587 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
2589 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
2591 btape.c:1090 Test with random data, should give the minimum throughput.
2592 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
2593 +++++++++++++++++++++++++++++++++++++++++++
2594 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
2595 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
2596 +++++++++++++++++++++++++++++++++++++++++++
2598 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
2602 When using compression, the random test will give your the minimum throughput
2603 of your drive . The test using constant string will give you the maximum speed
2604 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
2606 You can change the block size in the Storage Daemon configuration file.
2608 \subsection{New {\bf Block Checksum} Device Directive}
2609 You may now turn off the Block Checksum (CRC32) code
2610 that Bacula uses when writing blocks to a Volume. This is
2617 doing so can reduce the Storage daemon CPU usage slightly. It
2618 will also permit Bacula to read a Volume that has corrupted data.
2620 The default is {\bf yes} -- i.e. the checksum is computed on write
2621 and checked on read.
2623 We do not recommend to turn this off particularly on older tape
2624 drives or for disk Volumes where doing so may allow corrupted data
2627 \subsection{New Bat Features}
2629 Those new features were funded by Bacula Systems.
2631 \subsubsection{Media List View}
2633 By clicking on ``Media'', you can see the list of all your volumes. You will be
2634 able to filter by Pool, Media Type, Location,\dots And sort the result directly
2635 in the table. The old ``Media'' view is now known as ``Pool''.
2636 \begin{figure}[htbp]
2638 \includegraphics[width=0.8\linewidth]{bat-mediaview}
2639 \label{fig:mediaview}
2643 \subsubsection{Media Information View}
2645 By double-clicking on a volume (on the Media list, in the Autochanger content
2646 or in the Job information panel), you can access a detailed overview of your
2647 Volume. (cf figure \vref{fig:mediainfo}.)
2648 \begin{figure}[htbp]
2650 \includegraphics[width=0.8\linewidth]{bat11}
2651 \caption{Media information}
2652 \label{fig:mediainfo}
2655 \subsubsection{Job Information View}
2657 By double-clicking on a Job record (on the Job run list or in the Media
2658 information panel), you can access a detailed overview of your Job. (cf
2659 figure \vref{fig:jobinfo}.)
2660 \begin{figure}[htbp]
2662 \includegraphics[width=0.8\linewidth]{bat12}
2663 \caption{Job information}
2667 \subsubsection{Autochanger Content View}
2669 By double-clicking on a Storage record (on the Storage list panel), you can
2670 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
2671 \begin{figure}[htbp]
2673 \includegraphics[width=0.8\linewidth]{bat13}
2674 \caption{Autochanger content}
2675 \label{fig:achcontent}
2678 To use this feature, you need to use the latest mtx-changer script
2679 version. (With new \texttt{listall} and \texttt{transfer} commands)
2681 \subsection{Bat on Windows}
2682 We have ported {\bf bat} to Windows and it is now installed
2683 by default when the installer is run. It works quite well
2684 on Win32, but has not had a lot of testing there, so your
2685 feedback would be welcome. Unfortunately, even though it is
2686 installed by default, it does not yet work on 64 bit Windows
2689 \subsection{New Win32 Installer}
2690 The Win32 installer has been modified in several very important
2693 \item You must deinstall any current version of the
2694 Win32 File daemon before upgrading to the new one.
2695 If you forget to do so, the new installation will fail.
2696 To correct this failure, you must manually shutdown
2697 and deinstall the old File daemon.
2698 \item All files (other than menu links) are installed
2699 in {\bf c:/Program Files/Bacula}.
2700 \item The installer no longer sets this
2701 file to require administrator privileges by default. If you want
2702 to do so, please do it manually using the {\bf cacls} program.
2705 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
2707 \item The server daemons (Director and Storage daemon) are
2708 no longer included in the Windows installer. If you want the
2709 Windows servers, you will either need to build them yourself (note
2710 they have not been ported to 64 bits), or you can contact
2711 Bacula Systems about this.
2714 \subsection{Win64 Installer}
2715 We have corrected a number of problems that required manual
2716 editing of the conf files. In most cases, it should now
2717 install and work. {\bf bat} is by default installed in
2718 {\bf c:/Program Files/Bacula/bin32} rather than
2719 {\bf c:/Program Files/Bacula} as is the case with the 32
2720 bit Windows installer.
2722 \subsection{Linux Bare Metal Recovery USB Key}
2723 We have made a number of significant improvements in the
2724 Bare Metal Recovery USB key. Please see the README files
2725 it the {\bf rescue} release for more details.
2727 We are working on an equivalent USB key for Windows bare
2728 metal recovery, but it will take some time to develop it (best
2729 estimate 3Q2010 or 4Q2010)
2732 \subsection{bconsole Timeout Option}
2733 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
2734 for commands. This is useful with GUI programs that use {\bf bconsole}
2735 to interface to the Director.
2737 \subsection{Important Changes}
2738 \label{sec:importantchanges}
2741 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
2742 to the same Pool. The Storage daemon ensures that you do not read and
2743 write to the same Volume.
2744 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
2746 \item Virtually all the features of {\bf mtx-changer} have
2747 now been parametrized, which allows you to configure
2748 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
2749 that contains variables that you can set to configure mtx-changer.
2750 This configuration file will not be overwritten during upgrades.
2751 We encourage you to submit any changes
2752 that are made to mtx-changer and to parametrize it all in
2753 mtx-changer.conf so that all configuration will be done by
2754 changing only mtx-changer.conf.
2755 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
2756 and \texttt{transfer}. Please configure them as appropriate
2757 in mtx-changer.conf.
2758 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
2759 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
2760 password. If you want to use the new script, you will need to
2761 manually change the \texttt{BackupCatalog} Job definition.
2762 \item The \texttt{bconsole} \texttt{help} command now accepts
2763 an argument, which if provided produces information on that
2764 command (ex: \texttt{help run}).
2768 \subsubsection*{Truncate volume after purge}
2770 Note that the Truncate Volume after purge feature doesn't work as expected
2771 in 5.0.0 version. Please, don't use it before version 5.0.1.
2773 \subsubsection{Custom Catalog queries}
2775 If you wish to add specialized commands that list the contents of the catalog,
2776 you can do so by adding them to the \texttt{query.sql} file. This
2777 \texttt{query.sql} file is now empty by default. The file
2778 \texttt{examples/sample-query.sql} has an a number of sample commands
2779 you might find useful.
2781 \subsubsection{Deprecated parts}
2783 The following items have been \textbf{deprecated} for a long time, and are now
2784 removed from the code.
2787 \item Support for SQLite 2
2790 \subsection{Misc Changes}
2791 \label{sec:miscchanges}
2794 \item Updated Nagios check\_bacula
2795 \item Updated man files
2796 \item Added OSX package generation script in platforms/darwin
2797 \item Added Spanish and Ukrainian Bacula translations
2798 \item Enable/disable command shows only Jobs that can change
2799 \item Added \texttt{show disabled} command to show disabled Jobs
2800 \item Many ACL improvements
2801 \item Added Level to FD status Job output
2802 \item Begin Ingres DB driver (not yet working)
2803 \item Split RedHat spec files into bacula, bat, mtx, and docs
2804 \item Reorganized the manuals (fewer separate manuals)
2805 \item Added lock/unlock order protection in lock manager
2806 \item Allow 64 bit sizes for a number of variables
2807 \item Fixed several deadlocks or potential race conditions in the SD
2810 \chapter{Released Version 3.0.3 and 3.0.3a}
2812 There are no new features in version 3.0.3. This version simply fixes a
2813 number of bugs found in version 3.0.2 during the ongoing development
2816 \section{New Features in Released Version 3.0.2}
2818 This chapter presents the new features added to the
2819 Released Bacula Version 3.0.2.
2821 \subsection{Full Restore from a Given JobId}
2822 \index[general]{Restore menu}
2824 This feature allows selecting a single JobId and having Bacula
2825 automatically select all the other jobs that comprise a full backup up to
2826 and including the selected date (through JobId).
2828 Assume we start with the following jobs:
2830 +-------+--------------+---------------------+-------+----------+------------+
2831 | jobid | client | starttime | level | jobfiles | jobbytes |
2832 +-------+--------------+---------------------+-------+----------+------------
2833 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
2834 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
2835 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
2836 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
2837 +-------+--------------+---------------------+-------+----------+------------+
2840 Below is an example of this new feature (which is number 12 in the
2845 To select the JobIds, you have the following choices:
2846 1: List last 20 Jobs run
2847 2: List Jobs where a given File is saved
2849 12: Select full restore to a specified Job date
2852 Select item: (1-13): 12
2853 Enter JobId to get the state to restore: 5
2854 Selecting jobs to build the Full state at 2009-07-15 11:45:45
2855 You have selected the following JobIds: 1,3,5
2857 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
2858 1,444 files inserted into the tree.
2861 This project was funded by Bacula Systems.
2863 \subsection{Source Address}
2864 \index[general]{Source Address}
2866 A feature has been added which allows the administrator to specify the address
2867 from which the Director and File daemons will establish connections. This
2868 may be used to simplify system configuration overhead when working in complex
2869 networks utilizing multi-homing and policy-routing.
2871 To accomplish this, two new configuration directives have been implemented:
2874 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
2878 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
2882 Simply adding specific host routes on the OS
2883 would have an undesirable side-effect: any
2884 application trying to contact the destination host would be forced to use the
2885 more specific route possibly diverting management traffic onto a backup VLAN.
2886 Instead of adding host routes for each client connected to a multi-homed backup
2887 server (for example where there are management and backup VLANs), one can
2888 use the new directives to specify a specific source address at the application
2891 Additionally, this allows the simplification and abstraction of firewall rules
2892 when dealing with a Hot-Standby director or storage daemon configuration. The
2893 Hot-standby pair may share a CARP address, which connections must be sourced
2894 from, while system services listen and act from the unique interface addresses.
2896 This project was funded by Collaborative Fusion, Inc.
2898 \subsection{Show volume availability when doing restore}
2900 When doing a restore the selection dialog ends by displaying this
2904 The job will require the following
2905 Volume(s) Storage(s) SD Device(s)
2906 ===========================================================================
2907 *000741L3 LTO-4 LTO3
2908 *000866L3 LTO-4 LTO3
2909 *000765L3 LTO-4 LTO3
2910 *000764L3 LTO-4 LTO3
2911 *000756L3 LTO-4 LTO3
2912 *001759L3 LTO-4 LTO3
2913 *001763L3 LTO-4 LTO3
2917 Volumes marked with ``*'' are online (in the autochanger).
2920 This should help speed up large restores by minimizing the time spent
2921 waiting for the operator to discover that he must change tapes in the library.
2923 This project was funded by Bacula Systems.
2925 \subsection{Accurate estimate command}
2927 The \texttt{estimate} command can now use the accurate code to detect changes
2928 and give a better estimation.
2930 You can set the accurate behavior on the command line by using
2931 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
2934 * estimate listing accurate=yes level=incremental job=BackupJob
2937 This project was funded by Bacula Systems.
2939 \section{New Features in 3.0.0}
2940 \label{NewFeaturesChapter}
2941 \index[general]{New Features}
2943 This chapter presents the new features added to the development 2.5.x
2944 versions to be released as Bacula version 3.0.0 sometime in April 2009.
2946 \subsection{Accurate Backup}
2947 \index[general]{Accurate Backup}
2949 As with most other backup programs, by default Bacula decides what files to
2950 backup for Incremental and Differential backup by comparing the change
2951 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
2952 backup completed. If one of those two times is later than the last backup
2953 time, then the file will be backed up. This does not, however, permit tracking
2954 what files have been deleted and will miss any file with an old time that may
2955 have been restored to or moved onto the client filesystem.
2957 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
2958 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
2959 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
2960 backup, there is no difference, but for {\bf Differential} and {\bf
2961 Incremental} backups, the Director will send a list of all previous files
2962 backed up, and the File daemon will use that list to determine if any new files
2963 have been added or or moved and if any files have been deleted. This allows
2964 Bacula to make an accurate backup of your system to that point in time so that
2965 if you do a restore, it will restore your system exactly.
2968 about using Accurate backup is that it requires more resources (CPU and memory)
2969 on both the Director and the Client machines to create the list of previous
2970 files backed up, to send that list to the File daemon, for the File daemon to
2971 keep the list (possibly very big) in memory, and for the File daemon to do
2972 comparisons between every file in the FileSet and the list. In particular,
2973 if your client has lots of files (more than a few million), you will need
2974 lots of memory on the client machine.
2976 Accurate must not be enabled when backing up with a plugin that is not
2977 specially designed to work with Accurate. If you enable it, your restores
2978 will probably not work correctly.
2980 This project was funded by Bacula Systems.
2984 \subsection{Copy Jobs}
2985 \index[general]{Copy Jobs}
2987 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
2988 existing Migration feature with the exception that the Job that is copied is
2989 left unchanged. This essentially creates two identical copies of the same
2990 backup. However, the copy is treated as a copy rather than a backup job, and
2991 hence is not directly available for restore. The {\bf restore} command lists
2992 copy jobs and allows selection of copies by using \texttt{jobid=}
2993 option. If the keyword {\bf copies} is present on the command line, Bacula will
2994 display the list of all copies for selected jobs.
2999 These JobIds have copies as follows:
3000 +-------+------------------------------------+-----------+------------------+
3001 | JobId | Job | CopyJobId | MediaType |
3002 +-------+------------------------------------+-----------+------------------+
3003 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
3004 +-------+------------------------------------+-----------+------------------+
3005 +-------+-------+----------+----------+---------------------+------------------+
3006 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
3007 +-------+-------+----------+----------+---------------------+------------------+
3008 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
3009 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
3010 +-------+-------+----------+----------+---------------------+------------------+
3011 You have selected the following JobIds: 19,2
3013 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
3014 5,611 files inserted into the tree.
3019 The Copy Job runs without using the File daemon by copying the data from the
3020 old backup Volume to a different Volume in a different Pool. See the Migration
3021 documentation for additional details. For copy Jobs there is a new selection
3022 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
3023 not already copied to another Pool.
3025 As with Migration, the Client, Volume, Job, or SQL query, are
3026 other possible ways of selecting the Jobs to be copied. Selection
3027 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
3028 work, but are probably more suited for Migration Jobs.
3030 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
3031 it will promote the Copy to a \textsl{real} backup job and will make it available for
3032 automatic restore. If more than one Copy is available, it will promote the copy
3033 with the smallest JobId.
3035 A nice solution which can be built with the new Copy feature is often
3036 called disk-to-disk-to-tape backup (DTDTT). A sample config could
3037 look something like the one below:
3041 Name = FullBackupsVirtualPool
3043 Purge Oldest Volume = Yes
3045 NextPool = FullBackupsTapePool
3049 Name = FullBackupsTapePool
3053 Volume Retention = 365 days
3054 Storage = superloader
3058 # Fake fileset for copy jobs
3070 # Fake client for copy jobs
3080 # Default template for a CopyDiskToTape Job
3083 Name = CopyDiskToTape
3085 Messages = StandardCopy
3088 Selection Type = PoolUncopiedJobs
3089 Maximum Concurrent Jobs = 10
3091 Allow Duplicate Jobs = Yes
3092 Cancel Queued Duplicates = No
3093 Cancel Running Duplicates = No
3098 Name = DaySchedule7:00
3099 Run = Level=Full daily at 7:00
3103 Name = CopyDiskToTapeFullBackups
3105 Schedule = DaySchedule7:00
3106 Pool = FullBackupsVirtualPool
3107 JobDefs = CopyDiskToTape
3111 The example above had 2 pool which are copied using the PoolUncopiedJobs
3112 selection criteria. Normal Full backups go to the Virtual pool and are copied
3113 to the Tape pool the next morning.
3115 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
3120 +-------+------------------------------------+-----------+------------------+
3121 | JobId | Job | CopyJobId | MediaType |
3122 +-------+------------------------------------+-----------+------------------+
3123 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
3124 +-------+------------------------------------+-----------+------------------+
3127 \subsection{ACL Updates}
3128 \index[general]{ACL Updates}
3129 The whole ACL code had been overhauled and in this version each platforms has
3130 different streams for each type of acl available on such an platform. As ACLs
3131 between platforms tend to be not that portable (most implement POSIX acls but
3132 some use an other draft or a completely different format) we currently only
3133 allow certain platform specific ACL streams to be decoded and restored on the
3134 same platform that they were created on. The old code allowed to restore ACL
3135 cross platform but the comments already mention that not being to wise. For
3136 backward compatibility the new code will accept the two old ACL streams and
3137 handle those with the platform specific handler. But for all new backups it
3138 will save the ACLs using the new streams.
3140 Currently the following platforms support ACLs:
3144 \item {\bf Darwin/OSX}
3153 Currently we support the following ACL types (these ACL streams use a reserved
3154 part of the stream numbers):
3157 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
3159 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
3160 string representation from acl\_to\_text (POSIX acl)
3161 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
3162 string representation from acl\_to\_text (POSIX acl) for default acls.
3163 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
3164 string representation from acl\_to\_text (POSIX acl) for access acls.
3165 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
3166 string representation from acltostr (POSIX acl)
3167 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
3168 representation from acl\_to\_text (POSIX acl) for default acls.
3169 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
3170 representation from acl\_to\_text (POSIX acl) for access acls.
3171 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
3172 string representation from acl\_to\_text (POSIX acl) for default acls.
3173 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
3174 representation from acl\_to\_text (POSIX acl) for access acls.
3175 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
3176 string representation from acl\_to\_text (POSIX acl) for default acls.
3177 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
3178 string representation from acl\_to\_text (POSIX acl) for default acls.
3179 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
3180 representation from acl\_to\_text (POSIX acl) for access acls.
3181 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
3182 string representation from acltotext or acl\_totext (POSIX acl)
3183 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
3184 representation from from acl\_totext (NFSv4 or ZFS acl)
3187 In future versions we might support conversion functions from one type of acl
3188 into an other for types that are either the same or easily convertible. For now
3189 the streams are separate and restoring them on a platform that doesn't
3190 recognize them will give you a warning.
3192 \subsection{Extended Attributes}
3193 \index[general]{Extended Attributes}
3194 Something that was on the project list for some time is now implemented for
3195 platforms that support a similar kind of interface. Its the support for backup
3196 and restore of so called extended attributes. As extended attributes are so
3197 platform specific these attributes are saved in separate streams for each
3198 platform. Restores of the extended attributes can only be performed on the
3199 same platform the backup was done. There is support for all types of extended
3200 attributes, but restoring from one type of filesystem onto an other type of
3201 filesystem on the same platform may lead to surprises. As extended attributes
3202 can contain any type of data they are stored as a series of so called
3203 value-pairs. This data must be seen as mostly binary and is stored as such.
3204 As security labels from selinux are also extended attributes this option also
3205 stores those labels and no specific code is enabled for handling selinux
3208 Currently the following platforms support extended attributes:
3210 \item {\bf Darwin/OSX}
3216 On Linux acls are also extended attributes, as such when you enable ACLs on a
3217 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
3218 and not the same extended attribute.
3220 To enable the backup of extended attributes please add the following to your
3235 \subsection{Shared objects}
3236 \index[general]{Shared objects}
3237 A default build of Bacula will now create the libraries as shared objects
3238 (.so) rather than static libraries as was previously the case.
3239 The shared libraries are built using {\bf libtool} so it should be quite
3242 An important advantage of using shared objects is that on a machine with the
3243 Directory, File daemon, the Storage daemon, and a console, you will have only
3244 one copy of the code in memory rather than four copies. Also the total size of
3245 the binary release is smaller since the library code appears only once rather
3246 than once for every program that uses it; this results in significant reduction
3247 in the size of the binaries particularly for the utility tools.
3249 In order for the system loader to find the shared objects when loading the
3250 Bacula binaries, the Bacula shared objects must either be in a shared object
3251 directory known to the loader (typically /usr/lib) or they must be in the
3252 directory that may be specified on the {\bf ./configure} line using the {\bf
3253 {-}{-}libdir} option as:
3256 ./configure --libdir=/full-path/dir
3259 the default is /usr/lib. If {-}{-}libdir is specified, there should be
3260 no need to modify your loader configuration provided that
3261 the shared objects are installed in that directory (Bacula
3262 does this with the make install command). The shared objects
3263 that Bacula references are:
3272 These files are symbolically linked to the real shared object file,
3273 which has a version number to permit running multiple versions of
3274 the libraries if desired (not normally the case).
3276 If you have problems with libtool or you wish to use the old
3277 way of building static libraries, or you want to build a static
3278 version of Bacula you may disable
3279 libtool on the configure command line with:
3282 ./configure --disable-libtool
3286 \subsection{Building Static versions of Bacula}
3287 \index[general]{Static linking}
3288 In order to build static versions of Bacula, in addition
3289 to configuration options that were needed you now must
3290 also add --disable-libtool. Example
3293 ./configure --enable-static-client-only --disable-libtool
3297 \subsection{Virtual Backup (Vbackup)}
3298 \index[general]{Virtual Backup}
3299 \index[general]{Vbackup}
3301 Bacula's virtual backup feature is often called Synthetic Backup or
3302 Consolidation in other backup products. It permits you to consolidate the
3303 previous Full backup plus the most recent Differential backup and any
3304 subsequent Incremental backups into a new Full backup. This new Full
3305 backup will then be considered as the most recent Full for any future
3306 Incremental or Differential backups. The VirtualFull backup is
3307 accomplished without contacting the client by reading the previous backup
3308 data and writing it to a volume in a different pool.
3310 In some respects the Vbackup feature works similar to a Migration job, in
3311 that Bacula normally reads the data from the pool specified in the
3312 Job resource, and writes it to the {\bf Next Pool} specified in the
3313 Job resource. Note, this means that usually the output from the Virtual
3314 Backup is written into a different pool from where your prior backups
3315 are saved. Doing it this way guarantees that you will not get a deadlock
3316 situation attempting to read and write to the same volume in the Storage
3317 daemon. If you then want to do subsequent backups, you may need to
3318 move the Virtual Full Volume back to your normal backup pool.
3319 Alternatively, you can set your {\bf Next Pool} to point to the current
3320 pool. This will cause Bacula to read and write to Volumes in the
3321 current pool. In general, this will work, because Bacula will
3322 not allow reading and writing on the same Volume. In any case, once
3323 a VirtualFull has been created, and a restore is done involving the
3324 most current Full, it will read the Volume or Volumes by the VirtualFull
3325 regardless of in which Pool the Volume is found.
3327 The Vbackup is enabled on a Job by Job in the Job resource by specifying
3328 a level of {\bf VirtualFull}.
3330 A typical Job resource definition might look like the following:
3337 FileSet = "Full Set"
3344 # Default pool definition
3348 Recycle = yes # Automatically recycle Volumes
3349 AutoPrune = yes # Prune expired volumes
3350 Volume Retention = 365d # one year
3358 Recycle = yes # Automatically recycle Volumes
3359 AutoPrune = yes # Prune expired volumes
3360 Volume Retention = 365d # one year
3361 Storage = DiskChanger
3364 # Definition of file storage device
3369 Device = FileStorage
3371 Maximum Concurrent Jobs = 5
3374 # Definition of DDS Virtual tape disk storage device
3377 Address = localhost # N.B. Use a fully qualified name here
3379 Device = DiskChanger
3380 Media Type = DiskChangerMedia
3381 Maximum Concurrent Jobs = 4
3386 Then in bconsole or via a Run schedule, you would run the job as:
3389 run job=MyBackup level=Full
3390 run job=MyBackup level=Incremental
3391 run job=MyBackup level=Differential
3392 run job=MyBackup level=Incremental
3393 run job=MyBackup level=Incremental
3396 So providing there were changes between each of those jobs, you would end up
3397 with a Full backup, a Differential, which includes the first Incremental
3398 backup, then two Incremental backups. All the above jobs would be written to
3399 the {\bf Default} pool.
3401 To consolidate those backups into a new Full backup, you would run the
3405 run job=MyBackup level=VirtualFull
3408 And it would produce a new Full backup without using the client, and the output
3409 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
3411 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
3414 Note, the Start and End time of the Virtual Full backup is set to the
3415 values for the last job included in the Virtual Full (in the above example,
3416 it is an Increment). This is so that if another incremental is done, which
3417 will be based on the Virtual Full, it will backup all files from the
3418 last Job included in the Virtual Full rather than from the time the Virtual
3419 Full was actually run.
3423 \subsection{Catalog Format}
3424 \index[general]{Catalog Format}
3425 Bacula 3.0 comes with some changes to the catalog format. The upgrade
3426 operation will convert the FileId field of the File table from 32 bits (max 4
3427 billion table entries) to 64 bits (very large number of items). The
3428 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
3429 your catalog during the conversion. Also you won't be able to run jobs during
3430 this conversion period. For example, a 3 million file catalog will take 2
3431 minutes to upgrade on a normal machine. Please don't forget to make a valid
3432 backup of your database before executing the upgrade script. See the
3433 ReleaseNotes for additional details.
3435 \subsection{64 bit Windows Client}
3436 \index[general]{Win64 Client}
3437 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
3438 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
3439 As a consequence, we are also releasing a 64 bit version of the Bacula
3440 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
3441 These binaries should only be installed on 64 bit Windows operating systems.
3442 What is important is not your hardware but whether or not you have
3443 a 64 bit version of the Windows OS.
3445 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
3447 \item Before installing the Win64 Bacula Client, you must totally
3448 deinstall any prior 2.4.x Client installation using the
3449 Bacula deinstallation (see the menu item). You may want
3450 to save your .conf files first.
3451 \item Only the Client (File daemon) is ported to Win64, the Director
3452 and the Storage daemon are not in the 64 bit Windows installer.
3453 \item bwx-console is not yet ported.
3454 \item bconsole is ported but it has not been tested.
3455 \item The documentation is not included in the installer.
3456 \item Due to Vista security restrictions imposed on a default installation
3457 of Vista, before upgrading the Client, you must manually stop
3458 any prior version of Bacula from running, otherwise the install
3460 \item Due to Vista security restrictions imposed on a default installation
3461 of Vista, attempting to edit the conf files via the menu items
3462 will fail. You must directly edit the files with appropriate
3463 permissions. Generally double clicking on the appropriate .conf
3464 file will work providing you have sufficient permissions.
3465 \item All Bacula files are now installed in
3466 {\bf C:/Program Files/Bacula} except the main menu items,
3467 which are installed as before. This vastly simplifies the installation.
3468 \item If you are running on a foreign language version of Windows, most
3469 likely {\bf C:/Program Files} does not exist, so you should use the
3470 Custom installation and enter an appropriate location to install
3472 \item The 3.0.0 Win32 Client continues to install files in the locations used
3473 by prior versions. For the next version we will convert it to use
3474 the same installation conventions as the Win64 version.
3477 This project was funded by Bacula Systems.
3480 \subsection{Duplicate Job Control}
3481 \index[general]{Duplicate Jobs}
3482 The new version of Bacula provides four new directives that
3483 give additional control over what Bacula does if duplicate jobs
3484 are started. A duplicate job in the sense we use it here means
3485 a second or subsequent job with the same name starts. This
3486 happens most frequently when the first job runs longer than expected because no
3487 tapes are available.
3489 The four directives each take as an argument a {\bf yes} or {\bf no} value and
3490 are specified in the Job resource.
3494 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
3495 \index[general]{Allow Duplicate Jobs}
3496 If this directive is set to {\bf yes}, duplicate jobs will be run. If
3497 the directive is set to {\bf no} (default) then only one job of a given name
3498 may run at one time, and the action that Bacula takes to ensure only
3499 one job runs is determined by the other directives (see below).
3501 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
3502 are present and none of the three directives given below permit
3503 Canceling a job, then the current job (the second one started)
3506 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
3507 \index[general]{Allow Higher Duplicates}
3508 This directive was in version 5.0.0, but does not work as
3509 expected. If used, it should always be set to no. In later versions
3510 of Bacula the directive is disabled (disregarded).
3512 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
3513 \index[general]{Cancel Running Duplicates}
3514 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
3515 if this directive is set to {\bf yes} any job that is already running
3516 will be canceled. The default is {\bf no}.
3518 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
3519 \index[general]{Cancel Queued Duplicates}
3520 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
3521 if this directive is set to {\bf yes} any job that is
3522 already queued to run but not yet running will be canceled.
3523 The default is {\bf no}.
3526 \subsection{TLS Authentication}
3527 \index[general]{TLS Authentication}
3528 In Bacula version 2.5.x and later, in addition to the normal Bacula
3529 CRAM-MD5 authentication that is used to authenticate each Bacula
3530 connection, you can specify that you want TLS Authentication as well,
3531 which will provide more secure authentication.
3533 This new feature uses Bacula's existing TLS code (normally used for
3534 communications encryption) to do authentication. To use it, you must
3535 specify all the TLS directives normally used to enable communications
3536 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
3539 \subsubsection{TLS Authenticate = yes}
3541 TLS Authenticate = yes
3544 in the main daemon configuration resource (Director for the Director,
3545 Client for the File daemon, and Storage for the Storage daemon).
3547 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
3548 authentication, Bacula will also do TLS authentication, then TLS
3549 encryption will be turned off, and the rest of the communication between
3550 the two Bacula daemons will be done without encryption.
3552 If you want to encrypt communications data, use the normal TLS directives
3553 but do not turn on {\bf TLS Authenticate}.
3555 \subsection{bextract non-portable Win32 data}
3556 \index[general]{bextract handles Win32 non-portable data}
3557 {\bf bextract} has been enhanced to be able to restore
3558 non-portable Win32 data to any OS. Previous versions were
3559 unable to restore non-portable Win32 data to machines that
3560 did not have the Win32 BackupRead and BackupWrite API calls.
3562 \subsection{State File updated at Job Termination}
3563 \index[general]{State File}
3564 In previous versions of Bacula, the state file, which provides a
3565 summary of previous jobs run in the {\bf status} command output was
3566 updated only when Bacula terminated, thus if the daemon crashed, the
3567 state file might not contain all the run data. This version of
3568 the Bacula daemons updates the state file on each job termination.
3570 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
3571 \index[general]{MaxFullInterval}
3572 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
3573 can be used to specify the maximum time interval between {\bf Full} backup
3574 jobs. When a job starts, if the time since the last Full backup is
3575 greater than the specified interval, and the job would normally be an
3576 {\bf Incremental} or {\bf Differential}, it will be automatically
3577 upgraded to a {\bf Full} backup.
3579 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
3580 \index[general]{MaxDiffInterval}
3581 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
3582 can be used to specify the maximum time interval between {\bf Differential} backup
3583 jobs. When a job starts, if the time since the last Differential backup is
3584 greater than the specified interval, and the job would normally be an
3585 {\bf Incremental}, it will be automatically
3586 upgraded to a {\bf Differential} backup.
3588 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
3589 \index[general]{MaxDiffInterval}
3590 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
3591 by the user, and when it is set it is an indication to backup programs
3592 to not backup that particular file. This version of Bacula contains a
3593 new Options directive within a FileSet resource, which instructs Bacula to
3594 obey this flag. The new directive is:
3597 Honor No Dump Flag = yes\vb{}no
3600 The default value is {\bf no}.
3603 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
3604 \index[general]{IgnoreDir}
3605 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
3606 can be added to the Include section of the FileSet resource. If the specified
3607 filename ({\bf filename-string}) is found on the Client in any directory to be
3608 backed up, the whole directory will be ignored (not backed up). For example:
3611 # List of files to be backed up
3619 Exclude Dir Containing = .excludeme
3624 But in /home, there may be hundreds of directories of users and some
3625 people want to indicate that they don't want to have certain
3626 directories backed up. For example, with the above FileSet, if
3627 the user or sysadmin creates a file named {\bf .excludeme} in
3628 specific directories, such as
3631 /home/user/www/cache/.excludeme
3632 /home/user/temp/.excludeme
3635 then Bacula will not backup the two directories named:
3638 /home/user/www/cache
3642 NOTE: subdirectories will not be backed up. That is, the directive
3643 applies to the two directories in question and any children (be they
3644 files, directories, etc).
3647 \subsection{Bacula Plugins}
3648 \index[general]{Plugin}
3649 Support for shared object plugins has been implemented in the Linux, Unix
3650 and Win32 File daemons. The API will be documented separately in
3651 the Developer's Guide or in a new document. For the moment, there is
3652 a single plugin named {\bf bpipe} that allows an external program to
3653 get control to backup and restore a file.
3655 Plugins are also planned (partially implemented) in the Director and the
3658 \subsubsection{Plugin Directory}
3659 \index[general]{Plugin Directory}
3660 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
3661 be added to the daemon definition resource. The directory takes a quoted
3662 string argument, which is the name of the directory in which the daemon can
3663 find the Bacula plugins. If this directive is not specified, Bacula will not
3664 load any plugins. Since each plugin has a distinctive name, all the daemons
3665 can share the same plugin directory.
3667 \subsubsection{Plugin Options}
3668 \index[general]{Plugin Options}
3669 The {\bf Plugin Options} directive takes a quoted string
3670 argument (after the equal sign) and may be specified in the
3671 Job resource. The options specified will be passed to all plugins
3672 when they are run. This each plugin must know what it is looking
3673 for. The value defined in the Job resource can be modified
3674 by the user when he runs a Job via the {\bf bconsole} command line
3677 Note: this directive may be specified, and there is code to modify
3678 the string in the run command, but the plugin options are not yet passed to
3679 the plugin (i.e. not fully implemented).
3681 \subsubsection{Plugin Options ACL}
3682 \index[general]{Plugin Options ACL}
3683 The {\bf Plugin Options ACL} directive may be specified in the
3684 Director's Console resource. It functions as all the other ACL commands
3685 do by permitting users running restricted consoles to specify a
3686 {\bf Plugin Options} that overrides the one specified in the Job
3687 definition. Without this directive restricted consoles may not modify
3690 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
3691 \index[general]{Plugin}
3692 The {\bf Plugin} directive is specified in the Include section of
3693 a FileSet resource where you put your {\bf File = xxx} directives.
3704 Plugin = "bpipe:..."
3709 In the above example, when the File daemon is processing the directives
3710 in the Include section, it will first backup all the files in {\bf /home}
3711 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
3712 the Plugin Directory. The syntax and semantics of the Plugin directive
3713 require the first part of the string up to the colon (:) to be the name
3714 of the plugin. Everything after the first colon is ignored by the File daemon but
3715 is passed to the plugin. Thus the plugin writer may define the meaning of the
3716 rest of the string as he wishes.
3718 Please see the next section for information about the {\bf bpipe} Bacula
3721 \subsection{The bpipe Plugin}
3722 \index[general]{The bpipe Plugin}
3723 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
3724 the Bacula source distribution. When the plugin is compiled and linking into
3725 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
3726 Please note that this is a very simple plugin that was written for
3727 demonstration and test purposes. It is and can be used in production, but
3728 that was never really intended.
3730 The purpose of the plugin is to provide an interface to any system program for
3731 backup and restore. As specified above the {\bf bpipe} plugin is specified in
3732 the Include section of your Job's FileSet resource. The full syntax of the
3733 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
3734 to specify the sytax as it wishes) is:
3737 Plugin = "<field1>:<field2>:<field3>:<field4>"
3742 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
3743 stripped off, so in this case, we would put {\bf bpipe} in this field.
3745 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
3746 pseudo path and filename under which the backup will be saved. This pseudo
3747 path and filename will be seen by the user in the restore file tree.
3748 For example, if the value is {\bf /MYSQL/regress.sql}, the data
3749 backed up by the plugin will be put under that "pseudo" path and filename.
3750 You must be careful to choose a naming convention that is unique to avoid
3751 a conflict with a path and filename that actually exists on your system.
3753 \item {\bf field3} for the {\bf bpipe} plugin
3754 specifies the "reader" program that is called by the plugin during
3755 backup to read the data. {\bf bpipe} will call this program by doing a
3758 \item {\bf field4} for the {\bf bpipe} plugin
3759 specifies the "writer" program that is called by the plugin during
3760 restore to write the data back to the filesystem.
3763 Please note that for two items above describing the "reader" and "writer"
3764 fields, these programs are "executed" by Bacula, which
3765 means there is no shell interpretation of any command line arguments
3766 you might use. If you want to use shell characters (redirection of input
3767 or output, ...), then we recommend that you put your command or commands
3768 in a shell script and execute the script. In addition if you backup a
3769 file with the reader program, when running the writer program during
3770 the restore, Bacula will not automatically create the path to the file.
3771 Either the path must exist, or you must explicitly do so with your command
3772 or in a shell script.
3774 Putting it all together, the full plugin directive line might look
3778 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
3779 --opt --databases bacula:mysql"
3782 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
3783 would be written on a single line.
3785 This causes the File daemon to call the {\bf bpipe} plugin, which will write
3786 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
3787 program {\bf mysqldump -f --opt --database bacula} to read the data during
3788 backup. The mysqldump command outputs all the data for the database named
3789 {\bf bacula}, which will be read by the plugin and stored in the backup.
3790 During restore, the data that was backed up will be sent to the program
3791 specified in the last field, which in this case is {\bf mysql}. When
3792 {\bf mysql} is called, it will read the data sent to it by the plugn
3793 then write it back to the same database from which it came ({\bf bacula}
3796 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
3797 the data from a specified program to Bacula for backup, and then from Bacula to
3798 a specified program for restore.
3800 By using different command lines to {\bf bpipe},
3801 you can backup any kind of data (ASCII or binary) depending
3802 on the program called.
3804 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
3805 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
3806 \subsubsection{Background}
3807 The Exchange plugin was made possible by a funded development project
3808 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
3809 The code for the plugin was written by James Harper, and the Bacula core
3810 code by Kern Sibbald. All the code for this funded development has become
3811 part of the Bacula project. Thanks to everyone who made it happen.
3813 \subsubsection{Concepts}
3814 Although it is possible to backup Exchange using Bacula VSS the Exchange
3815 plugin adds a good deal of functionality, because while Bacula VSS
3816 completes a full backup (snapshot) of Exchange, it does
3817 not support Incremental or Differential backups, restoring is more
3818 complicated, and a single database restore is not possible.
3820 Microsoft Exchange organises its storage into Storage Groups with
3821 Databases inside them. A default installation of Exchange will have a
3822 single Storage Group called 'First Storage Group', with two Databases
3823 inside it, "Mailbox Store (SERVER NAME)" and
3824 "Public Folder Store (SERVER NAME)",
3825 which hold user email and public folders respectively.
3827 In the default configuration, Exchange logs everything that happens to
3828 log files, such that if you have a backup, and all the log files since,
3829 you can restore to the present time. Each Storage Group has its own set
3830 of log files and operates independently of any other Storage Groups. At
3831 the Storage Group level, the logging can be turned off by enabling a
3832 function called "Enable circular logging". At this time the Exchange
3833 plugin will not function if this option is enabled.
3835 The plugin allows backing up of entire storage groups, and the restoring
3836 of entire storage groups or individual databases. Backing up and
3837 restoring at the individual mailbox or email item is not supported but
3838 can be simulated by use of the "Recovery" Storage Group (see below).
3840 \subsubsection{Installing}
3841 The Exchange plugin requires a DLL that is shipped with Microsoft
3842 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
3843 correctly the Exchange plugin should find this automatically and run
3844 without any additional installation.
3846 If the DLL can not be found automatically it will need to be copied into
3847 the Bacula installation
3848 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
3849 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
3850 default Exchange installation.
3852 \subsubsection{Backing Up}
3853 To back up an Exchange server the Fileset definition must contain at
3854 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
3855 the backup to work correctly. The 'exchange:' bit tells Bacula to look
3856 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
3857 up files are prefixed with something that isn't going to share a name
3858 with something outside the plugin, and the 'Microsoft Information Store'
3859 bit is required also. It is also possible to add the name of a storage
3860 group to the "Plugin =" line, eg \\
3861 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
3862 if you want only a single storage group backed up.
3864 Additionally, you can suffix the 'Plugin =' directive with
3865 ":notrunconfull" which will tell the plugin not to truncate the Exchange
3866 database at the end of a full backup.
3868 An Incremental or Differential backup will backup only the database logs
3869 for each Storage Group by inspecting the "modified date" on each
3870 physical log file. Because of the way the Exchange API works, the last
3871 logfile backed up on each backup will always be backed up by the next
3872 Incremental or Differential backup too. This adds 5MB to each
3873 Incremental or Differential backup size but otherwise does not cause any
3876 By default, a normal VSS fileset containing all the drive letters will
3877 also back up the Exchange databases using VSS. This will interfere with
3878 the plugin and Exchange's shared ideas of when the last full backup was
3879 done, and may also truncate log files incorrectly. It is important,
3880 therefore, that the Exchange database files be excluded from the backup,
3881 although the folders the files are in should be included, or they will
3882 have to be recreated manually if a bare metal restore is done.
3887 File = C:/Program Files/Exchsrvr/mdbdata
3888 Plugin = "exchange:..."
3891 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
3892 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
3893 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
3894 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
3895 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
3896 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
3897 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
3902 The advantage of excluding the above files is that you can significantly
3903 reduce the size of your backup since all the important Exchange files
3904 will be properly saved by the Plugin.
3907 \subsubsection{Restoring}
3908 The restore operation is much the same as a normal Bacula restore, with
3909 the following provisos:
3912 \item The {\bf Where} restore option must not be specified
3913 \item Each Database directory must be marked as a whole. You cannot just
3914 select (say) the .edb file and not the others.
3915 \item If a Storage Group is restored, the directory of the Storage Group
3917 \item It is possible to restore only a subset of the available log files,
3918 but they {\bf must} be contiguous. Exchange will fail to restore correctly
3919 if a log file is missing from the sequence of log files
3920 \item Each database to be restored must be dismounted and marked as "Can be
3921 overwritten by restore"
3922 \item If an entire Storage Group is to be restored (eg all databases and
3923 logs in the Storage Group), then it is best to manually delete the
3924 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
3925 as Exchange can get confused by stray log files lying around.
3928 \subsubsection{Restoring to the Recovery Storage Group}
3929 The concept of the Recovery Storage Group is well documented by
3931 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
3932 but to briefly summarize...
3934 Microsoft Exchange allows the creation of an additional Storage Group
3935 called the Recovery Storage Group, which is used to restore an older
3936 copy of a database (e.g. before a mailbox was deleted) into without
3937 messing with the current live data. This is required as the Standard and
3938 Small Business Server versions of Exchange can not ordinarily have more
3939 than one Storage Group.
3941 To create the Recovery Storage Group, drill down to the Server in Exchange
3942 System Manager, right click, and select
3943 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
3944 locations and click OK. On the Recovery Storage Group, right click and
3945 select {\bf "Add Database to Recover..."} and select the database you will
3948 Restore only the single database nominated as the database in the
3949 Recovery Storage Group. Exchange will redirect the restore to the
3950 Recovery Storage Group automatically.
3951 Then run the restore.
3953 \subsubsection{Restoring on Microsoft Server 2007}
3954 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
3955 2007, and hence you use a new procedure for recovering a single mail box.
3956 This procedure is documented by Microsoft at:
3957 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
3958 and involves using the {\bf Restore-Mailbox} and {\bf
3959 Get-Mailbox Statistics} shell commands.
3961 \subsubsection{Caveats}
3962 This plugin is still being developed, so you should consider it
3963 currently in BETA test, and thus use in a production environment
3964 should be done only after very careful testing.
3966 When doing a full backup, the Exchange database logs are truncated by
3967 Exchange as soon as the plugin has completed the backup. If the data
3968 never makes it to the backup medium (eg because of spooling) then the
3969 logs will still be truncated, but they will also not have been backed
3970 up. A solution to this is being worked on. You will have to schedule a
3971 new Full backup to ensure that your next backups will be usable.
3973 The "Enable Circular Logging" option cannot be enabled or the plugin
3976 Exchange insists that a successful Full backup must have taken place if
3977 an Incremental or Differential backup is desired, and the plugin will
3978 fail if this is not the case. If a restore is done, Exchange will
3979 require that a Full backup be done before an Incremental or Differential
3982 The plugin will most likely not work well if another backup application
3983 (eg NTBACKUP) is backing up the Exchange database, especially if the
3984 other backup application is truncating the log files.
3986 The Exchange plugin has not been tested with the {\bf Accurate} option, so
3987 we recommend either carefully testing or that you avoid this option for
3990 The Exchange plugin is not called during processing the bconsole {\bf
3991 estimate} command, and so anything that would be backed up by the plugin
3992 will not be added to the estimate total that is displayed.
3995 \subsection{libdbi Framework}
3996 \index[general]{libdbi Framework}
3997 As a general guideline, Bacula has support for a few catalog database drivers
3998 (MySQL, PostgreSQL, SQLite)
3999 coded natively by the Bacula team. With the libdbi implementation, which is a
4000 Bacula driver that uses libdbi to access the catalog, we have an open field to
4001 use many different kinds database engines following the needs of users.
4003 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
4004 implements a database-independent abstraction layer in C, similar to the
4005 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
4006 leverage the power of multiple databases and multiple simultaneous database
4007 connections by using this framework.
4009 Currently the libdbi driver in Bacula project only supports the same drivers
4010 natively coded in Bacula. However the libdbi project has support for many
4011 others database engines. You can view the list at
4012 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
4013 supported by Bacula, however, they must be tested properly by the Bacula team.
4015 Some of benefits of using libdbi are:
4017 \item The possibility to use proprietary databases engines in which your
4018 proprietary licenses prevent the Bacula team from developing the driver.
4019 \item The possibility to use the drivers written for the libdbi project.
4020 \item The possibility to use other database engines without recompiling Bacula
4021 to use them. Just change one line in bacula-dir.conf
4022 \item Abstract Database access, this is, unique point to code and profiling
4023 catalog database access.
4026 The following drivers have been tested:
4028 \item PostgreSQL, with and without batch insert
4029 \item Mysql, with and without batch insert
4034 In the future, we will test and approve to use others databases engines
4035 (proprietary or not) like DB2, Oracle, Microsoft SQL.
4037 To compile Bacula to support libdbi we need to configure the code with the
4038 --with-dbi and --with-dbi-driver=[database] ./configure options, where
4039 [database] is the database engine to be used with Bacula (of course we can
4040 change the driver in file bacula-dir.conf, see below). We must configure the
4041 access port of the database engine with the option --with-db-port, because the
4042 libdbi framework doesn't know the default access port of each database.
4044 The next phase is checking (or configuring) the bacula-dir.conf, example:
4048 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
4049 dbname = regress; user = regress; password = ""
4053 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
4054 mysql database. Currently the drivers supported by Bacula are: postgresql,
4055 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
4057 The following limitations apply when Bacula is set to use the libdbi framework:
4058 - Not tested on the Win32 platform
4059 - A little performance is lost if comparing with native database driver.
4060 The reason is bound with the database driver provided by libdbi and the
4061 simple fact that one more layer of code was added.
4063 It is important to remember, when compiling Bacula with libdbi, the
4064 following packages are needed:
4066 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
4067 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
4070 You can download them and compile them on your system or install the packages
4071 from your OS distribution.
4073 \subsection{Console Command Additions and Enhancements}
4074 \index[general]{Console Additions}
4076 \subsubsection{Display Autochanger Content}
4077 \index[general]{StatusSlots}
4079 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
4080 autochanger content.
4084 Slot | Volume Name | Status | Media Type | Pool |
4085 ------+---------------+----------+-------------------+------------|
4086 1 | 00001 | Append | DiskChangerMedia | Default |
4087 2 | 00002 | Append | DiskChangerMedia | Default |
4088 3*| 00003 | Append | DiskChangerMedia | Scratch |
4093 If you an asterisk ({\bf *}) appears after the slot number, you must run an
4094 {\bf update slots} command to synchronize autochanger content with your
4097 \subsubsection{list joblog job=xxx or jobid=nnn}
4098 \index[general]{list joblog}
4099 A new list command has been added that allows you to list the contents
4100 of the Job Log stored in the catalog for either a Job Name (fully qualified)
4101 or for a particular JobId. The {\bf llist} command will include a line with
4102 the time and date of the entry.
4104 Note for the catalog to have Job Log entries, you must have a directive
4111 In your Director's {\bf Messages} resource.
4113 \subsubsection{Use separator for multiple commands}
4114 \index[general]{Command Separator}
4115 When using bconsole with readline, you can set the command separator with
4116 \textbf{@separator} command to one
4117 of those characters to write commands who require multiple input in one line.
4119 !$%&'()*+,-/:;<>?[]^`{|}~
4122 \subsubsection{Deleting Volumes}
4123 The delete volume bconsole command has been modified to
4124 require an asterisk (*) in front of a MediaId otherwise the
4125 value you enter is a taken to be a Volume name. This is so that
4126 users may delete numeric Volume names. The previous Bacula versions
4127 assumed that all input that started with a number was a MediaId.
4129 This new behavior is indicated in the prompt if you read it
4132 \subsection{Bare Metal Recovery}
4133 The old bare metal recovery project is essentially dead. One
4134 of the main features of it was that it would build a recovery
4135 CD based on the kernel on your system. The problem was that
4136 every distribution has a different boot procedure and different
4137 scripts, and worse yet, the boot procedures and scripts change
4138 from one distribution to another. This meant that maintaining
4139 (keeping up with the changes) the rescue CD was too much work.
4141 To replace it, a new bare metal recovery USB boot stick has been developed
4142 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
4143 boot from a USB key.
4147 \item Recovery can be done from within graphical environment.
4148 \item Recovery can be done in a shell.
4149 \item Ubuntu boots on a large number of Linux systems.
4150 \item The process of updating the system and adding new
4151 packages is not too difficult.
4152 \item The USB key can easily be upgraded to newer Ubuntu versions.
4153 \item The USB key has writable partitions for modifications to
4154 the OS and for modification to your home directory.
4155 \item You can add new files/directories to the USB key very easily.
4156 \item You can save the environment from multiple machines on
4158 \item Bacula Systems is funding its ongoing development.
4161 The disadvantages are:
4163 \item The USB key is usable but currently under development.
4164 \item Not everyone may be familiar with Ubuntu (no worse
4166 \item Some older OSes cannot be booted from USB. This can
4167 be resolved by first booting a Ubuntu LiveCD then plugging
4169 \item Currently the documentation is sketchy and not yet added
4170 to the main manual. See below ...
4173 The documentation and the code can be found in the {\bf rescue} package
4174 in the directory {\bf linux/usb}.
4176 \subsection{Miscellaneous}
4177 \index[general]{Misc New Features}
4179 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
4180 \index[general]{Allow Mixed Priority}
4181 This directive is only implemented in version 2.5 and later. When
4182 set to {\bf yes} (default {\bf no}), this job may run even if lower
4183 priority jobs are already running. This means a high priority job
4184 will not have to wait for other jobs to finish before starting.
4185 The scheduler will only mix priorities when all running jobs have
4188 Note that only higher priority jobs will start early. Suppose the
4189 director will allow two concurrent jobs, and that two jobs with
4190 priority 10 are running, with two more in the queue. If a job with
4191 priority 5 is added to the queue, it will be run as soon as one of
4192 the running jobs finishes. However, new priority 10 jobs will not
4193 be run until the priority 5 job has finished.
4195 \subsubsection{Bootstrap File Directive -- FileRegex}
4196 \index[general]{Bootstrap File Directive}
4197 {\bf FileRegex} is a new command that can be added to the bootstrap
4198 (.bsr) file. The value is a regular expression. When specified, only
4199 matching filenames will be restored.
4201 During a restore, if all File records are pruned from the catalog
4202 for a Job, normally Bacula can restore only all files saved. That
4203 is there is no way using the catalog to select individual files.
4204 With this new feature, Bacula will ask if you want to specify a Regex
4205 expression for extracting only a part of the full backup.
4208 Building directory tree for JobId(s) 1,3 ...
4209 There were no files inserted into the tree, so file selection
4210 is not possible.Most likely your retention policy pruned the files
4212 Do you want to restore all the files? (yes\vb{}no): no
4214 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
4215 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
4218 \subsubsection{Bootstrap File Optimization Changes}
4219 In order to permit proper seeking on disk files, we have extended the bootstrap
4220 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
4221 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
4222 address range and end address range respectively. These two directives replace
4223 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
4224 VolEndBlock} directives. Bootstrap files containing the old directives will
4225 still work, but will not properly take advantage of proper disk seeking, and
4226 may read completely to the end of a disk volume during a restore. With the new
4227 format (automatically generated by the new Director), restores will seek
4228 properly and stop reading the volume when all the files have been restored.
4230 \subsubsection{Solaris ZFS/NFSv4 ACLs}
4231 This is an upgrade of the previous Solaris ACL backup code
4232 to the new library format, which will backup both the old
4233 POSIX(UFS) ACLs as well as the ZFS ACLs.
4235 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
4236 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
4237 be used to transfer from UFS to ZFS filesystems.
4240 \subsubsection{Virtual Tape Emulation}
4241 \index[general]{Virtual Tape Emulation}
4242 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
4243 the tape code but actually reading and writing to a disk file. Used with the
4244 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
4245 and 700 slots. This feature is most useful in testing. It is enabled
4246 by using {\bf Device Type = vtape} in the Storage daemon's Device
4247 directive. This feature is only implemented on Linux machines and should not be
4248 used for production.
4250 \subsubsection{Bat Enhancements}
4251 \index[general]{Bat Enhancements}
4252 Bat (the Bacula Administration Tool) GUI program has been significantly
4253 enhanced and stabilized. In particular, there are new table based status
4254 commands; it can now be easily localized using Qt4 Linguist.
4256 The Bat communications protocol has been significantly enhanced to improve
4257 GUI handling. Note, you {\bf must} use a the bat that is distributed with
4258 the Director you are using otherwise the communications protocol will not
4261 \subsubsection{RunScript Enhancements}
4262 \index[general]{RunScript Enhancements}
4263 The {\bf RunScript} resource has been enhanced to permit multiple
4264 commands per RunScript. Simply specify multiple {\bf Command} directives
4271 Command = "/bin/echo test"
4272 Command = "/bin/echo an other test"
4273 Command = "/bin/echo 3 commands in the same runscript"
4280 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
4281 implemented, which runs the command after the Volume Shadow Copy has been made.
4283 Console commands can be specified within a RunScript by using:
4284 {\bf Console = \lt{}command\gt{}}, however, this command has not been
4285 carefully tested and debugged and is known to easily crash the Director.
4286 We would appreciate feedback. Due to the recursive nature of this command, we
4287 may remove it before the final release.
4289 \subsubsection{Status Enhancements}
4290 \index[general]{Status Enhancements}
4291 The bconsole {\bf status dir} output has been enhanced to indicate
4292 Storage daemon job spooling and despooling activity.
4294 \subsubsection{Connect Timeout}
4295 \index[general]{Connect Timeout}
4296 The default connect timeout to the File
4297 daemon has been set to 3 minutes. Previously it was 30 minutes.
4299 \subsubsection{ftruncate for NFS Volumes}
4300 \index[general]{ftruncate for NFS Volumes}
4301 If you write to a Volume mounted by NFS (say on a local file server),
4302 in previous Bacula versions, when the Volume was recycled, it was not
4303 properly truncated because NFS does not implement ftruncate (file
4304 truncate). This is now corrected in the new version because we have
4305 written code (actually a kind user) that deletes and recreates the Volume,
4306 thus accomplishing the same thing as a truncate.
4308 \subsubsection{Support for Ubuntu}
4309 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
4310 version of Linux, and thus now provides correct autostart routines.
4311 Since Ubuntu officially supports Bacula, you can also obtain any
4312 recent release of Bacula from the Ubuntu repositories.
4314 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
4315 \index[general]{Recycle Pool}
4316 The new \textbf{RecyclePool} directive defines to which pool the Volume will
4317 be placed (moved) when it is recycled. Without this directive, a Volume will
4318 remain in the same pool when it is recycled. With this directive, it can be
4319 moved automatically to any existing pool during a recycle. This directive is
4320 probably most useful when defined in the Scratch pool, so that volumes will
4321 be recycled back into the Scratch pool.
4323 \subsubsection{FD Version}
4324 \index[general]{FD Version}
4325 The File daemon to Director protocol now includes a version
4326 number, which although there is no visible change for users,
4327 will help us in future versions automatically determine
4328 if a File daemon is not compatible.
4330 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
4331 \index[general]{Max Run Sched Time}
4332 The time specifies the maximum allowed time that a job may run, counted from
4333 when the job was scheduled. This can be useful to prevent jobs from running
4334 during working hours. We can see it like \texttt{Max Start Delay + Max Run
4337 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
4338 \index[general]{Max Wait Time}
4339 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
4340 of checking the maximum allowed time that a job may block for a resource,
4341 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
4342 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
4343 their job depending on the level. Now, they have to use
4344 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
4345 directives are now deprecated.
4347 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
4348 \index[general]{Incremental Max Wait Time}
4349 \index[general]{Differential Max Wait Time}
4351 These directives have been deprecated in favor of
4352 \texttt{Incremental|Differential Max Run Time}.
4354 \subsubsection{Max Run Time directives}
4355 \index[general]{Max Run Time directives}
4356 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
4357 maximum allowed time that a job can run depending on the level.
4359 \addcontentsline{lof}{figure}{Job time control directives}
4361 \includegraphics[width=\linewidth]{different_time}
4364 \subsubsection{Statistics Enhancements}
4365 \index[general]{Statistics Enhancements}
4366 If you (or probably your boss) want to have statistics on your backups to
4367 provide some \textit{Service Level Agreement} indicators, you could use a few
4368 SQL queries on the Job table to report how many:
4372 \item jobs have been successful
4373 \item files have been backed up
4377 However, these statistics are accurate only if your job retention is greater
4378 than your statistics period. Ie, if jobs are purged from the catalog, you won't
4379 be able to use them.
4381 Now, you can use the \textbf{update stats [days=num]} console command to fill
4382 the JobHistory table with new Job records. If you want to be sure to take in
4383 account only \textbf{good jobs}, ie if one of your important job has failed but
4384 you have fixed the problem and restarted it on time, you probably want to
4385 delete the first \textit{bad} job record and keep only the successful one. For
4386 that simply let your staff do the job, and update JobHistory table after two or
4387 three days depending on your organization using the \textbf{[days=num]} option.
4389 These statistics records aren't used for restoring, but mainly for
4390 capacity planning, billings, etc.
4392 The Bweb interface provides a statistics module that can use this feature. You
4393 can also use tools like Talend or extract information by yourself.
4395 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
4396 the length of time that Bacula will keep statistics job records in the Catalog
4397 database after the Job End time. (In \texttt{JobHistory} table) When this time
4398 period expires, and if user runs \texttt{prune stats} command, Bacula will
4399 prune (remove) Job records that are older than the specified period.
4401 You can use the following Job resource in your nightly \textbf{BackupCatalog}
4402 job to maintain statistics.
4405 Name = BackupCatalog
4408 Console = "update stats days=3"
4409 Console = "prune stats yes"
4416 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
4417 \index[general]{ScratchPool}
4418 This directive permits to specify a specific \textsl{Scratch} pool for the
4419 current pool. This is useful when using multiple storage sharing the same
4420 mediatype or when you want to dedicate volumes to a particular set of pool.
4422 \subsubsection{Enhanced Attribute Despooling}
4423 \index[general]{Attribute Despooling}
4424 If the storage daemon and the Director are on the same machine, the spool file
4425 that contains attributes is read directly by the Director instead of being
4426 transmitted across the network. That should reduce load and speedup insertion.
4428 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
4429 \index[general]{SpoolSize}
4430 A new Job directive permits to specify the spool size per job. This is used
4431 in advanced job tunning. {\bf SpoolSize={\it bytes}}
4433 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
4434 \index[general]{MaximumConsoleConnections}
4435 A new director directive permits to specify the maximum number of Console
4436 Connections that could run concurrently. The default is set to 20, but you may
4437 set it to a larger number.
4439 \subsubsection{VerId = \lt{}string\gt{}}
4440 \index[general]{VerId}
4441 A new director directive permits to specify a personnal identifier that will be
4442 displayed in the \texttt{version} command.
4444 \subsubsection{dbcheck enhancements}
4445 \index[general]{dbcheck enhancements}
4446 If you are using Mysql, dbcheck will now ask you if you want to create
4447 temporary indexes to speed up orphaned Path and Filename elimination.
4449 A new \texttt{-B} option allows you to print catalog information in a simple
4450 text based format. This is useful to backup it in a secure way.
4465 You can now specify the database connection port in the command line.
4467 \subsubsection{{-}{-}docdir configure option}
4468 \index[general]{{-}{-}docdir configure option}
4469 You can use {-}{-}docdir= on the ./configure command to
4470 specify the directory where you want Bacula to install the
4471 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
4472 {\bf /usr/share/doc/bacula}.
4474 \subsubsection{{-}{-}htmldir configure option}
4475 \index[general]{{-}{-}htmldir configure option}
4476 You can use {-}{-}htmldir= on the ./configure command to
4477 specify the directory where you want Bacula to install the bat html help
4478 files. The default is {\bf /usr/share/doc/bacula/html}
4480 \subsubsection{{-}{-}with-plugindir configure option}
4481 \index[general]{{-}{-}plugindir configure option}
4482 You can use {-}{-}plugindir= on the ./configure command to
4483 specify the directory where you want Bacula to install
4484 the plugins (currently only bpipe-fd). The default is