Client Resource
The Client Resource (or FileDaemon) resource defines the name of the Client (as used by the Director) as well as the port on which the Client listens for Director connections.
Client (or FileDaemon) Start of the Client records. There must be one and only one Client resource in the configuration file, since it defines the properties of the current client program.
The following is an example of a valid Client resource definition:
Client {
Name = rufus-fd
WorkingDirectory = $HOME/bacula/bin/working
PIDDirectory = $HOME/bacula/bin/working
}
Description: Must be used by the Director when connecting.
Value(s):
<name>Data Type: string
Required: Yes
Comment: Generally, it is a good idea to use a name related to the machine so that error messages can be easily identified if you have multiple Clients.
Description: Specifies a directory in which the File Daemon may put its status files.
Value(s):
<directory>Data Type: string
Required: Yes
Comment: This directory should be used only by Bacula, but may be shared by other daemons provided the daemon names on the definition are unique for each daemon.
Description: Specifies a directory in which the File Daemon may put its process Id file files. The process Id file is used to shutdown Bacula and to prevent multiple copies of from running simultaneously.
Value(s):
<directory>Data Type: string
Required: Yes
Comment: Standard shell expansion of the is done when the configuration file is read so that values such as $HOME will be properly expanded.
Typically on Linux systems, you will set this to: /var/run. If you are not installing Bacula in the system directories, you can use the Working Directory as defined above.
ClientRehydration = <Directory>
Allows to try to do rehydration using existing local data on the Client at restore time.
Value(s):
<directory>Data Type: string
Default: No
Comment: In some cases, the use of this directive permits to transfer less data over the network during a restore.
Description: Defines an interval of time in seconds. For each heartbeat that the File Daemon receives from the Storage Daemon, it will forward it to the Director. In addition, if no heartbeat has been received from the Storage Daemon and thus forwarded the File Daemon will send a heartbeat signal to the Director and to the Storage daemon to keep the channels active.
Value(s):
<time-interval>Data Type: integer
Default: 300
Comment: This feature is particularly useful if you have a router that does not follow Internet standards and times out a valid connection after a short duration despite the fact that keepalive is set. This usually results in a broken pipe error message.
Note
If you continue getting broken pipe error messages despite using the Heartbeat Interval and you are using Windows, you should consider upgrading your ethernet driver.
Lack of communications, or communications that get interrupted can also be caused by Linux firewalls where you have a rule that throttles connections or traffic.
Description: Maximum number of Jobs that should run concurrently.
Value(s):
<number>Data Type: integer
Default: 20
Comment: Each contact from the Director (e.g. status request, job start request) is considered as a Job, so if you want to be able to do a status request in the console at the same time as a Job is running, you will need to set this value greater than 1. If set to a large value, be careful to have this value higher than the Maximum Concurrent Jobs configured in the resource in the Director configuration file. Otherwise, backup jobs can fail due to the Director connection to FD be refused because Maximum Concurrent Jobs was exceeded on the FD side.
Description: Error threshold for the Job, after reaching it Job will be failed.
Value(s):
<number>Data Type: integer
Default: 1000
Comment: If this value is set to 0, job will continue to run no matter how many errors it encounters.
Description: Specifies the ports and addresses on which the File daemon listens for Director connections.
Value(s):
<IP-address-specification>Data Type: string
Default: 9102
Example:
FDAddresses = { ip = { addr = 1.2.3.4; port = 1205; } ipv4 = { addr = 1.2.3.4; port = http; } ipv6 = { addr = 1.2.3.4; port = 1205; } ip = { addr = 1.2.3.4 port = 1205 } ip = { addr = 1.2.3.4 } ip = { addr = 201:220:222::2 } ip = { addr = bluedot.thun.net } }where ip, ip4, ip6, addr, and port are all keywords. Note, that the address can be specified as either a dotted quadruple, or IPv6 colon notation, or as a symbolic name (only in the ip specification). Also, port can be specified as a number or as the mnemonic value from the /etc/services file. If a port is not specified, the default will be used. If an ip section is specified, the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then only IPv4 resolutions will be permitted, and likewise with ip6.
Description: Specifies the port number on which the Client listens for Director connections.
Value(s):
<port-number>Data Type: integer
Default: 9102
Comment: It must agree with the FDPort specified in the Client resource of the Director’s configuration file.
Description: Cause the File Daemon server (for Director connections) to bind to the specified IP-Address, which is either a domain name or an IP address specified as a dotted quadruple.
Value(s):
<IP-Address>Data Type: string
Default: 9102
Comment: If this record is not specified by a user, the File Daemon will bind to any available address (the default).
Description: Cause the File Daemon server (for Storage connections) to bind to the specified IP-Address, which is either a domain name or an IP address specified as a dotted quadruple.
Value(s):
<IP-Address>Data Type: string
Default: 0
Comment: If this record is not specified, the kernel will choose the best address according to the routing table (the default).
SDConnectTimeout = <time-interval>
Description: Defines an interval of time in seconds that the File Daemon will try to connect to the Storage Daemon.
Value(s):
<time-interval>Default: 1800
Comment: If no connection is made in the specified time interval, the File Daemon cancels the Job.
Description: Specifies the initial network buffer size to use with the File Daemon. This size will be adjusted down if it is too large until it is accepted by the OS.
Value(s):
<bytes>Data Type: integer
Required: No
Comment: Exercise caution when configuring this value, as setting it too high will result in a reduction of 512 bytes until the operating system is satisfied, potentially leading to a significant number of system calls. The default value is 65,536 bytes. The maximum value is 1,000,000 bytes.
Note
On certain Windows machines, there are reports that the transfer rates are very slow and this seems to be related to the default 65,536 size. On systems where the transfer rates seem abnormally slow compared to other systems, you might try setting the Maximum Network Buffer Size to 32,768 in both the File Daemon and in the Storage Daemon.
Description: Specifies the maximum allowed bandwidth in bytes per second that a job may use.
Value(s):
<speed>Data Type: string
Comment: You may specify the following speed parameter modifiers: kb/s (1,000 bytes per second), k/s (1,024 bytes per second), mb/s (1,000,000 bytes per second), or m/s (1,048,576 bytes per second).
Note
The use of TLS, TLS PSK, CommLine compression and Deduplication can interfere with the value set with this Directive.
Description: If the two Bacula components (DIR, FD, SD, bconsole) have the comm line compression enabled, the line compression will be enabled.
Value(s):
<yes|no>Data Type: boolean
Default: true
Comment: In many cases, the volume of data transmitted across the communications line can be reduced by a factor of three when this directive is enabled. In the case that the compression is not effective, Bacula turns it off on a record by record basis.
Note
If you are backing up data that is already compressed, the comm line compression will not be effective, and you are likely to end up with an average compression ratio that is very small. In this case, Bacula reports None in the Job report.
Description: Adds security to your File Daemon by disabling certain commands globally.
Value(s):
<cmd>Data Type: string
Required: No
Comment: 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
One or more of these command keywords can be placed in quotes and separated by spaces
on the directive line. The commands must be written exactly as they appear above.
Description: If the integer is greater than zero, it is the number of packets that the FileDaemon will send to the Storage Daemon before sending a POLL request and waiting for the Storage Daemon answer. If the integer is zero, it turns off this feature.
Value(s):
<num-packets>Data Type: integer
Default: 0
Comment: If the time between two POLL requests is too short (less than few seconds) and the number of bytes transferred is less than few hundred of MB, the value of the SD Packet Check is increased dynamically.
Description: Require FIPS cryptographic module to start the daemon.
Value(s):
<yes|no>Data Type: boolean
Required: No
Note
TLS Directives in the FileDaemon (or Client) resource of bacula-fd.conf
Bacula has built-in network encryption code to provide secure network transport similar to that offered by stunnel or ssh. The Bacula TLS encryption applies only to information transmitted across a network, so the data written to Volumes by the Storage daemon is not encrypted by this code.
For more information how to enable TLS encryption, click here.
Description: Each daemon (DIR, FD, SD) has a Plugin Directory directive that may be added to the daemon definition resource. The directory takes a quoted string argument, which is the name of the directory in which the daemon can find the Bacula plugins.
Value(s):
<directory>Data Type: string
Required: No
Comment: If this directive is not specified, Bacula will not load any plugins. Since each plugin has a distinctive name, all the daemons can share the same plugin directory.
Plugin Options = <Plugin-Command-Line>
Description: To configure non-job specific plugins (antivirus, security, etc.), it is possible to use the Plugin Options directive.
Value(s):
<plugin-command-line>Data Type: string
Required: No
Comment: Multiple directives are allowed.
Description: Configures the data encryption to use a specific cipher.
Value(s):
<cipher>Data Type: string
Default: AES 128 CBC
Comment: The following ciphers are available: aes128, aes192, aes256 and blowfish.
Description: Configures the data encryption to use a specific digest algorithm.
Value(s):
<cipher>Data Type: string
Default: SHA! or sha256 (depending on the version of OpenSSL)
Comment: md5, sha1, sha256.
PKI Encryption See the Data Encryption chapter.
PKI Signatures See the Data Encryption chapter.
PKI Keypair See the Data Encryption chapter.
PKI Master Key See the Data Encryption chapter.
Go back to the File Daemon (Client) Resource Types page.
Go back to the Technical Reference for File Daemon.
Go back to the main Technical Reference page.