.. _ConfigureChapter:

Customizing the Configuration
=============================

.. index::
   single: Customizing the Configuration

Each Bareos component (Director, Client, Storage, Console) has its own configuration containing a set of resource definitions. These resources are very similar from one service to another, but may contain different directives (records) depending on the component. For example, in the Director configuration, the :ref:`DirectorResourceDirector` defines the name of the Director, a number of global Director parameters and his password. In the File Daemon configuration, the
:ref:`ClientResourceDirector` specifies which Directors are permitted to use the File daemon.

If you install all Bareos daemons (Director, Storage and File Daemon) onto one system, the Bareos package tries its best to generate a working configuration as a basis for your individual configuration.

The details of each resource and the directives permitted therein are described in the following chapters.

The following configuration files must be present:

-  :ref:`DirectorChapter` – to define the resources necessary for the Director. You define all the Clients and Storage daemons that you use in this configuration file.

-  :ref:`StoredConfChapter` – to define the resources to be used by each Storage daemon. Normally, you will have a single Storage daemon that controls your disk storage or tape drives. However, if you have tape drives on several machines, you will have at least one Storage daemon per machine.

-  :ref:`FiledConfChapter` – to define the resources for each client to be backed up. That is, you will have a separate Client resource file on each machine that runs a File daemon.

-  :ref:`ConsoleConfChapter` – to define the resources for the Console program (user interface to the Director). It defines which Directors are available so that you may interact with them.

.. _section-ConfigurationPathLayout:

Configuration Path Layout
-------------------------

.. index::
   single: Configuration; Directories
   single: Configuration; Subdirectories

When a Bareos component starts, it reads its configuration. In Bareos < 16.2.2 only configuration files (which optionally can include other files) are supported. Since Bareos :sinceVersion:`16.2.2: Subdirectory Configuration Scheme` also configuration subdirectories are supported.

Naming
~~~~~~

In this section, the following naming is used:

-  :file:`CONFIGDIR` refers to the base configuration directory. Bareos Linux packages use :file:`/etc/bareos/`.

-  A component is one of the following Bareos programs:

   -  bareos-dir

   -  bareos-sd

   -  bareos-fd

   -  bareos-traymonitor

   -  bconsole

   -  Bareos tools, like :ref:`section-VolumeUtilityCommands` and others.

-  :file:`COMPONENT` refers to one of the listed components.

.. _section-ConfigurationFileOrConfigurationSubDirectories:

What configuration will be used?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When starting a Bareos component, it will look for its configuration. Bareos components allow the configuration file/directory to be specified as a command line parameter :file:`-c PATH`.

-  configuration path parameter is not given (default)

   -  :file:`CONFIGDIR/COMPONENT.conf` is a file

      -  the configuration is read from the file :file:`CONFIGDIR/COMPONENT.conf`

   -  :file:`CONFIGDIR/COMPONENT.d/` is a directory

      -  the configuration is read from :file:`CONFIGDIR/COMPONENT.d/*/*.conf` (subdirectory configuration)

-  configuration path parameter is given (:file:`-c PATH`)

   -  :file:`PATH` is a file

      -  the configuration is read from the file specified in :file:`PATH`

   -  :file:`PATH` is a directory

      -  the configuration is read from :file:`PATH/COMPONENT.d/*/*.conf` (subdirectory configuration)

As the :file:`CONFIGDIR` differs between platforms or is overwritten by the path parameter, the documentation will often refer to the configuration without the leading path (e.g. :file:`COMPONENT.d/*/*.conf` instead of :file:`CONFIGDIR/COMPONENT.d/*/*.conf`).

.. image:: /include/images/bareos-read-configuration.*




When subdirectory configuration is used, all files matching :file:`PATH/COMPONENT.d/*/*.conf` will be read, see :ref:`section-ConfigurationSubdirectories`.

Relation between Bareos components and configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. csv-table:: Bareos configuration default paths on Unix
   :header: "Bareos component", "Configuration File", "Subdirectory Configuration Scheme"


   ,                                    "(default path on Unix)",                "(default path on Unix)"

   bareos-dir,                          :file:`bareos-dir.conf`,                 :file:`bareos-dir.d`
   :ref:`DirectorChapter`,              (:file:`/etc/bareos/bareos-dir.conf`),   (:file:`/etc/bareos/bareos-dir.d/`)

   bareos-sd,                           :file:`bareos-sd.conf`,                  :file:`bareos-sd.d`
   :ref:`StoredConfChapter`,            (:file:`/etc/bareos/bareos-sd.conf`),    (:file:`/etc/bareos/bareos-sd.d/`)

   bareos-fd,                           :file:`bareos-fd.conf`,                  :file:`bareos-fd.d`
   :ref:`FiledConfChapter`,             (:file:`/etc/bareos/bareos-fd.conf`),    (:file:`/etc/bareos/bareos-fd.d/`)

   bconsole,                            :file:`bconsole.conf`,                   :file:`bconsole.d`
   :ref:`ConsoleConfChapter`,           (:file:`/etc/bareos/bconsole.conf`),     :file:`/etc/bareos/bconsole.d/`)

   bareos-traymonitor,                  :file:`tray-monitor.conf`,               :file:`tray-monitor.d`
   :ref:`section-MonitorConfig`,        (:file:`/etc/bareos/tray-monitor.conf`), (:file:`/etc/bareos/tray-monitor.d/`)

   :ref:`section-VolumeUtilityCommands`, :file:`bareos-sd.conf`,                 :file:`bareos-sd.d`
   (use the bareos-sd configuration),    (:file:`/etc/bareos/bareos-sd.conf`),   (:file:`/etc/bareos/bareos-sd.d/`)



