Subsections

- New Features in 7.0.0
  - Storage daemon to Storage daemon
  - SD Calls Client
  - Next Pool
  - status storage
  - status schedule
  - Data Encryption Cipher Configuration
  - New Truncate Command
  - Migration/Copy/VirtualFull Performance Enhancements
  - VirtualFull Backup Consolidation Enhancements
  - FD Storage Address
  - Job Bandwidth Limitation
  - Maximum Concurrent Read Jobs
  - Director job Codes in Message Resource Commands
  - Additions to RunScript variables
  - Read Only Storage Devices
  - New Prune ``Expired'' Volume Command
  - Hardlink Performance Enhancements
  - DisableCommand Directive
  - Multiple Console Directors
  - Restricted Consoles
  - Configuration Files
  - Maximum Spawned Jobs
  - Progress Meter
  - Scheduling a 6th Week
  - Scheduling the Last Day of a Month
  - Improvements to Cancel and Restart bconsole Commands
  - bconsole Performance Improvements
  - New .bvfs_decode_lstat Command
  - New Debug Options

# New Features in 7.0.0

This chapter presents the new features that have been added to the various versions of Bacula.

# New Features in 7.0.0

## Storage daemon to Storage daemon

Bacula version 7.0 permits SD to SD transfer of Copy and Migration Jobs. This permits what is commonly referred to as replication or off-site transfer of Bacula backups. It occurs automatically, if the source SD and destination SD of a Copy or Migration job are different. The following picture shows how this works.

## SD Calls Client

If the SD Calls Client directive is set to true in a Client resource any Backup, Restore, Verify, Copy, or Migration Job where the client is involved, the client will wait for the Storage daemon to contact it. By default this directive is set to false, and the Client will call the Storage daemon. This directive can be useful if your Storage daemon is behind a firewall that permits outgoing connections but not incoming one. The following picture shows the communications connection paths in both cases.

## Next Pool

In previous versions of Bacula the Next Pool directive could be specified in the Pool resource for use with Migration and Copy Jobs. The Next Pool concept has been extended in Bacula version 7.0.0 to allow you to specify the Next Pool directive in the Job resource as well. If specified in the Job resource, it will override any value specified in the Pool resource.

In addition to being permitted in the Job resource, the nextpool=xxx specification can be specified as a run override in the run directive of a Schedule resource. Any nextpool specification in a run directive will override any other specification in either the Job or the Pool.

In general, more information is displayed in the Job log on exactly which Next Pool specification is ultimately used.

## status storage

The bconsole status storage has been modified to attempt to eliminate duplicate storage resources and only show one that references any given storage daemon. This might be confusing at first, but tends to make a much more compact list of storage resource from which to select if there are multiple storage devices in the same storage daemon.

If you want the old behavior (always display all storage resources) simply add the keyword select to the command - i.e. use status select storage.

## status schedule

A new status command option called scheduled has been implemented in bconsole. By default it will display 20 lines of the next scheduled jobs. For example, with the default bacula-dir.conf configuration file, a bconsole command status scheduled produces:

    Scheduled Jobs:
    Level        Type   Pri  Scheduled        Job Name     Schedule
    ======================================================================
    Differential Backup 10  Sun 30-Mar 23:05 BackupClient1 WeeklyCycle
    Incremental  Backup 10  Mon 24-Mar 23:05 BackupClient1 WeeklyCycle
    Incremental  Backup 10  Tue 25-Mar 23:05 BackupClient1 WeeklyCycle
    ...
    Full         Backup 11  Mon 24-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
    Full         Backup 11  Wed 26-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
    ...
    ====

Note, the output is listed by the Jobs found, and is not sorted chronologically.

This command has a number of options, most of which act as filters:

- days=nn This specifies the number of days to list. The default is 10 but can be set from 0 to 500.
- limit=nn This specifies the limit to the number of lines to print. The default is 100 but can be any number in the range 0 to 2000.
- time="YYYY-MM-DD HH:MM:SS" Sets the start time for listing the scheduled jobs. The default is to use the current time. Note, the time value must be specified inside double quotes and must be in the exact form shown above.
- schedule=schedule-name This option restricts the output to the named schedule.
- job=job-name This option restricts the output to the specified Job name.

## Data Encryption Cipher Configuration

Bacula version 7.0 and later now allows to configure the data encryption cipher and the digest algorithm. The cipher was forced to AES 128, and it is now possible to choose between the following ciphers:

