%%
%%
-\section*{Storage Daemon Configuration}
+\section*{Configuration du Storage Daemon}
\label{_ChapterStart31}
-\index[general]{Storage Daemon Configuration}
+\index[general]{Configuration du Storage Daemon}
\index[general]{Configuration!Storage Daemon}
-\addcontentsline{toc}{section}{Storage Daemon Configuration}
+\addcontentsline{toc}{section}{Configuration du Storage Daemon}
\subsection*{General}
\index[general]{General}
\addcontentsline{toc}{subsection}{General}
-
-The Storage Daemon configuration file has relatively few resource definitions.
-However, due to the great variation in backup media and system capabilities,
-the storage daemon must be highly configurable. As a consequence, there are
-quite a large number of directives in the Device Resource definition that
-allow you to define all the characteristics of your Storage device (normally a
-tape drive). Fortunately, with modern storage devices, the defaults are
-sufficient, and very few directives are actually needed.
-
-Examples of {\bf Device} resource directives that are known to work for a
-number of common tape drives can be found in the {\bf
-\lt{}bacula-src\gt{}/examples/devices} directory, and most will also be listed
-here.
-
-For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
-\ilink{Configuration}{_ChapterStart16} chapter of this manual. The
-following Storage Resource definitions must be defined:
+Le fichier de configuration du Storage Daemon a relativement peu de d\'efinitions
+de resources. Cependant, en raison du nombre pl\'ethorique de media et de syst\`emes,
+il doit \^etre hautement param\'etrable. Par cons\'equent, il existe un nombre assez important
+de directives dans la d\'eficnition de ressource Devices qui vous permet de d\'efinir
+toutes les caract\'eristiques de votre p\'eriph\'erique de stockage. Heureusement, avec les
+mat\'eriels modernes, les valeurs par d\'efaut sont g\'en\'eralement suffisantes, et tr\`es
+peu de directives sont r\'eellement indispensables.
+
+Des exemples de directives de ressources device connues pour fonctionner pour
+beaucoup de lecteurs de bandes communs peuvent \^etre trouv\'es dans le r\'epertoire :
+\lt{}bacula-src\gt{}/examples/devices}. La plupart seront \'enum\'er\'es ici.
+
+Pour un discussion g\'en\'erale concernant les fichiers de configuration de Bacula,
+les ressources et les types de donn\'ees reconnus, veuillez consulter le
+chapitre \ilink{Configuration}{_ChapterStart16} de ce manuel. Les d\'efinitions de
+ressources Storage suivantes doivent \^etre d\'efinies :
\begin{itemize}
\item
- \ilink{Storage}{StorageResource} -- to define the name of the
- Storage daemon.
+ \ilink{Storage}{StorageResource} -- Pour d\'efinir le nom du Storage Daemon.
\item
- \ilink{Director}{DirectorResource1} -- to define the Director's
- name and his access password.
+ \ilink{Director}{DirectorResource1} -- Pour d\'efinir le nom du Director et le mot
+ de passe permettant d'y acc\'eder.
\item
- \ilink{Device}{DeviceResource} -- to define the
- characteristics of your storage device (tape drive).
+ \ilink{Device}{DeviceResource} -- Pour d\'efinir les caract\'eristiques de votre
+ p\'eriph\'erique de stockage.
\item
- \ilink{Messages}{_ChapterStart15} -- to define where error and
- information messages are to be sent.
+ \ilink{Messages}{_ChapterStart15} -- Pour d\'efinir o\`u les messages d'erreurs
+ et d'information doivent \^etre exp\'edi\'es.
\end{itemize}
-\subsection*{Storage Resource}
+\subsection*{Ressource Storage}
\label{StorageResource}
-\index[general]{Resource!Storage}
-\index[general]{Storage Resource}
-\addcontentsline{toc}{subsection}{Storage Resource}
+\index[general]{Ressource!Storage}
+\index[general]{Ressource Sorage}
+\addcontentsline{toc}{subsection}{Ressource Storage}
-In general, the properties specified under the Storage resource define global
-properties of the Storage daemon. Each Storage daemon configuration file must
-have one and only one Storage resource definition.
+En g\'en\'eral, les propri\'et\'es sp\'ecifi\'ees au niveau de la ressource Storage d\'efinissent
+des propri\'et\'es globales du Storage Daemon. Chaque fichier de configuration de
+Storage Daemon doit avoir sa propre d\'efinition de ressource Storage.
\begin{description}
\item [Name = \lt{}Storage-Daemon-Name\gt{}]
- \index[sd]{Name }
- Specifies the Name of the Storage daemon. This directive is required.
-
-\item [Working Directory = \lt{}Directory\gt{}]
- \index[sd]{Working Directory }
- This directive is mandatory and specifies a directory in which the Storage
- daemon may put its status files. This directory should be used only by {\bf
- Bacula}, but may be shared by other Bacula daemons provided the names
- given to each daemon are unique. This directive is
- required
-
-\item [Pid Directory = \lt{}Directory\gt{}]
- \index[sd]{Pid Directory }
- This directive is mandatory and specifies a directory in which the Director
- may put its process Id file files. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
- This directive is required. Standard shell expansion of the {\bf Directory}
- is done when the configuration file is read so that values such as {\bf
- \$HOME} will be properly expanded.
-
- Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
- not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[sd]{Heartbeat Interval }
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
+ Sp\'ecifie le nom du Storage Daemon. Cette directive est requise.
+\item [Working Directory = \lt{}R\'epertoire\gt{}]
+ \index[sd]{Working Directory}
+ \index[sd]{Directive!Working Directory}
+ Cette directive sp\'ecifie un r\'epertoire o\`u le Storage Daemon peut placer ses fichiers
+ d'\'etat. Ce r\'epertoire ne devrait \^etre utilis\'e que par Bacula, mais peut \^etre
+ partag\'e par d'autres daemons Bacula, pourvu que les noms donn\'es \`a chaque daemon
+ soient uniques. Cette directive est requise.
+
+\item [Pid Directory = \lt{}R\'epertoire\gt{}]
+ \index[sd]{Pid Directory}
+ \index[sd]{Directive!Pid Directory}
+ Cette directive sp\'ecifie un r\'epertoire o\`u le Storage Daemon peut d\'eposer son fichier
+d'Id de processus. Ce fichier est utilis\'e pour stopper Bacula et pr\'evenir l'ex\'ecution
+simultan\'ee de plusieurs copies de Bacula. Les substitutions shell standard sont
+effectu\'ees \`a la lecture du fichier de configuration, de sorte que des valeurs
+telles que {\bf \$HOME} seront correctement substitu\'ees.
+
+Typiquement, sur les syst\`emes Linux, vous utiliserez ici {\bf /var/run}. Si vous
+n'installez pas Bacula dans les r\'epertoires syst\`eme, vous pouvez utiliser le
+r\'epertoire de travail {\bf Working Directory} d\'efini plus haut.
+Cette directive est requise.
+
+\item [Heartbeat Interval = \lt{}P\'eriode\gt{}]
+ \index[sd]{Heartbeat Interval}
+ \index[sd]{Directive!Heartbeat Interval}
\index[general]{Heartbeat Interval}
\index[general]{Broken pipe}
- This directive defines an interval of time. When the Storage daemon is
- waiting for the operator to mount a tape, each time interval, it will
- send a heartbeat signal to the File daemon. The default interval is
- zero which disables the heartbeat. This feature is particularly useful
- if you have a router such as 3Com that does not follow Internet
- standards and times out an valid connection after a short duration
- despite the fact that keepalive is set. This usually results
- in a broken pipe error message.
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+ Cette directive d\'efinit la p\'eriode des pulsations \'emises par le Storage Daemon
+ vers le File Daemon lorqu'il (le SD) se trouve en situation d'attente du montage
+ d'une cartouche par l'op\'erateur. La valeur par d\'efaut est z\'ero, ce qui d\'esactive
+ les pulsations. Cette fonctionnalit\'e est particuli\`erement utile si vous avez un
+ routeur (tel que les 3Com) qui ne suit pas les standards Internet et expire une
+ connection valide apr\`es une courte dur\'ee, bien que {\it keepalive} soit activ\'e.
+ Ceci produit habituellement un message d'erreur du type {\it broken pipe}.
+
+\item [Maximum Concurrent Jobs = \lt{}nombre\gt{}]
\index[sd]{Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs that should run
- concurrently. The default is set to 10, but you may set it to a larger
- number. 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 {\bf
- status} request in the console at the same time as a Job is running, you
- will need to set this value greater than 1. To run simultaneous Jobs,
- you will need to set a number of other directives in the Director's
- configuration file. Which ones you set depend on what you want, but you
- will almost certainly need to set the {\bf Maximum Concurrent Jobs} in
- the Storage resource in the Director's configuration file and possibly
- those in the Job and Client resources.
-
-\item [SDAddresses = \lt{}IP-address-specification\gt{}]
+ \index[sd]{Directive!Maximum Concurrent Jobs}
+ O\`u \lt{}nombre\gt{} est nombre maximal de jobs qui peuvent \^etre ex\'ecut\'es
+ simultan\'ement. La valeur par d\'efaut est fix\'ee \`a 10, mais vous pouvez d\'efinir
+ une valeur plus grande. Chaque connexion depuis le Director (par exemple
+ une requ\^ete de statut, le lancement d'un job...) est consid\'er\'ee comme un job,
+ aussi, si vous voulez conserver la possibilit\'e d'utiliser la commande
+ {\bf status} dans la console alors qu'un job est en cours d'ex\'ecution, vous
+ devez utiliser une valeur strictement sup\'erieure \`a 1. Pour ex\'ecuter plusieurs
+ jobs simultan\'ement, vous devez param\'etrer plusieurs autres directives dans le
+ fichier de configuration du Director. Selon ce que vous voulez faire, il faudra
+ intervenir sur l'un ou l'autre param\`etre, mais vous devrez presque surement
+ r\'egler le param\`etre {\bf Maximum Concurrent Jobs} de la ressource Storage du
+ fichier de configuration du Director, et peut-\^etre aussi ceux des ressources
+ Job et Client.
+
+\item [SDAddresses = \lt{}Adresse IP\gt{}]
\index[sd]{SDAddresses}
- Specify the ports and addresses on which the Storage daemon will listen
- for Director connections. Normally, the default is sufficient and you
- do not need to specify this directive. Probably the simplest way to
- explain how this directive works is to show an example:
-
+ \index[sd]{Directive!SDAddresses}
+ Pr\'ecise les ports et adresses sur lesquels le Storage Daemon est \`a
+ l'\'ecoute de connections du Director. En principe, les valeurs par d\'efaut sont
+ suffisantes, et vous n'avez pas besoin d'utiliser cette directive. La meilleure
+ explication du fonctionnement de cette directive est certainement un exemple :
+
\footnotesize
\begin{verbatim}
SDAddresses = { ip = {
\end{verbatim}
\normalsize
-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.
-
-Using this directive, you can replace both the SDPort and SDAddress
-directives shown below.
-
-\item [SDPort = \lt{}port-number\gt{}]
- \index[sd]{SDPort }
- Specifies port number on which the Storage daemon listens for Director
- connections. The default is 9103.
+o\`u "ip", "ip4", "ip6", "addr", et "port" sont des mots-clef. Notez que les adresses
+peuvent \^etre sp\'ecifi\'ees sous forme de quadruplets point\'es, de nom symboliques
+(uniquement dans la sp\'ecification "ip") ou en notation IPv6 \`a double points. Le port
+peut quand \`a lui \^etre sp\'ecifi\'e par son num\'ero, ou par sa valeur mn\'emonique du
+fichier /etc/services. Si un port n'est pas sp\'ecifi\'e, la valeur par d\'efaut est
+utilis\'ee. Si une section ip est sp\'ecifi\'ee, la r\'esolution peut \^etre r\'ealis\'ee
+par ipv4 ou ipv6. En revanche, si ip4 ou ip6 est sp\'ecifi\'ee, seule la r\'esolution
+correspondante fonctionne.
+
+Vous pouvez, avec ces directives, remplacer les valeurs des directives SDPort et
+SDAddress montr\'ees ci-dessous.
+
+\item [SDPort = \lt{}Num\'ero de port\gt{}]
+ \index[sd]{SDPort}
+ \index[sd]{Directive!SDPort}
+ Sp\'ecifie le num\'ero de port sur lequel le Storage Daemon \'ecoute les connexions
+ en provenance du Director. La valeur par d\'efaut est 9103.
-\item [SDAddress = \lt{}IP-Address\gt{}]
- \index[sd]{SDAddress }
- This directive is optional, and if it is specified, it will cause the Storage
- daemon server (for Director and File daemon connections) to bind to the
- specified {\bf IP-Address}, which is either a domain name or an IP address
- specified as a dotted quadruple. If this directive is not specified, the
- Storage daemon will bind to any available address (the default).
+\item [SDAddress = \lt{}Adresse IP\gt{}]
+ \index[sd]{SDAddress}
+ \index[sd]{Directive!SDAddress}
+ Cette directive est optionnelle. Lorsqu'elle est sp\'ecifi\'ee, le Storage Daemon n'accepte
+ de connections (de Director(s) ou de File(s) Daemon(s)) que de l'adresse sp\'ecifi\'ee
+ {\bf Adresse-IP}, qui peut \^etre
+ soit un nom de domaine, soit une adresse IP au format quadruplet point\'e.
+ Si cette directive n'est pas sp\'ecifi\'ee, le Storage Daemon acceptera des connections de
+ de toute adresse valide.
\end{description}
-The following is a typical Storage daemon Storage definition.
+Voici une d\'efinition typique d'une ressource Storage Daemon :
+
\footnotesize
\begin{verbatim}
\end{verbatim}
\normalsize
-\subsection*{Director Resource}
+\subsection*{La ressource Director}
\label{DirectorResource1}
-\index[general]{Director Resource}
+\index[general]{Ressource Director}
\index[general]{Resource!Director}
-\addcontentsline{toc}{subsection}{Director Resource}
+\addcontentsline{toc}{subsection}{La ressource Director}
-The Director resource specifies the Name of the Director which is permitted
-to use the services of the Storage daemon. There may be multiple Director
-resources. The Director Name and Password must match the corresponding
-values in the Director's configuration file.
+La ressource Director sp\'ecifie le nom du Director qui est autoris\'e
+\`a utiliser les services du Storage Daemon. Il peut exister plusieurs
+ressources Director. Le nom et le mot de passe du Director doivent
+s'accorder avec leurs homologues dans le fichier de configuration
+du Storage Daemon.
\begin{description}
-\item [Name = \lt{}Director-Name\gt{}]
- \index[sd]{Name }
- Specifies the Name of the Director allowed to connect to the Storage daemon.
- This directive is required.
+\item [Name = \lt{}Nom-du-Director\gt{}]
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
+ Sp\'ecifie le nom du Director autoris\'e \`a se connecter au Storage Daemon.
+ Cette directive est requise.
-\item [Password = \lt{}Director-password\gt{}]
- \index[sd]{Password }
- Specifies the password that must be supplied by the above named Director.
- This directive is required.
+\item [Password = \lt{}Mot-de-passe-du-Director\gt{}]
+ \index[sd]{Password}
+ \index[sd]{Directive!Password}
+ Sp\'ecifie le mot de passe qui doit \^etre soumis par le Director susnomm\'e.
+ Cette directive est requise.
\item [Monitor = \lt{}yes|no\gt{}]
- \index[sd]{Monitor }
- If Monitor is set to {\bf no} (default), this director will have full
- access to this Storage daemon. If Monitor is set to {\bf yes}, this
- director will only be able to fetch the current status of this Storage
- daemon.
+ \index[sd]{Monitor}
+ \index[sd]{Directive!Monitor}
+ Si cette directive est d\'esactiv\'ee ({\bf no}), ce qui est le cas par d\'efaut,
+ ce Director dispose d'un acc\`es illimit\'e \`a ce Storage Daemon. Dans le cas
+ contraire, ce Director est brid\'e de fa\\ 3on \`a pouvoir seulement r\'ecup\'erer le
+ statut courant de ce Storage Daemon.
- Please note that if this director is being used by a Monitor, we highly
- recommend to set this directive to {\bf yes} to avoid serious security
- problems.
+ Si ce Director est utilis\'e par un superviseur, nous vous recommandons
+ fortement d'activer cette directive pour \'eviter de s\'erieux probl\`emes de
+ s\'ecurit\'e.
\end{description}
-The following is an example of a valid Director resource definition:
+Voici un exemple d'une d\'efinition de ressource Director valide :
\footnotesize
\begin{verbatim}
\normalsize
\label{DeviceResource}
-\subsection*{Device Resource}
+\subsection*{La Ressource Device}
\index[general]{Resource!Device}
-\index[general]{Device Resource}
-\addcontentsline{toc}{subsection}{Device Resource}
+\index[general]{Ressource Device}
+\addcontentsline{toc}{subsection}{Ressource Device}
-The Device Resource specifies the details of each device (normally a tape
-drive) that can be used by the Storage daemon. There may be multiple
-Device resources for a single Storage daemon. In general, the properties
-specified within the Device resource are specific to the Device.
+La ressource Device sp\'ecifie les d\'etails de chaque p\'eriph\'erique (en g\'en\'eral,
+un lecteur de bandes) qui peut \^etre utilis\'e par le Storage Daemon. Un
+Storage Daemon peut disposer de plusieurs ressources Device. En g\'en\'eral,
+les propri\'et\'es sp\'ecifi\'ees dans la ressource Device sont sp\'ecifiques
+au p\'eriph\'erique.
\begin{description}
-\item [Name = {\it Device-Name}]
- \index[sd]{Name }
- Specifies the Name that the Director will use when asking to backup or
- restore to or from to this device. This is the logical Device name, and may
- be any string up to 127 characters in length. It is generally a good idea to
- make it correspond to the English name of the backup device. The physical
- name of the device is specified on the {\bf Archive Device} directive
- described below. The name you specify here is also used in your Director's
- conf file on the
- \ilink{Device directive}{StorageResource2} in its Storage
- resource.
+\item [Name = {\it Nom-de-p\'eriph\'erique}]
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
+ Sp\'ecifie le nom que le Director devra utiliser pour d\'esigner ce p\'eriph\'erique.
+ Il s'agit d'un nom logique, c'est une cha\^ine qui peut comporter jusqu'\`a 127
+ caract\`eres. C'est en g\'en\'eral une bonne id\'ee d'utiliser un nom qui corresponde
+ au nom "humain" du p\'eriph\'erique (NDT: la vo dit "the english name"). Le nom
+ physique du p\'eriph\'erique est sp\'ecifi\'e au niveau de la directive {\bf Archive Device}
+ d\'ecrite ci-dessous. Le nom que vous sp\'ecifiez ici est aussi utilis\'e dans le
+ fichier de configuration de votre Director au niveau de la
+ \ilink{directive Device}{StorageResource2} de sa ressource Storage.
\item [Archive Device = {\it name-string}]
- \index[sd]{Archive Device }
+ \index[sd]{Archive Device}
+ \index[sd]{Directive!Archive Device}
The specified {\bf name-string} gives the system file name of the storage
device managed by this storage daemon. This will usually be the device file
name of a removable storage device (tape drive), for example "{\bf
The Archive Device directive is required.
+\item [Device Type = {\it type-specification}]
+ \index[sd]{Device Type}
+ \index[sd]{Directive!Device Type}
+ The Device Type specification allows you to explicitly tell Bacula
+ what kind of device you are defining. It the {\it type-specification}
+ may be one of the following:
+ \begin{description}
+ \item [File]
+ Tells Bacula that the device is a file. It may either be a
+ file defined on fixed medium or a removable filesystem such as
+ USB. All files must be random access devices.
+ \item [Tape]
+ The device is a tape device and thus is sequential access. Tape devices
+ are controlled using ioctl() calls.
+ \item [Fifo]
+ The device is a first-in-first out sequential access read-only
+ or write-only device.
+ \item [DVD]
+ The device is a DVD. DVDs are sequential access for writing, but
+ random access for reading.
+ \end{description}
+
+ The Device Type directive is not required, and if not specified, Bacula
+ will attempt to guess what kind of device has been specified using the
+ Archive Device specification supplied. There are several advantages to
+ explicitly specifying the Device Type. First, on some systems, block and
+ character devices have the same type, which means that on those systems,
+ Bacula is unlikely to be able to correctly guess that a device is a DVD.
+ Secondly, if you explicitly specify the Device Type, the mount point
+ need not be defined until the device is opened. This is the case with
+ most removable devices such as USB that are mounted by the HAL daemon.
+ If the Device Type is not explicitly specified, then the mount point
+ must exist when the Storage daemon starts.
+
+ This directive was implemented in Bacula version 1.38.6.
+
+
\item [Media Type = {\it name-string}]
- \index[sd]{Media Type }
- The specified {\bf name-string} names the type of media supported by this
- device, for example, "DLT7000". Media type names are arbitrary in that you
- set it to anything you want, but must be known to the volume database to keep
- track of which storage daemons can read which volumes. The same {\bf
- name-string} must appear in the appropriate Storage resource definition in
- the Director's configuration file.
+ \index[sd]{Media Type}
+ \index[sd]{Directive!Media Type}
+ The specified {\bf name-string} names the type of media supported by this
+ device, for example, "DLT7000". Media type names are arbitrary in that you
+ set them to anything you want, but they must be known to the volume
+ database to keep track of which storage daemons can read which volumes. In
+ general, each different storage type should have a unique Media Type
+ associated with it. The same {\bf name-string} must appear in the
+ appropriate Storage resource definition in the Director's configuration
+ file.
- Even though the names you assign are arbitrary (i.e. you choose the name you
- want), you should take care in specifying them because the Media Type is used
- to determine which storage device Bacula will select during restore. Thus you
- should probably use the same Media Type specification for all drives where
- the Media can be freely interchanged. This is not generally an issue if you
- have a single Storage daemon, but it is with multiple Storage daemons,
- especially if they have incompatible media.
+ Even though the names you assign are arbitrary (i.e. you choose the name
+ you want), you should take care in specifying them because the Media Type
+ is used to determine which storage device Bacula will select during
+ restore. Thus you should probably use the same Media Type specification
+ for all drives where the Media can be freely interchanged. This is not
+ generally an issue if you have a single Storage daemon, but it is with
+ multiple Storage daemons, especially if they have incompatible media.
- For example, if you specify a Media Type of "DDS-4" then during the
- restore, Bacula will be able to choose any Storage Daemon that handles
- "DDS-4". If you have an autochanger, you might want to name the Media Type
- in a way that is unique to the autochanger, unless you wish to possibly use
- the Volumes in other drives. You should also ensure to have unique Media
- Type names if the Media is not compatible between drives. This specification
- is required for all devices.
+ For example, if you specify a Media Type of "DDS-4" then during the
+ restore, Bacula will be able to choose any Storage Daemon that handles
+ "DDS-4". If you have an autochanger, you might want to name the Media Type
+ in a way that is unique to the autochanger, unless you wish to possibly use
+ the Volumes in other drives. You should also ensure to have unique Media
+ Type names if the Media is not compatible between drives. This
+ specification is required for all devices.
+
+ In addition, if you are using disk storage, each Device resource will
+ generally have a different mount point or directory. In order for
+ Bacula to select the correct Device resource, each one must have a
+ unique Media Type.
\label{Autochanger}
\item [Autochanger = {\it Yes|No}]
\index[sd]{Autochanger}
+ \index[sd]{Directive!Autochanger}
If {\bf Yes}, this device belongs to an automatic tape changer, and you should also
specify a {\bf Changer Device} as well as a {\bf Changer Command}. If {\bf
No} (default), the volume must be manually changed. You should also
configuration file so that when labeling tapes you are prompted for the slot.
\item [Changer Device = {\it name-string}]
- \index[sd]{Changer Device }
+ \index[sd]{Changer Device}
+ \index[sd]{Directive!Changer Device}
The specified {\bf name-string} must be the {\bf generic SCSI} device
name of the autochanger that corresponds to the normal read/write
{\bf Archive Device} specified in the Device resource. This
autochanger directives.
\item [Changer Command = {\it name-string}]
- \index[sd]{Changer Command }
+ \index[sd]{Changer Command}
+ \index[sd]{Directive!Changer Command}
The {\bf name-string} specifies an external program to be called that will
automatically change volumes as required by {\bf Bacula}. Most frequently,
you will specify the Bacula supplied {\bf mtx-changer} script as follows:
scripts in {\bf examples/autochangers}.
\item [Alert Command = {\it name-string}]
- \index[sd]{Alert Command }
+ \index[sd]{Alert Command}
The {\bf name-string} specifies an external program to be called at the
+ \index[sd]{Directive!Changer Command}
completion of each Job after the device is released. The purpose of this
command is to check for Tape Alerts, which are present when something is
wrong with your tape drive (at least for most modern tape drives). The same
\item [Drive Index = {\it number}]
\index[sd]{Drive Index}
+ \index[sd]{Directive!Drive Index}
The {\bf Drive Index} that you specify is passed to the {\bf mtx-changer}
script and is thus passed to the {\bf mtx} program. By default, the Drive
Index is zero, so if you have only one drive in your autochanger, everything
\item [Autoselect = {\it Yes|No}]
\index[sd]{Autoselect}
+ \index[sd]{Directive!Autoselect}
If this directive is set to {\bf yes} (default), and the Device
belongs to an autochanger, then when the Autochanger is referenced
by the Director, this device can automatically be selected. If this
backup or restore operations.
\item [Maximum Changer Wait = {\it time}]
- \index[sd]{Maximum Changer Wait }
- This directive specifies the maximum time for Bacula to wait for an
- autochanger to change the volume. If this time is exceeded, Bacula will
- invalidate the Volume slot number stored in the catalog and try again. If no
- additional changer volumes exist, Bacula will ask the operator to intervene.
- The default time out is 5 minutes.
+ \index[sd]{Maximum Changer Wait}
+ \index[sd]{Directive!Maximum Changer Wait}
+ This directive specifies the maximum time in seconds for Bacula to wait
+ for an autochanger to change the volume. If this time is exceeded,
+ Bacula will invalidate the Volume slot number stored in the catalog and
+ try again. If no additional changer volumes exist, Bacula will ask the
+ operator to intervene. The default is 5 minutes.
+
+\item [Maximum Rewind Wait = {\it time}]
+ \index[sd]{Maximum Rewind Wait}
+ \index[sd]{Directive!Maximum Rewind Wait}
+ This directive specifies the maximum time in seconds for Bacula to wait
+ for a rewind before timing out. If this time is exceeded,
+ Bacula will cancel the job. The default is 5 minutes.
+
+\item [Maximum Open Wait = {\it time}]
+ \index[sd]{Maximum Open Wait}
+ \index[sd]{Directive!Maximum Open Wait}
+ This directive specifies the maximum time in seconds for Bacula to wait
+ for a open before timing out. If this time is exceeded,
+ Bacula will cancel the job. The default is 5 minutes.
\item [Always Open = {\it Yes|No}]
- \index[sd]{Always Open }
- If {\bf Yes} (default), Bacula will always keep the device open unless
- specifically {\bf unmounted} by the Console program. This permits Bacula to
- ensure that the tape drive is always available. If you set {\bf AlwaysOpen}
- to {\bf no} {\bf Bacula} will only open the drive when necessary, and at the
- end of the Job if no other Jobs are using the drive, it will be freed. The
- next time Bacula wants to append to a tape on a drive that was freed, Bacula
- must rewind the tape and position to the end. To avoid unnecessary tape positioning
- and to minimize unnecessary operator intervention, it is highly recommended that
- {\bf Always Open = yes}. This also ensures that the drive is available when
- Bacula needs it.
+ \index[sd]{Always Open}
+ \index[sd]{Directive!Always Open}
+ If {\bf Yes} (default), Bacula will always keep the device open unless
+ specifically {\bf unmounted} by the Console program. This permits
+ Bacula to ensure that the tape drive is always available. If you set
+ {\bf AlwaysOpen} to {\bf no} {\bf Bacula} will only open the drive when
+ necessary, and at the end of the Job if no other Jobs are using the
+ drive, it will be freed. The next time Bacula wants to append to a tape
+ on a drive that was freed, Bacula must rewind the tape and position to
+ the end. To avoid unnecessary tape positioning and to minimize
+ unnecessary operator intervention, it is highly recommended that {\bf
+ Always Open = yes}. This also ensures that the drive is available when
+ Bacula needs it.
If you have {\bf Always Open = yes} (recommended) and you want to use the
drive for something else, simply use the {\bf unmount} command in the Console
operation.
\item [Volume Poll Interval = {\it time}]
- \index[sd]{Volume Poll Interval }
+ \index[sd]{Volume Poll Interval}
+ \index[sd]{Directive!Volume Poll Interval}
If the time specified on this directive is non-zero, after asking the
operator to mount a new volume Bacula will periodically poll (or read) the
drive at the specified interval to see if a new volume has been mounted. If
\item [Close on Poll= {\it Yes|No}]
\index[sd]{Close on Poll}
+ \index[sd]{Directive!Close on Poll}
If {\bf Yes}, Bacula close the device (equivalent to an unmount except no
mount is required) and reopen it at each poll. Normally this is not too
useful unless you have the {\bf Offline on Unmount} directive set, in which
Please see above more more details.
\item [Maximum Open Wait = {\it time}]
- \index[sd]{Maximum Open Wait }
- This directive specifies the maximum amount of time that Bacula will wait for
- a device that is busy. The default is 5 minutes. If the device cannot be
- obtained, the current Job will be terminated in error. Bacula will re-attempt
- to open the drive the next time a Job starts that needs the the drive.
+ \index[sd]{Maximum Open Wait}
+ \index[sd]{Directive!Maximum Open Wait}
+ This directive specifies the maximum amount of time in seconds that
+ Bacula will wait for a device that is busy. The default is 5 minutes.
+ If the device cannot be obtained, the current Job will be terminated in
+ error. Bacula will re-attempt to open the drive the next time a Job
+ starts that needs the the drive.
\item [Removable media = {\it Yes|No}]
- \index[sd]{Removable media }
- If {\bf Yes}, this device supports removable media (for example, tapes or
- CDs). If {\bf No}, media cannot be removed (for example, an intermediate
- backup area on a hard disk).
+ \index[sd]{Removable media}
+ \index[sd]{Directive!Removable media}
+ If {\bf Yes}, this device supports removable media (for example, tapes
+ or CDs). If {\bf No}, media cannot be removed (for example, an
+ intermediate backup area on a hard disk).
\item [Random access = {\it Yes|No}]
- \index[sd]{Random access }
- If {\bf Yes}, the archive device is assumed to be a random access medium
- which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
- during configuration) facility.
+ \index[sd]{Random access}
+ \index[sd]{Directive!Random access}
+ If {\bf Yes}, the archive device is assumed to be a random access medium
+ which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
+ during configuration) facility.
\item [Minimum block size = {\it size-in-bytes}]
- \index[sd]{Minimum block size }
- On most modern tape drives, you will not need or wamt to specify this directive, and
- if you do so, it will be to make Bacula use fixed block sizes. This
- statement applies only to non-random access devices (e.g. tape drives).
- Blocks written by the storage daemon to a non-random archive device will
- never be smaller than the given {\bf size-in-bytes}. The Storage daemon will
- attempt to efficiently fill blocks with data received from active sessions
- but will, if necessary, add padding to a block to achieve the required
- minimum size.
+ \index[sd]{Minimum block size}
+ \index[sd]{Directive!Minimum block size}
+ On most modern tape drives, you will not need or wamt to specify this
+ directive, and if you do so, it will be to make Bacula use fixed block
+ sizes. This statement applies only to non-random access devices (e.g.
+ tape drives). Blocks written by the storage daemon to a non-random
+ archive device will never be smaller than the given {\bf size-in-bytes}.
+ The Storage daemon will attempt to efficiently fill blocks with data
+ received from active sessions but will, if necessary, add padding to a
+ block to achieve the required minimum size.
- To force the block size to be fixed, as is the case for some non-random
- access devices (tape drives), set the {\bf Minimum block size} and the {\bf
- Maximum block size} to the same value (zero included). The default is that
- both the minimum and maximum block size are zero and the default block size
- is 64,512 bytes. If you wish the block size to be fixed and different from
- the default, specify the same value for both {\bf Minimum block size} and
- {\bf Maximum block size}.
+ To force the block size to be fixed, as is the case for some non-random
+ access devices (tape drives), set the {\bf Minimum block size} and the
+ {\bf Maximum block size} to the same value (zero included). The default
+ is that both the minimum and maximum block size are zero and the default
+ block size is 64,512 bytes. If you wish the block size to be fixed and
+ different from the default, specify the same value for both {\bf Minimum
+ block size} and {\bf Maximum block size}.
For example, suppose you want a fixed block size of 100K bytes, then you
would specify:
\normalsize
\item [Maximum block size = {\it size-in-bytes}]
- \index[sd]{Maximum block size }
- On most modern tape drives, you will not need to specify this directive. If
- you do so, it will most likely be to use fixed block sizes (see Minimum block
- size above). The Storage daemon will aways attempt to write blocks of the
- specified {\bf size-in-bytes} to the archive device. As a consequence, this
- statement specifies both the default block size and the maximum block size.
- The size written never exceed the given {\bf size-in-bytes}. If adding data
- to a block would cause it to exceed the given maximum size, the block will be
- written to the archive device, and the new data will begin a new block.
+ \index[sd]{Maximum block size}
+ \index[sd]{Directive!Maximum block size}
+ On most modern tape drives, you will not need to specify this directive.
+ If you do so, it will most likely be to use fixed block sizes (see
+ Minimum block size above). The Storage daemon will aways attempt to
+ write blocks of the specified {\bf size-in-bytes} to the archive device.
+ As a consequence, this statement specifies both the default block size
+ and the maximum block size. The size written never exceed the given
+ {\bf size-in-bytes}. If adding data to a block would cause it to exceed
+ the given maximum size, the block will be written to the archive device,
+ and the new data will begin a new block.
- If no value is specified or zero is specified, the Storage daemon will use a
- default block size of 64,512 bytes (126 * 512).
+ If no value is specified or zero is specified, the Storage daemon will
+ use a default block size of 64,512 bytes (126 * 512).
\item [Hardware End of Medium = {\it Yes|No}]
- \index[sd]{Hardware End of Medium }
+ \index[sd]{Hardware End of Medium}
+ \index[sd]{Directive!Hardware End of Medium}
If {\bf No}, the archive device is not required to support end of medium
ioctl request, and the storage daemon will use the forward space file
function to find the end of the recorded data. If {\bf Yes}, the archive
feature.
\item [Fast Forward Space File = {\it Yes|No}]
- \index[sd]{Fast Forward Space File }
+ \index[sd]{Fast Forward Space File}
+ \index[sd]{Directive!Fast Forward Space File}
If {\bf No}, the archive device is not required to support keeping track of
the file number ({\bf MTIOCGET} ioctl) during forward space file. If {\bf
Yes}, the archive device must support the {\tt ioctl} {\tt MTFSF} call, which
Default setting for Fast Forward Space File is {\bf Yes}.
\item [Use MTIOCGET = {\it Yes|No}]
- \index[sd]{Fast Forward Space File }
+ \index[sd]{Fast Forward Space File}
+ \index[sd]{Directive!Fast Forward Space File}
If {\bf No}, the operating system is not required to support keeping track of
the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
is {\bf Yes}. If you must set this to No, Bacula will do the proper file
Solaris, Linux and FreeBSD.
\item [BSF at EOM = {\it Yes|No}]
- \index[sd]{BSF at EOM }
+ \index[sd]{BSF at EOM}
+ \index[sd]{Directive!BSF at EOM}
If {\bf No}, the default, no special action is taken by Bacula with the End
of Medium (end of tape) is reached because the tape will be positioned after
the last EOF tape mark, and Bacula can append to the tape as desired.
is done using the {\bf test} command in the {\bf btape} program.
\item [TWO EOF = {\it Yes|No}]
- \index[sd]{TWO EOF }
+ \index[sd]{TWO EOF}
+ \index[sd]{Directive!TWO EOF}
If {\bf Yes}, Bacula will write two end of file marks when terminating a tape
-- i.e. after the last job or at the end of the medium. If {\bf No}, the
default, Bacula will only write one end of file to terminate the tape.
\item [Backward Space Record = {\it Yes|No}]
\index[sd]{Backward Space Record}
+ \index[sd]{Directive!Backward Space Record}
If {\it Yes}, the archive device supports the {\tt MTBSR ioctl} to backspace
records. If {\it No}, this call is not used and the device must be rewound
and advanced forward to the desired position. Default is {\bf Yes} for non
precautionary rather than required.
\item [Backward Space File = {\it Yes|No}]
- \index[sd]{Backward Space File }
+ \index[sd]{Backward Space File}
+ \index[sd]{Directive!Backward Space File}
If {\it Yes}, the archive device supports the {\bf MTBSF} and {\bf MTBSF
ioctl}s to backspace over an end of file mark and to the start of a file. If
{\it No}, these calls are not used and the device must be rewound and
random-access devices.
\item [Forward Space Record = {\it Yes|No}]
- \index[sd]{Forward Space Record }
+ \index[sd]{Forward Space Record}
+ \index[sd]{Directive!Forward Space Record}
If {\it Yes}, the archive device must support the {\bf MTFSR ioctl} to
forward space over records. If {\bf No}, data must be read in order to
advance the position on the device. Default is {\bf Yes} for non
random-access devices.
\item [Forward Space File = {\it Yes|No}]
- \index[sd]{Forward Space File }
+ \index[sd]{Forward Space File}
+ \index[sd]{Directive!Forward Space File}
If {\bf Yes}, the archive device must support the {\tt MTFSF ioctl} to
forward space by file marks. If {\it No}, data must be read to advance the
position on the device. Default is {\bf Yes} for non random-access devices.
\item [Offline On Unmount = {\it Yes|No}]
- \index[sd]{Offline On Unmount }
+ \index[sd]{Offline On Unmount}
+ \index[sd]{Directive!Offline On Unmount}
The default for this directive is {\bf No}. If {\bf Yes} the archive device
must support the {\tt MTOFFL ioctl} to rewind and take the volume offline. In
this case, Bacula will issue the offline (eject) request before closing the
\item [Maximum Volume Size = {\it size}]
- \index[sd]{Maximum Volume Size }
- No more than {\bf size} bytes will be written onto a given volume on the
- archive device. This directive is used mainly in testing Bacula to simulate a
- small Volume. It can also be useful if you wish to limit the size of a File
- Volume to say less than 2GB of data. In some rare cases of really antiquated
- tape drives that do not properly indicate when the end of a tape is reached
- during writing (though I have read about such drives, I have never personally
- encountered one). Please note, this directive is deprecated (being phased
- out) in favor of the {\bf Maximum Volume Bytes} defined in the Director's
- configuration file.
+ \index[sd]{Maximum Volume Size}
+ \index[sd]{Directive!Maximum Volume Size}
+ No more than {\bf size} bytes will be written onto a given volume on the
+ archive device. This directive is used mainly in testing Bacula to
+ simulate a small Volume. It can also be useful if you wish to limit the
+ size of a File Volume to say less than 2GB of data. In some rare cases
+ of really antiquated tape drives that do not properly indicate when the
+ end of a tape is reached during writing (though I have read about such
+ drives, I have never personally encountered one). Please note, this
+ directive is deprecated (being phased out) in favor of the {\bf Maximum
+ Volume Bytes} defined in the Director's configuration file.
\item [Maximum File Size = {\it size}]
- \index[sd]{Maximum File Size }
- No more than {\bf size} bytes will be written into a given logical file on
- the volume. Once this size is reached, an end of file mark is written on the
- volume and subsequent data are written into the next file. Breaking long
- sequences of data blocks with file marks permits quicker positioning to the
- start of a given stream of data and can improve recovery from read errors on
- the volume. The default is one Gigabyte.
+ \index[sd]{Maximum File Size}
+ \index[sd]{Directive!Maximum File Size}
+ No more than {\bf size} bytes will be written into a given logical file
+ on the volume. Once this size is reached, an end of file mark is
+ written on the volume and subsequent data are written into the next
+ file. Breaking long sequences of data blocks with file marks permits
+ quicker positioning to the start of a given stream of data and can
+ improve recovery from read errors on the volume. The default is one
+ Gigabyte.
\item [Block Positioning = {\it yes|no}]
- \index[sd]{Block Positioning }
+ \index[sd]{Block Positioning}
+ \index[sd]{Directive!Block Positioning}
This directive is not normally used (and has not yet been tested). It will
tell Bacula not to use block positioning when it is reading tapes. This can
cause Bacula to be {\bf extremely} slow when restoring files. You might use
hope, Bacula will be able to re-read your tapes.
\item [Maximum Network Buffer Size = {\it bytes}]
- \index[sd]{Maximum Network Buffer Size }
+ \index[sd]{Maximum Network Buffer Size}
+ \index[sd]{Directive!Maximum Network Buffer Size}
where {\it bytes} 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. Please use care in setting this value since if
\item [Maximum Spool Size = {\it bytes}]
- \index[sd]{Maximum Spool Size }
+ \index[sd]{Maximum Spool Size}
+ \index[sd]{Directive!Maximum Spool Size}
where the bytes specify the maximum spool size for all jobs that are running.
The default is no limit.
\item [Maximum Job Spool Size = {\it bytes}]
- \index[sd]{Maximum Job Spool Size }
+ \index[sd]{Maximum Job Spool Size}
+ \index[sd]{Directive!Maximum Job Spool Size}
where the bytes specify the maximum spool size for any one job that is
running. The default is no limit.
This directive is implemented only in version 1.37 and later.
\item [Spool Directory = {\it directory}]
- \index[sd]{Spool Directory }
+ \index[sd]{Spool Directory}
+ \index[sd]{Directive!Spool Directory}
specifies the name of the directory to be used to store the spool files for
this device. This directory is also used to store temporary part files when
writing to a device that requires mount (DVD). The default is to use the
working directory.
\item [Maximum Part Size = {\it bytes}]
- \index[sd]{Maximum Part Size }
+ \index[sd]{Maximum Part Size}
+ \index[sd]{Directive!Maximum Part Size}
This is the maximum size of a volume part file. The default is no limit.
This directive is implemented only in version 1.37 and later.
\addcontentsline{toc}{subsection}{Devices that require a mount (DVD)}
All the directives in this section are implemented only in
-Bacula version 1.37 and later.
+Bacula version 1.37 and later and hence are available in version 1.38.6.
+
+As of version 1.39.5, the directives
+"Requires Mount", "Mount Point", "Mount Command", and "Unmount Command"
+apply to removable filesystems such as USB in addition to DVD.
\begin{description}
\item [Requires Mount = {\it Yes|No}]
- \index[sd]{Requires Mount }
+ \index[sd]{Requires Mount}
+ \index[sd]{Directive!Requires Mount}
You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for
all other devices (tapes/files). This directive indicates if the device
requires to be mounted to be read, and if it must be written in a special way.
{\bf Write Part Command} directives must also be defined.
\item [Mount Point = {\it directory}]
- \index[sd]{Mount Point }
+ \index[sd]{Mount Point}
+ \index[sd]{Directive!Mount Point}
Directory where the device can be mounted.
\item [Mount Command = {\it name-string}]
- \index[sd]{Mount Command }
+ \index[sd]{Mount Command}
+ \index[sd]{Directive!Mount Command}
Command that must be executed to mount the device. Before the command is
executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
\normalsize
\item [Unmount Command = {\it name-string}]
- \index[sd]{Unmount Command }
+ \index[sd]{Unmount Command}
+ \index[sd]{Directive!Unmount Command}
Command that must be executed to unmount the device. Before the command is
executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
\normalsize
\item [Write Part Command = {\it name-string}]
- \index[sd]{Write Part Command }
+ \index[sd]{Write Part Command}
+ \index[sd]{Directive!Write Part Command}
Command that must be executed to write a part to the device. Before the
command is executed, \%a is replaced with the Archive Device, \%m with the
Mount Point, \%e is replaced with 1 if we are writing the first part,
\item [Free Space Command = {\it name-string}]
- \index[sd]{Free Space Command }
+ \index[sd]{Free Space Command}
+ \index[sd]{Directive!Free Space Command}
Command that must be executed to check how much free space is left on the
device. Before the command is executed,\%a is replaced with the Archive
Device, \%m with the Mount Point, \%e is replaced with 1 if we are writing
\begin{description}
\item [Label media = {\it Yes|No}]
- \index[sd]{Label media }
- If {\bf Yes}, permits this device to automatically label blank media without
- an explicit operator command. It does so by using an internal algorithm as
- defined on the
- \ilink{Label Format}{Label} record in each Pool resource. If
- this is {\bf No} as by default, Bacula will label tapes only by specific
- operator command ({\bf label} in the Console) or when the tape has been
- recycled. The automatic labeling feature is most useful when writing to disk
- rather than tape volumes.
+ \index[sd]{Label media}
+ \index[sd]{Directive!Label media}
+ If {\bf Yes}, permits this device to automatically label blank media
+ without an explicit operator command. It does so by using an internal
+ algorithm as defined on the \ilink{Label Format}{Label} record in each
+ Pool resource. If this is {\bf No} as by default, Bacula will label
+ tapes only by specific operator command ({\bf label} in the Console) or
+ when the tape has been recycled. The automatic labeling feature is most
+ useful when writing to disk rather than tape volumes.
\item [Automatic mount = {\it Yes|No}]
- \index[sd]{Automatic mount }
+ \index[sd]{Automatic mount}
+ \index[sd]{Directive!Automatic mount}
If {\bf Yes} (the default), permits the daemon to examine the device to
determine if it contains a Bacula labeled volume. This is done
initially when the daemon is started, and then at the beginning of each
projects / bacula / docs / commitdiff