.. _section-SubdirectoryConfigurationScheme:

.. _section-ConfigurationSubdirectories:

.. _ConfigurationIncludeDirectory:

Subdirectory Configuration Scheme
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If the subdirectory configuration is used, instead of a single configuration file, all files matching :file:`COMPONENT.d/*/*.conf` are read as a configuration, see :ref:`section-ConfigurationFileOrConfigurationSubDirectories`.

Reason for the Subdirectory Configuration Scheme
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In Bareos < 16.2.2, Bareos uses one configuration file per component.

Most larger Bareos environments split their configuration into separate files, making it easier to manage the configuration.

Also some extra packages (bareos-webui, plugins, ...) require a configuration, which must be included into the |dir| or |sd| configuration. The subdirectory approach makes it easier to add or modify the configuration resources of different Bareos packages.

The Bareos :ref:`configure <section-bcommandConfigure>` command requires a configuration directory structure, as provided by the subdirectory approach.

From Bareos :sinceVersion:`16.2.4: Subdirectory Configuration Scheme used as Default` on, new installations will use configuration subdirectories by default.

.. _section-ConfigurationResourceFileConventions:

Resource file conventions
^^^^^^^^^^^^^^^^^^^^^^^^^

-  Each configuration resource has to use its own configuration file.

-  The path of a resource file is :file:`COMPONENT.d/RESOURCETYPE/RESOURCENAME.conf`.

-  The name of the configuration file is identical with the resource name:

   -  e.g.

      -  :file:`bareos-dir.d/director/bareos-dir.conf`

      -  :file:`bareos-dir.d/pool/Full.conf`

   -  Exceptions:

      -  The resource file :file:`bareos-fd.d/client/myself.conf` always has the file name :file:`myself.conf`, while the name is normally set to the hostname of the system.

-  Example resource files:

   -  Additional packages can contain configuration files that are automatically included. However, most additional configuration resources require configuration. When a resource file requires configuration, it has to be included as an example file:

      -  :file:`CONFIGDIR/COMPONENT.d/RESOURCE/NAME.conf.example`

      -  For example, the |webui| entails one config resource and one config resource example for the |dir|:

         -  :file:`CONFIGDIR/bareos-director.d/profile/webui-admin.conf`

         -  :file:`CONFIGDIR/bareos-director.d/console/admin.conf.example`

-  .. _section-deleteConfigurationResourceFiles:

   Disable/remove configuration resource files:

   Normally you should not remove resources that are already in use (jobs, clients, ...). Instead you should disable them by adding the directive ``Enable = no``. Otherwise you take the risk that orphaned entries are kept in the Bareos catalog. However, if a resource has not been used or all references have been cleared from the database, they can also be removed from the configuration.

Configuration Deployment
------------------------

Since Bareos :sinceVersion:`25.0.0: Config Deployment`,
on upgrade none of the Bareos components
(**bareos-dir**, **bareos-sd**, **bareos-fd**, **bconsole** and **bareos-traymonitor**)
modify/extend an existing configuration.
Package configuration files are stored in the Bareos Template Configuration Path (see :ref:`section-BareosPaths`).
The package uses :command:`bareos-config deploy_config $COMPONENT` to deploy the configuration.
On fresh installation it:

* copies the config files from the Bareos Template Configuration Path (Linux: :file:`/usr/lib/bareos/defaultconfigs/`) to the Bareos Configuration Path (Linux: :file:`/etc/bareos/`)

* make necessary adjustments (generate and set random passwords, set hostname, ...)

* set directory and file permissions

If the configuration path already exist, all these actions are skipped.


Behavior
~~~~~~~~

* On upgrades, the existing configuration files for the components
  **bareos-dir**, **bareos-sd**, **bareos-fd**, **bconsole** and **bareos-traymonitor**
  will not get modified.
* The packages only contain configuration files in the Bareos Template Configuration Path.
  They no longer contain their configuration in the Bareos Configuration Path.
* Configuration files from sub-packages will probably not get installed,
  especially if the sub-package is installed after the main package (e.g. the **bareos-storage-tape** package is installed after the **bareos-storage** package). This also applies to configuration example files (:file:`*.conf.example`).

Add missing
~~~~~~~~~~~

If your local :file:`/etc/bareos` configuration is missing one of the default files
(for example after deleting a file or adding a new subcomponent such as a plugin),
you can deploy missing files with
:command:`bareos-config deploy_config --add-missing $COMPONENT`.