- AES128 (default)
- AES192
- AES256
- blowfish

The digest algorithm was set to SHA1 or SHA256 depending on the local OpenSSL options. We advise you to not modify the PkiDigest default setting. Please, refer to OpenSSL documentation to know about pro and cons on these options.

      FileDaemon {
        ...
        PkiCipher = AES256
      }

## New Truncate Command

We have added a new truncate command to bconsole, which will truncate a Volume if the Volume is purged and if the Volume is also marked Action On Purge = Truncate. This feature was originally added in Bacula version 5.0.1, but the mechanism for actually doing the truncate required the user to enter a command such as:

    purge volume action=truncate storage=File pool=Default

The above command is now simplified to be:

    truncate storage=File pool=Default

## Migration/Copy/VirtualFull Performance Enhancements

The Bacula Storage daemon now permits multiple jobs to simultaneously read the same disk Volume, which gives substantial performance enhancements when running Migration, Copy, or VirtualFull jobs that read disk Volumes. Our testing shows that when running multiple simultaneous jobs, the jobs can finish up to ten times faster with this version of Bacula. This is built-in to the Storage daemon, so it happens automatically and transparently.

## VirtualFull Backup Consolidation Enhancements

By default Bacula selects jobs automatically for a VirtualFull, however, you may want to create the Virtual backup based on a particular backup (point in time) that exists.

For example, if you have the following backup Jobs in your catalog:

    +-------+---------+-------+----------+----------+-----------+
    | JobId | Name    | Level | JobFiles | JobBytes | JobStatus |
    +-------+---------+-------+----------+----------+-----------+
    | 1     | Vbackup | F     | 1754     | 50118554 | T         |
    | 2     | Vbackup | I     | 1        | 4        | T         |
    | 3     | Vbackup | I     | 1        | 4        | T         |
    | 4     | Vbackup | D     | 2        | 8        | T         |
    | 5     | Vbackup | I     | 1        | 6        | T         |
    | 6     | Vbackup | I     | 10       | 60       | T         |
    | 7     | Vbackup | I     | 11       | 65       | T         |
    | 8     | Save    | F     | 1758     | 50118564 | T         |
    +-------+---------+-------+----------+----------+-----------+

and you want to consolidate only the first 3 jobs and create a virtual backup equivalent to Job 1 + Job 2 + Job 3, you will use `jobid=3` in the `run` command, then Bacula will select the previous Full backup, the previous Differential (if any) and all subsequent Incremental jobs.

    run job=Vbackup jobid=3 level=VirtualFull

If you want to consolidate a specific job list, you must specify the exact list of jobs to merge in the run command line. For example, to consolidate the last Differential and all subsequent Incremental, you will use `jobid=4,5,6,7` or `jobid=4-7` on the run command line. As one of the Job in the list is a Differential backup, Bacula will set the new job level to Differential. If the list is composed only with Incremental jobs, the new job will have a level set to Incremental.

    run job=Vbackup jobid=4-7 level=VirtualFull

When using this feature, Bacula will automatically discard jobs that are not related to the current Job. For example, specifying `jobid=7,8`, Bacula will discard JobId 8 because it is not part of the same backup Job.

We do not recommend it, but really want to consolidate jobs that have different names (so probably different clients, filesets, etc...), you must use `alljobid=` keyword instead of `jobid=`.

    run job=Vbackup alljobid=1-3,6-8 level=VirtualFull

## FD Storage Address

When the Director is behind a NAT, in a WAN area, to connect tothe StorageDaemon, the Director uses an ``external'' ip address, and the FileDaemon should use an ``internal'' IP address to contact the StorageDaemon.

The normal way to handle this situation is to use a canonical name such as ``storage-server'' that will be resolved on the Director side as the WAN address and on the Client side as the LAN address. This is now possible to configure this parameter using the new directive `FDStorageAddress` in the Storage or Client resource.

    Storage {
         Name = storage1
         Address = 65.1.1.1
         FD Storage Address = 10.0.0.1
         SD Port = 9103
         ...
    }

     Client {
          Name = client1
          Address = 65.1.1.2
          FD Storage Address = 10.0.0.1
          FD Port = 9102
          ...
     }

Note that using the Client `FDStorageAddress` directive will not allow to use multiple Storage Daemon, all Backup or Restore requests will be sent to the specified `FDStorageAddress`.

## Job Bandwidth Limitation