.. code-block:: shell-session
   :caption: Shell example script to deploy missing example configuration file

   /usr/lib/bareos/scripts/bareos-config deploy_config --add-missing bareos-sd

   '/usr/lib/bareos/defaultconfigs/bareos-sd.d//./autochanger/autochanger-0.conf.example' -> '/etc/bareos/bareos-sd.d/./autochanger/autochanger-0.conf.example'
   '/usr/lib/bareos/defaultconfigs/bareos-sd.d//./device/tapedrive-0.conf.example' -> '/etc/bareos/bareos-sd.d/./device/tapedrive-0.conf.example'
   '/usr/lib/bareos/defaultconfigs/bareos-sd.d//./device/dplcompat.conf.example' -> '/etc/bareos/bareos-sd.d/./device/dplcompat.conf.example'


Upgrades from Bareos < 25 to Bareos >= 25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Switching to use the Bareos Template Configuration Path had some challenges on RPM-based systems and FreeBSD.
The other platforms did already use Bareos Template Configuration Path before.

.. index::
   single: Linux; RPM
   single: FreeBSD; pkg

When upgrading from Bareos < 25 to Bareos >= 25 with RPM packages,
RPM would delete or rename the old configuration,
as these files no longer belong to the package.
Therefore we use a package pre-script to backup the config files
and restore them with a post-script (posttrans).
The normal automated restart of the |fd| will fail in between, but a proper restart will be performed at the end.
In short: for this scenario we created workarounds
so that the administrator should not notice any trouble when upgrading.

The :os:`FreeBSD` packaging mechanism prevents that a backup of the old configuration could be done,
therefore unmodified configuration files from the old package get removed.
As a workaround, when upgrading from Bareos <= 24, the package will redeploy any missing configuration file from the Bareos Template Configuration Path of the new package.
This should leave the content of the configuration directory will no changes when upgrading to Bareos 25.
However, we can't guarantee that direct upgrades from Bareos <= 24 to Bareos >= 26 also don't result in content changes.
To be save, FreeBSD users should first upgrade to Bareos 25.

On both platforms, timestamps and permissions of the configuration files can change.

Also note, that the files
:file:`bareos-dir.d/profile/webui-admin.conf` and :file:`bareos-dir.d/profile/webui-readonly.conf`
have been moved from the **bareos-webui** to the **bareos-director** package.


Configuration File Format
-------------------------

A configuration file consists of one or more resources (see :ref:`section-ConfigurationResourceFormat`).

Bareos programs can work with

-  all resources defined in one configuration file

-  configuration files that include other configuration files (see :ref:`Includes`)

-  :ref:`section-ConfigurationSubdirectories`, where each configuration file contains exactly one resource definition

Character Sets
~~~~~~~~~~~~~~

:index:`\ <single: Character Sets>`\  Bareos is designed to handle most character sets of the world, US ASCII, German, French, Chinese, ... However, it does this by encoding everything in UTF-8, and it expects all configuration files (including those read on Win32 machines) to be in UTF-8 format. UTF-8 is typically the default on Linux machines, but not on all Unix machines, nor on Windows, so you must take some care to ensure that your locale is set properly before starting Bareos.

:index:`\ <single: Windows; Configuration Files; UTF-8>`\  To ensure that Bareos configuration files can be correctly read including foreign characters, the LANG environment variable must end in .UTF-8. A full example is en_US.UTF-8. The exact syntax may vary a bit from OS to OS, so that the way you have to define it will differ from the example. On most newer Win32 machines you can use :command:`notepad` to edit the conf files, then choose output encoding UTF-8.

Bareos assumes that all filenames are in UTF-8 format on Linux and Unix machines. On Win32 they are in Unicode (UTF-16) and will hence be automatically converted to UTF-8 format.

.. _Comments:

Comments
~~~~~~~~

:index:`\ <single: Configuration; Comments>`\