The new Job Bandwidth Limitation directive may be added to the File daemon's and/or Director's configuration to limit the bandwidth used by a Job on a Client. It can be set in the File daemon's conf file for all Jobs run in that File daemon, or it can be set for each Job in the Director's conf file. The speed is always specified in bytes per second.

For example:

    FileDaemon {
      Name = localhost-fd
      Working Directory = /some/path
      Pid Directory = /some/path
      ...
      Maximum Bandwidth Per Job = 5Mb/s
    }

The above example would cause any jobs running with the FileDaemon to not exceed 5 megabytes per second of throughput when sending data to the Storage Daemon. Note, the speed is always specified in bytes per second (not in bits per second), and the case (upper/lower) of the specification characters is ignored (i.e. 1MB/s = 1Mb/s).

You may specify the following speed parameter modifiers: k/s (1,000 bytes per second), kb/s (1,024 bytes per second), m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).

For example:

    Job {
      Name = locahost-data
      FileSet = FS_localhost
      Accurate = yes
      ...
      Maximum Bandwidth = 5Mb/s
      ...
    }

The above example would cause Job `localhost-data` to not exceed 5MB/s of throughput when sending data from the File daemon to the Storage daemon.

A new console command `setbandwidth` permits to set dynamically the maximum throughput of a running Job or for future jobs of a Client.

    * setbandwidth limit=1000 jobid=10

Please note that the value specified for the `limit` command line parameter is always in units of 1024 bytes (i.e. the number is multiplied by 1024 to give the number of bytes per second). As a consequence, the above limit of 1000 will be interpreted as a limit of 1000 * 1024 = 1,024,000 bytes per second.

This project was funded by Bacula Systems.

## Maximum Concurrent Read Jobs

This is a new directive that can be used in the bacula-dir.conf file in the Storage resource. The main purpose is to limit the number of concurrent Copy, Migration, and VirtualFull jobs so that they don't monopolize all the Storage drives causing a deadlock situation where all the drives are allocated for reading but none remain for writing. This deadlock situation can occur when running multiple simultaneous Copy, Migration, and VirtualFull jobs.

The default value is set to 0 (zero), which means there is no limit on the number of read jobs. Note, limiting the read jobs does not apply to Restore jobs, which are normally started by hand. A reasonable value for this directive is one half the number of drives that the Storage resource has rounded down. Doing so, will leave the same number of drives for writing and will generally avoid over committing drives and a deadlock.

## Director job Codes in Message Resource Commands

Before submitting the specified mail command to the operating system, Bacula performs character substitution like in Runscript commands. Bacula will now perform also specific Director character substitution.

The code for this feature was contributed by Bastian Friedrich.

## Additions to RunScript variables

The following variables are now available in runscripts:

- current PID using %P
- if the job is a clone job using %C

    RunAfterJob = "/bin/echo Pid=%P isCloned=%C"

## Read Only Storage Devices

This version of Bacula permits defining a Storage daemon device to be read-only. That is if the ReadOnly directive is specified and enabled, the drive can only be used for read operations. The the ReadOnly directive can be defined in any bacula-sd.conf Device resource, and is most useful to reserve one or more drives for restores. An example is:

    Read Only = yes

## New Prune ``Expired'' Volume Command

It is now possible to prune all volumes (from a pool, or globally) that are ``expired''. This option can be scheduled after or before the backup of the Catalog and can be combined with the Truncate On Purge option. The Expired Prune option can be used instead of the `manual_prune.pl` script.

    * prune expired volumes

    * prune expired volumes pool=FullPool

To schedule this option automatically, it can be added to the BackupCatalog job definition.

     Job {
       Name = CatalogBackup
       ...
       RunScript {
         Console = "prune expired volume yes"
         RunsWhen = Before
       }
     }

## Hardlink Performance Enhancements

If you use a program such as Cyrus IMAP that creates very large numbers of hardlinks, the time to build the interactive restore tree can be excessively long. This version of Bacula has a new feature that automatically keeps the hardlinks associated with the restore tree in memory, which consumes a bit more memory but vastly speeds up building the tree. If the memory usage is too big for your system, you can reduce the amount of memory used during the restore command by adding the option optimizespeed=false on the bconsole run command line.

This feature was developed by Josip Almasi, and enhanced to be runtime dynamic by Kern Sibbald.

## DisableCommand Directive