When reading a configuration, blank lines are ignored and everything after a hash sign (#) until the end of the line is taken to be a comment.

Semicolons
~~~~~~~~~~

A semicolon (;) is a logical end of line and anything after the semicolon is considered as the next statement. If a statement appears on a line by itself, a semicolon is not necessary to terminate it, so generally in the examples in this manual, you will not see many semicolons.

.. _Includes:

Including other Configuration Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:index:`\ <single: Including other Configuration Files>`\  :index:`\ <single: Files; Including other Configuration>`\  :index:`\ <single: Configuration; Including Files>`\

If you wish to break your configuration file into smaller pieces, you can do so by including other files using the syntax :strong:`@filename`\  where :file:`filename` is the full path and filename of another file. The :strong:`@filename`\  specification can be given anywhere a primitive token would appear.

.. code-block:: bareosconfig
   :caption: include a configuration file

   @/etc/bareos/extra/clients.conf

Since Bareos :sinceVersion:`16.2.1: Including configuration files by wildcard` wildcards in paths are supported:

.. code-block:: bareosconfig
   :caption: include multiple configuration files

   @/etc/bareos/extra/*.conf

By using :strong:`@|command`\  it is also possible to include the output of a script as a configuration:

.. code-block:: bareosconfig
   :caption: use the output of a script as configuration

   @|"/etc/bareos/generate_configuration_to_stdout.sh"

or if a parameter should be used:

.. code-block:: bareosconfig
   :caption: use the output of a script with parameter as a configuration

   @|"sh -c '/etc/bareos/generate_client_configuration_to_stdout.sh clientname=client1.example.com'"

The scripts are called at the start of the daemon. You should use this with care.

.. _section-ConfigurationResourceFormat:

Resource
--------

:index:`\ <single: Configuration; Resource>`\

A resource is defined as the resource type, followed by an open brace (:file:`{`), a number of :ref:`section-ConfigurationResourceDirective`, and ended by a closing brace (:file:`}`)

Each resource definition MUST contain a :strong:`Name`\  directive. It can contain a :strong:`Description`\  directive. The :strong:`Name`\  directive is used to uniquely identify the resource. The :strong:`Description`\  directive can be used during the display of the Resource to provide easier human recognition. For example:

.. code-block:: bareosconfig
   :caption: Resource example

   Director {
     Name = "bareos-dir"
     Description = "Main Bareos Director"
     Query File = "/usr/lib/bareos/scripts/query.sql"
   }

defines the Director resource with the name :strong:`bareos-dir` and a query file :file:`/usr/lib/bareos/scripts/query.sql`.

:index:`\ <single: Configuration; Naming Convention>`\

When naming resources, for some resource types naming conventions should be applied:

Client
   names should be postfixed with **-fd**

Storage
   names should be postfixed with **-sd**

Director
   names should be postfixed with **-dir**

These conventions helps a lot when reading log messages.


.. _section-ConfigurationResourceDirective:

Resource Directive
~~~~~~~~~~~~~~~~~~

Each directive contained within the resource (within the curly braces :file:`{}`) is composed of a :ref:`section-ConfigurationResourceDirectiveKeyword` followed by an equal sign (=) followed by a :ref:`section-ConfigurationResourceDirectiveValue`. The keywords must be one of the known Bareos resource record keywords.

.. _section-ConfigurationResourceDirectiveKeyword:

Resource Directive Keyword
~~~~~~~~~~~~~~~~~~~~~~~~~~

A resource directive keyword is the part before the equal sign (:file:`=`) in a :ref:`section-ConfigurationResourceDirective`. The following sections will list all available directives by Bareos component resources.

Upper and Lower Case and Spaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Case (upper/lower) and spaces are ignored in the resource directive keywords.

Within the keyword (i.e. before the equal sign), spaces are not significant. Thus the keywords: name, Name, and N a m e are all identical.

.. _section-ConfigurationResourceDirectiveValue:

Resource Directive Value
~~~~~~~~~~~~~~~~~~~~~~~~

A resource directive value is the part after the equal sign (:file:`=`) in a :ref:`section-ConfigurationResourceDirective`.

Spaces
~~~~~~

Spaces after the equal sign and before the first character of the value are ignored. Other spaces within a value may be significant (not ignored) and may require quoting.

.. _section-Quotes:

Quotes
~~~~~~

In general, if you want spaces in a name to the right of the first equal sign (=), you must enclose that name within double quotes. Otherwise quotes are not generally necessary because once defined, quoted strings and unquoted strings are all equal.

Within a quoted string, any character following a backslash (\) is taken as itself (handy for inserting backslashes and double quotes (")).

.. _section-MultilineString:

.. note::

   Since Bareos :sinceVersion:`20: Multiline Strings` strings can be spread over multiple lines using quotes like this:

   .. code-block:: bareosconfig
      :caption: Multiline string values

      FooBar = "This is the first line of text"
               "  This is another line"
        "This is the third line   "

.. warning::

   If the configure directive is used to define a number, the number is never to be put between surrounding quotes. This is even true if the number is specified together with its unit, like :strong:`365 days`.

.. _section-Numbers:

Numbers
~~~~~~~

Numbers are not to be quoted, see :ref:`section-Quotes`. Also do not prepend numbers by zeros (0), as these are not parsed in the expected manner (write 1 instead of 01).

.. _section-DataTypes:

Data Types
~~~~~~~~~~

.. index::
   single: Configuration; Data Types
   single: Data Type

When parsing the resource directives, Bareos classifies the data according to the types listed below.

.. config:datatype:: ACL

   :multi: yes

   This directive defines what is permitted to be accessed. It does this by using a list of regular expressions, separated by commas (:strong:`,`) or using multiple directives. If :strong:`!` is prepended, the expression is negated. The special keyword :strong:`*all*` allows unrestricted access.

   Depending on the type of the ACL, the regular expressions can be either resource names, paths or console commands.

   Since Bareos :sinceVersion:`16.2.4: ACL: strict regular expression handling` regular expression are handled more strictly. Before also substring matches has been accepted.

   .. _section-CommandAclExample:

   For clarification, we demonstrate the usage of ACLs by some examples for :config:option:`dir/console/CommandACL`\ :

   .. code-block:: bareosconfig
      :caption: Allow only the help command

      Command ACL = help

   .. code-block:: bareosconfig
      :caption: Allow the help and the list command

      Command ACL = help, list

   .. code-block:: bareosconfig
      :caption: Allow the help and the (not existing) iDoNotExist command

      Command ACL = help, iDoNotExist

   .. code-block:: bareosconfig
      :caption: Allow all commands (special keyword)

      Command ACL = *all*

   .. code-block:: bareosconfig
      :caption: Allow all commands except sqlquery and commands starting with u

      Command ACL = !sqlquery, !u.*, *all*

   Same:

   .. code-block:: bareosconfig
      :caption: Some as above. Specifying it in multiple lines doesn't change the meaning

      Command ACL = !sqlquery, !u.*
      Command ACL = *all*

   .. code-block:: bareosconfig
      :caption: Additional deny the setip and setdebug commands

      Command ACL = !sqlquery
      Command ACL = !u.*
      Command ACL = !set(ip|debug)
      Command ACL = *all*



   .. warning::

      ACL checking stops at the first match. So the following definition allows all commands, which might not be what you expected:

      .. code-block:: bareosconfig
         :caption: Wrong: Allows all commands

         # WARNING: this configuration ignores !sqlquery, as *all* is matched before.
         Command ACL = *all*, !sqlquery



.. config:datatype:: ACTION_ON_PURGE

   Action to perform on Purge, mostly **truncate**.



.. config:datatype:: ADDRESS

   Is either a domain name or an IP address specified as a dotted quadruple in string or an IP version 6 address specified as a colon separated syntax (::) or quoted string format. This directive only permits a single address to be specified. The :strong:`Port` must be specifically separated. If multiple :strong:`Addresses` are needed, please assess if it is also possible to specify :config:datatype:`ADDRESSES` (plural).



.. config:datatype:: ADDRESSES

   Specify a set of Addresses and Ports. Probably the simplest way to explain this is to show an example.

   The following example makes the director listen for connections on all interfaces both on IPv4 and IPv6.


   .. code-block:: bareosconfig
       :caption: Listen on IPv4 and IPv6 for Bareos < 21

       Addresses = {
          ipv6 = { addr = :: ; port = 9101 }
       }

   .. note::

      Since Bareos :sinceVersion:`21: listen on both IPv4 and IPv6 per default` on two distinct sockets, this is not required anymore. This notation will be required if you want to restrict the addresses to listen on.

   .. code-block:: bareosconfig
       :caption: Listen on IPv4 and IPv6 for Bareos >= 21 (default)

       Addresses = {
          ipv4 = { addr = 0.0.0.0 ; port = 9101 }
          ipv6 = { addr = :: ; port = 9101 }
       }



   The following example shows all of the features the Addresses parser:

   .. code-block:: bareosconfig
       :caption:  Showing Addresses features

       Addresses  = {
           ip = { addr = 1.2.3.4; port = 1205;}
           ip = {
               addr = 1.2.3.4
               port = 1205
           }
           ipv4 = {
               addr = 1.2.3.4; port = http;}
           ipv6 = {
               addr = 2001:db8::;
               port = 1205;
           }
           ip = { addr = 1.2.3.4 }
           ip = { addr = 2001:db8:: }
           ip = {
               addr = server.example.com
           }
       }

   Where ip, ipv4, ipv6, addr, and port are all keywords.
   Note, that the address can be specified as either a dotted quadruple, or in IPv6 colon notation, or as a symbolic name (only in the ip specification).
   Also, the port can be specified as a number or as the mnemonic value from the :file:`/usr/etc/services` file.
   If a port is not specified, the default one will be used. If an ip section is specified, the resolution can be made either by IPv4 or IPv6.
   If ipv4 is specified, then only IPv4 resolutions will be permitted, and likewise with IPv6.



   .. code-block:: bareosconfig
       :caption:  Bareos >= 21 : Listening on all IPv6 and only IPv4 localhost

        Addresses  = {
         ipv6 = { addr = :: }
         ipv4 = { addr = 127.0.0.1 }
       }

   .. code-block:: bareosconfig
       :caption:  Bareos >= 21 : Listening only on IPv4

        Addresses  = {
         ipv4 = { addr = 0.0.0.0 }
       }

   .. code-block:: bareosconfig
       :caption:  Bareos >= 21 : Listening on specific IPv6 and none IPv4

       Addresses  = {
         ipv6 = { addr = ::1 }
         ipv6 = { addr = 2001:0db8:0000:0000:ba4e:0s00:0000:ba3e;}
       }



.. config:datatype:: AUDIT_COMMAND_LIST

   Specifies the commands that should be logged on execution (audited). E.g.

   .. code-block:: bareosconfig

       Audit Events = label
       Audit Events = restore


.. config:datatype:: AUTH_PROTOCOL_TYPE

   :values: **Native** | **NDMPV2** | **NDMPV3** | **NDMPV4**
   :see: :config:datatype:`PROTOCOL_TYPE`

   Either select the native Bareos protocol or a NDMP protocol.



.. config:datatype:: AUTH_TYPE

   Specifies the authentication type that must be supplied when connecting to a backup protocol that uses a specific authentication type. Currently only used for :ref:`NDMPResource`.

   The following values are allowed: `None` (Use no password), `Clear` (Use clear text password), `MD5` (Use MD5 hashing).



.. config:datatype:: AUTOPASSWORD

   This is a Bareos password and it is stored internally in MD5 hashed format.



.. config:datatype:: BACKUP_LEVEL

   The following string values are allowed:

   For backup job
      `Full`, `Differential`, `Incremental`, `VirtualFull`

   For verify job
      `InitCatalog`, `Catalog`, `VolumeToCatalog`, `DiskToCatalog`

   See details at :config:option:`dir/job/Level`.



.. config:datatype:: BIT

   Either a :strong:`yes` or a :strong:`no` or a :strong:`true` or a :strong:`false`.



.. config:datatype:: BOOLEAN

   Either a :strong:`yes` or a :strong:`no` or a :strong:`true` or a :strong:`false`.


.. config:datatype:: COMPRESSION_ALGORITHM

   The following values are allowed: `GZIP` (GZIP1 to GZIP9), `LZO`, `LZFAST` (deprecated :sinceVersion:`19.2.: lzfast`, `LZ4`, `LZ4HC`.

   See :config:option:`dir/fileset/include/options/compression`.



.. config:datatype:: DEVICE

   See :config:option:`dir/storage/Device`.


.. config:datatype:: DEVICE_TYPE

   The following values are allowed: `Tape`, `File`, `FIFO`, `GFAPI`, `Droplet` :sinceVersion:`17.2.7: libdroplet`.

   See :config:option:`sd/device/DeviceType`.



.. config:datatype:: DIRECTORY

   A directory.



.. config:datatype:: DIRECTORY_LIST

   :multi: yes

   A list of directories.



.. config:datatype:: DIRECTORY_OR_COMMAND

   A directory, and or a command using substitution.



.. config:datatype:: ENCRYPTION_CIPHER

   String list of cipher to use for encryption.



.. config:datatype:: INCLUDE_EXCLUDE_ITEM

   The :ref:`Include <fileset-include>` or :ref:`Exclude <fileset-exclude>` resource must contain a list of directories and/or files to be processed, excluded in the backup job.



.. config:datatype:: INT32

   :values: -2147483648 - +2147483647
   :quotes: no

   A signed 32 bit integer value.

   Don’t use quotes around the number, see :ref:`section-Quotes`.



.. config:datatype:: IO_DIRECTION

   :values: **in** | **out** | **both**

   String indicating sens of IO can be `in` or `out` or `both`
   Following aliases are also valid:

   read
        Alias for `in`.

   readonly
        Alias for `in`.

   write
        Alias for `out`.

   writeonly
        Alias for `out`.

   readwrite
        Alias for `both`.



.. config:datatype:: JOB_TYPE

   :values: **Backup** | **Restore** | **Verify** | **Admin** | **Migrate** | **Copy** | **Consolidate**

   See :config:option:`dir/job/Type`



.. config:datatype:: LABEL

   Quoted string for volume label.



.. config:datatype:: MAX_BLOCKSIZE

   :quotes: no

   Positive integer

   If no value or zero is specified, the Storage daemon will use a default block size of 64,512 bytes (126 * 512).



.. config:datatype:: MD5PASSWORD

   MD5 hashed format of password.



.. config:datatype:: MESSAGES

   See :ref:`DirectorResourceMessages`.



.. config:datatype:: MIGRATION_TYPE

   The following values are allowed: `SmallestVolume`, `OldestVolume`, `Client`, `Volume`, `Job`, `SQLQuery`, `PoolOccupancy`, `PoolTime`, `PoolUncopiedJobs`

   See :config:option:`dir/job/SelectionType`.



.. config:datatype:: NAME

   A keyword or name consisting of alphanumeric characters, including the hyphen, underscore, and dollar characters. The first character of a name must be a letter. A name has a maximum length currently set to 127 bytes.

   Please note that Bareos resource names as well as certain other names (e.g. Volume names) must contain only letters (including ISO accented letters), numbers, and a few special characters (space, underscore, ...). All other characters and punctuation are invalid.



.. config:datatype:: PINT16

   :values: 0 - 65535
   :quotes: no

   A positive 16 bit unsigned integer value.

   Don’t use quotes around the number, see :ref:`section-Quotes`.


.. config:datatype:: PINT32

   :values: 0 - 4294967295
   :quotes: no

   A positive 32 bit unsigned integer value.

   Don’t use quotes around the number, see :ref:`section-Quotes`.



.. config:datatype:: PLUGIN_NAMES

   List of plugins, that should get loaded from `Plugin Directory`


.. config:datatype:: POOLTYPE

   The following values are allowed: `Backup`, `Archive`, `Cloned`, `Migration`, `Copy`, `Save`

   .. note::

      Only `Backup` is currently implemented.


.. config:datatype:: PORT

   :values: 1 - 65535
   :quotes: no

   Specify a network network port.

   Don’t use quotes around the parameter, see :ref:`section-Quotes`.



.. config:datatype:: PROTOCOL_TYPE

   :see: :config:datatype:`AUTH_PROTOCOL_TYPE`

   The protocol to run a the job. Following protocols are available:

   Native
        Native Bareos job protocol.

   NDMP
        Deprecated. Alias for |ndmpbareos|.

   NDMP_BAREOS
        Since Bareos :sinceVersion:`17.2.3: NDMP BAREOS`. See :ref:`section-NdmpBareos`.

   NDMP_NATIVE
        Since Bareos :sinceVersion:`17.2.3: NDMP NATIVE`. See :ref:`section-NdmpNative`.



.. config:datatype:: REPLACE_OPTION

   The following values are allowed: `always`, `ifnewer`, `ifolder`, `never`.

   See :config:option:`dir/job/Replace`



.. config:datatype:: RES

   A resource defines a relation to the name of another resource.



.. config:datatype:: RESOURCE_LIST

   :multi: yes
   :see: :config:datatype:`RES`

   A list of resource.



.. config:datatype:: RUNSCRIPT

   :multi: yes

   See :config:option:`dir/job/RunScript`.



.. config:datatype:: RUNSCRIPT_SHORT

   :multi: yes

   String command.

   See :config:option:`dir/job/RunScript`.



.. config:datatype:: SCHEDULE_RUN_COMMAND

   String line for schedule.

   See :config:option:`dir/schedule/Run`


.. config:datatype:: SIZE32

   :quotes: no
   :see: :config:datatype:`SIZE64`

   A size specified as bytes. Typically, this is a floating point scientific input format followed by an optional modifier. The floating point input is stored as a 32 bit integer value.


.. config:datatype:: SIZE64

   :quotes: no

   A size specified as bytes. Typically, this is a floating point scientific input format followed by an optional modifier. The floating point input is stored as a 64 bit integer value. If a modifier is present, it must immediately follow the value with no intervening spaces. The following modifiers are permitted:

   k
      1,024  (kibibytes)

   kb
      1,0000 (kilobytes)

   m
      1,048,576 (mebibytes)

   mb
      1,000,000 (megabytes)

   g
      1,073,741,824 (gibibytes)

   gb
      1,000,000,000 (gigabytes)

   t
      1,099,511,627,776 (tebibytes)

   tb
      1,000,000,000,000 (terabytes)

   p
      1,125,899,906,842,624 (pebibytes)

   pb
      1,000,000,000,000,000 (petabytes)

   e
      1,152,921,504,606,846,976 (exbibytes)

   eb
      1,000,000,000,000,000,000 (exabytes)

   Don’t use quotes around the parameter, see :ref:`section-Quotes`.


.. config:datatype:: SPEED

   :quotes: no

   The speed parameter can be specified as k/s, kb/s, m/s or mb/s.

   See unit explanation at :config:datatype:`SIZE64`.

   Don’t use quotes around the parameter, see :ref:`section-Quotes`.



.. config:datatype:: STRING

   A quoted string containing virtually any character including spaces, or a non-quoted string. A string may be of any length. Strings are typically values that correspond to filenames, directories, or system command names. A backslash (\) turns the next character into itself, so to include a double quote in a string, you precede the double quote with a backslash. Likewise to include a backslash.

   Strings can be spread over :ref:`multiple lines <section-MultilineString>` using quotes.


.. config:datatype:: STRING_LIST

   :multi: yes
   :see: :config:datatype:`STRING`

   Multiple :config:datatype:`STRING`, specified in multiple directives, or in a single directive, separated by commas (**,**).


.. config:datatype:: STRNAME

   is similar to a :strong:`Name`, except that the name may be quoted and can thus contain additional characters including spaces.


.. config:datatype:: TIME

   :quotes: no

   A time or duration specified in seconds. The time is stored internally as a 64 bit integer value, but it is specified in two parts: a number part and a modifier part. The number can be an integer or a floating point number. If it is entered in floating point notation, it will be rounded to the nearest integer. The modifier is mandatory and follows the number part, either with or without
   intervening spaces. The following modifiers are permitted:

   seconds
      :index:`\ <single: seconds>`\

   minutes
      :index:`\ <single: minutes>`\  (60 seconds)

   hours
      :index:`\ <single: hours>`\  (3600 seconds)

   days
      :index:`\ <single: days>`\  (3600*24 seconds)

   weeks
      :index:`\ <single: weeks>`\  (3600*24*7 seconds)

   months
      :index:`\ <single: months>`\  (3600*24*30 seconds)

   quarters
      :index:`\ <single: quarters>`\  (3600*24*91 seconds)

   years
      :index:`\ <single: years>`\  (3600*24*365 seconds)

   Any abbreviation of these modifiers is also permitted (i.e. seconds may be specified as sec or s). A specification of m will be taken as months.

   The specification of a time may have as many number/modifier parts as you wish. For example:

   .. code-block:: bareosconfig

      1 week 2 days 3 hours 10 mins

   or

   .. code-block:: bareosconfig

      1 month 2 days 30 sec


   are valid date specifications.

   Don’t use quotes around the parameter, see :ref:`section-Quotes`.




.. _VarsChapter:

Variable Expansion
~~~~~~~~~~~~~~~~~~

Depending on the directive, Bareos will expand to the following variables:

.. _section-VariableExpansionVolumeLabels:

Variable Expansion on Volume Labels
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When labeling a new volume (see :config:option:`dir/pool/LabelFormat`\ ), following Bareos internal variables can be used:

===================== ========================================
**Internal Variable** **Description**
**$Year**             Year
**$Month**            Month: 1-12
**$Day**              Day: 1-31
**$Hour**             Hour: 0-24
**$Minute**           Minute: 0-59
**$Second**           Second: 0-59
**$WeekDay**          Day of the week: 0-6, using 0 for Sunday
**$Job**              Name of the Job
**$Dir**              Name of the Director
**$Level**            Job Level
**$Type**             Job Type
**$JobId**            JobId
**$JobName**          unique name of a job
**$Storage**          Name of the Storage Daemon
**$Client**           Name of the Clients
**$NumVols**          Numbers of volumes in the pool
**$Pool**             Name of the Pool
**$Catalog**          Name of the Catalog
**$MediaType**        Type of the media
===================== ========================================

Additional, normal environment variables can be used, e.g. **$HOME** or **$HOSTNAME**.

With the exception of Job specific variables, you can trigger the variable expansion by using the :ref:`var command <var>`.

Variable Expansion in Autochanger Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

At the configuration of autochanger commands the following variables can be used:

============= ===================
**Variable**  **Description**
:strong:`\%a` Archive Device Name
:strong:`\%c` Changer Device Name
:strong:`\%d` Changer Drive Index
:strong:`\%f` Client’s Name
:strong:`\%j` Job Name
:strong:`\%o` Command
:strong:`\%s` Slot Base 0
:strong:`\%S` Slot Base 1
:strong:`\%v` Volume Name
============= ===================

Variable Expansion in Mount Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

At the configuration of mount commands the following variables can be used:

============= ===================
**Variable**  **Description**
:strong:`\%a` Archive Device Name
:strong:`\%e` Erase
:strong:`\%n` Part Number
:strong:`\%m` Mount Point
:strong:`\%v` Last Part Name
============= ===================

Variable Expansion on RunScripts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Variable Expansion on RunScripts is described at :config:option:`dir/job/RunScript`\ .

Variable Expansion in Mail and Operator Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

At the configuration of mail and operator commands the following variables can be used:

============= ==================================
**Variable**  **Description**
:strong:`\%c` Client’s Name
:strong:`\%d` Director’s Name
:strong:`\%e` Job Exit Code
:strong:`\%i` JobId
:strong:`\%j` Unique Job Id
:strong:`\%l` Job Level
:strong:`\%n` Unadorned Job Name
:strong:`\%s` Since Time
:strong:`\%t` Job Type (Backup, ...)
:strong:`\%r` Recipients
:strong:`\%v` Read Volume Name
:strong:`\%V` Write Volume Name
:strong:`\%b` Job Bytes
:strong:`\%B` Job Bytes in human readable format
:strong:`\%F` Job Files
============= ==================================



.. _Names:

Names, Passwords and Authorization
----------------------------------

:index:`\ <single: Authorization; Names and Passwords>`\  :index:`\ <single: Passwords>`\

In order for one daemon to contact another daemon, it must authorize itself with a password. In most cases, the password corresponds to a particular name, so both the name and the password must match to be authorized. Passwords are plain text, any text. They are not generated by any special process; just use random text.

The default configuration files are automatically defined for correct authorization with random passwords. If you add to or modify these files, you will need to take care to keep them consistent.



.. _section-resource-relation:



.. figure:: /include/images/Conf-Diagram.*
   :alt: Relation between resource names and passwords
   :width: 80.0%

   Relation between resource names and passwords

In the left column, you can see the Director, Storage, and Client resources and their corresponding names and passwords – these are all in :file:`bareos-dir.conf`. In the right column the corresponding values in the Console, Storage daemon (SD), and File daemon (FD) configuration files are shown.

Please note that the address :strong:`fw-sd`, that appears in the Storage resource of the Director, is passed to the File daemon in symbolic form. The File daemon then resolves it to an IP address. For this reason you must use either an IP address or a resolvable fully qualified name. A name such as :strong:`localhost`, not being a fully qualified name, will resolve in the File daemon to the :strong:`localhost` of the File daemon, which is most likely not what is
desired. The password used for the File daemon to authorize with the Storage daemon is a temporary password unique to each Job created by the daemons and is not specified in any .conf file.