There is a new Directive named Disable Command that can be put in the File daemon Client or Director resource. If it is in the Client, it applies globally, otherwise the directive applies only to the Director in which it is found. The Disable Command adds security to your File daemon by disabling certain commands. The commands that can be disabled are:

    backup
    cancel
    setdebug=
    setbandwidth=
    estimate
    fileset
    JobId=
    level =
    restore
    endrestore
    session
    status
    .status
    storage
    verify
    RunBeforeNow
    RunBeforeJob
    RunAfterJob
    Run
    accurate

On or more of these command keywords can be placed in quotes and separated by spaces on the Disable Command directive line. Note: the commands must be written exactly as they appear above.

## Multiple Console Directors

Support for multiple bconsole and bat Directors in the bconsole.conf and bat.conf files has been implemented and/or improved.

## Restricted Consoles

Better support for Restricted consoles has been implement for bconsole and bat.

## Configuration Files

In previous versions of Bacula the configuration files for each component were limited to a maximum of 499 bytes per configuration file line. This version of Bacula permits unlimited input line lengths. This can be especially useful for specifying more complicated Migration/Copy SQL statements and in creating long restricted console ACL lists.

## Maximum Spawned Jobs

The Job resource now permits specifying a number of Maximum Spawned Jobs. The default is 600. This directive can be useful if you have big hardware and you do a lot of Migration/Copy jobs which start at the same time. In prior versions of Bacula, Migration/Copy was limited to spawning a maximum of 100 jobs at a time.

## Progress Meter

The new File daemon has been enhanced to send its progress (files processed and bytes written) to the Director every 30 seconds. These figures can then be displayed with a bconsole status dir command.

## Scheduling a 6th Week

Prior version of Bacula permits specifying 1st through 5th week of a month (first through fifth) as a keyword on the run directive of a Schedule resource. This version of Bacula also permits specifying the 6th week of a month with the keyword sixth or 6th.

## Scheduling the Last Day of a Month

This version of Bacula now permits specifying the lastday keyword in the run directive of a Schedule resource. If lastday is specified, it will apply only to those months specified on the run directive. Note: by default all months are specified.

## Improvements to Cancel and Restart bconsole Commands

The Restart bconsole command now allow selection of either canceled or failed jobs to be restarted. In addition both the cancel and restart bconsole commands permit entering a number of JobIds separated by commas or a range of JobIds indicated by a dash between the begin and end range (e.g. 3-10). Finally the two commands also allow one to enter the special keyword all to select all the appropriate Jobs.

## bconsole Performance Improvements

In previous versions of Bacula certain bconsole commands could wait a long time due to catalog lock contention. This was especially noticeable when a large number of jobs were running and putting their attributes into the catalog. This version uses a separate catalog connection that should significantly enhance performance.

## New .bvfs_decode_lstat Command

There is a new bconsole command, which is .bvfs_decode_lstat it requires one argument, which is lstat="lstat value to decode". An example command in bconsole and the output might be:

    .bvfs_decode_lstat lstat="A A EHt B A A A JP BAA B BTL/A7 BTL/A7 BTL/A7 A A C"

    st_nlink=1
    st_mode=16877
    st_uid=0
    st_gid=0
    st_size=591
    st_blocks=1
    st_ino=0
    st_ctime=1395650619
    st_mtime=1395650619
    st_mtime=1395650619
    st_dev=0
    LinkFI=0

## New Debug Options

In Bacula Enterprise version 8.0 and later, we introduced new options to the `setdebug` command.

If the `options` parameter is set, the following arguments can be used to control debug functions.

0
  clear debug flags
i
  Turn off, ignore bwrite() errors on restore on File Daemon
d
  Turn off decomp of BackupRead() streams on File Daemon
t
  Turn on timestamp in traces
T
  Turn off timestamp in traces
c
  Truncate trace file if trace file is activated
l
  Turn on recoding events on P() and V()
p
  Turn on the display of the event ring when doing a bactrace

The following command will truncate the trace file and will turn on timestamps in the trace file.

    * setdebug level=10 trace=1 options=ct fd

It is now possible to use class of debug messages called `tags` to control the debug output of Bacula daemons.

all
  Display all debug messages
bvfs
  Display BVFS debug messages
sql
  Display SQL related debug messages
memory
  Display memory and poolmem allocation messages
scheduler
  Display scheduler related debug messages

    * setdebug level=10 tags=bvfs,sql,memory
    * setdebug level=10 tags=!bvfs

    # bacula-dir -t -d 200,bvfs,sql

The `tags` option is composed of a list of tags, tags are separated by ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!'' in front of the tag. Note that more tags will come in future versions.