supplied.
\item [Name = \lt{}name\gt{}]
+ \label{Director:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The director name used by the system administrator. This directive is
required.
\item [Description = \lt{}text\gt{}]
+ \label{Director:Description}
\index[dir]{Description}
\index[dir]{Directive!Description}
The text field contains a description of the Director that will be displayed
in the graphical user interface. This directive is optional.
\item [Password = \lt{}UA-password\gt{}]
+ \label{Director:{Password}
\index[dir]{Password}
\index[dir]{Directive!Password}
Specifies the password that must be supplied for the default Bacula
security reasons.
\item [Messages = \lt{}Messages-resource-name\gt{}]
- \index[dir]{Messages}
+ \label{Director:Messages}
\index[dir]{Directive!Messages}
The messages resource specifies where to deliver Director messages that are
not associated with a specific Job. Most messages are specific to a job and
directive is required.
\item [Working Directory = \lt{}Directory\gt{}]
+ \label{Director:WorkingDirectory}
\index[dir]{Working Directory}
\index[dir]{Directive!Working Directory}
This directive is mandatory and specifies a directory in which the Director
be set to those values.
\item [Pid Directory = \lt{}Directory\gt{}]
+ \label{Director:PidDirectory}
\index[dir]{Pid Directory}
\index[dir]{Directive!Pid Directory}
This directive is mandatory and specifies a directory in which the Director
Directory} as defined above. This directive is required.
\item [Scripts Directory = \lt{}Directory\gt{}]
+ \label{Director:ScriptsDirectory}
\index[dir]{Scripts Directory}
\index[dir]{Directive!Scripts Directory}
This directive is optional and, if defined, specifies a directory in
expanded.
\item [QueryFile = \lt{}Path\gt{}]
+ \label{Director:QueryFile}
\index[dir]{QueryFile}
\index[dir]{Directive!QueryFile}
This directive is mandatory and specifies a directory and file in which
\$HOME} will be properly expanded. This directive is required.
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
+ \label{Director:HeartbeatInterval}
\index[dir]{Heartbeat Interval}
\index[dir]{Directive!Heartbeat}
This directive is optional and if specified will cause the Director to
\label{DirMaxConJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+ \label{Director:MaximumConcurrentJobs}
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
\index[general]{Simultaneous Jobs}
thus avoiding excessive interleaving of the different job blocks.
\item [FD Connect Timeout = \lt{}time\gt{}]
+ \label{Director:FdConnectTimeout}
\index[dir]{FD Connect Timeout}
\index[dir]{Directive!FD Connect Timeout}
where {\bf time} is the time that the Director should continue
the Director will cancel the job. The default is 30 minutes.
\item [SD Connect Timeout = \lt{}time\gt{}]
+ \label{Director:SdConnectTimeout}
\index[dir]{SD Connect Timeout}
\index[dir]{Directive!SD Connect Timeout}
where {\bf time} is the time that the Director should continue
the Director will cancel the job. The default is 30 minutes.
\item [DirAddresses = \lt{}IP-address-specification\gt{}]
+ \label{Director:DirAddresses}
\index[dir]{DirAddresses}
\index[dir]{Address}
\index[general]{Address}
resource.
\item [DirPort = \lt{}port-number\gt{}]
+ \label{Director:DirPort}
\index[dir]{DirPort}
\index[dir]{Directive!DirPort}
Specify the port (a positive integer) on which the Director daemon will
directive.
\item [DirAddress = \lt{}IP-Address\gt{}]
+ \label{Director:DirAddress}
\index[dir]{DirAddress}
\index[dir]{Directive!DirAddress}
This directive is optional, but if it is specified, it will cause the
should not be used if you specify a DirAddresses (N.B. plural) directive.
\item [DirSourceAddress = \lt{}IP-Address\gt{}]
+ \label{Director:DirSourceAddress}
\index[fd]{DirSourceAddress}
\index[fd]{Directive!DirSourceAddress}
This record is optional, and if it is specified, it will cause the Director
its outgoing connections according to the system routing table (the default).
\item[Statistics Retention = \lt{}time\gt{}]
+ \label{Director:StatisticsRetention}
\index[dir]{StatisticsRetention}
\index[dir]{Directive!StatisticsRetention}
\label{PruneStatistics}
The default is 5 years.
\item[VerId = \lt{}string\gt{}]
+ \label{Director:VerId}
\index[dir]{Directive!VerId}
where \lt{}string\gt{} is an identifier which can be used for support purpose.
This string is displayed using the \texttt{version} command.
\item[MaximumConsoleConnections = \lt{}number\gt{}]
+ \label{Director:MaximumConsoleConnections}
\index[dir]{MaximumConsoleConnections}
\index[dir]{Directive!MaximumConsoleConnections}
\index[dir]{Console}
larger number.
\item[MaximumReloadRequests = \lt{}number\gt{}]
+\label{Director:MaximumReloadRequests}
\index[dir]{MaximumReloadRequests}
\index[dir]{Directive!MaximumReloadRequests}
\index[dir]{Console}
can be done while jobs are running. The default is set to 32 and is usually
sufficient.
- \item[SharedStorage = \lt{}yes\vb{}no\gt{}]
- \index[dir]{SharedStorage}
- \index[dir]{Directive!SharedStorage}
-
- The \texttt{Shared Storage} directive is a Bacula Enterprise feature that
- allows you to share volumes between different Storage resources. This
- directive should be used \textbf{only} if all \texttt{Media Type} are
- correctly set across all Devices.
-
- The \texttt{Shared Storage} directive should be used when using the SAN
- Shared Storage plugin or when accessing from the Director Storage resources
- directly to Devices of an Autochanger.
-
- When sharing volumes between different Storage resources, you will
- need also to use the \texttt{reset-storageid} script before using the
- \texttt{update slots} command. This script can be scheduled once a day in
- an Admin job.
-
-\begin{verbatim}
- $ /opt/bacula/scripts/reset-storageid MediaType StorageName
- $ bconsole
- * update slots storage=StorageName drive=0
-\end{verbatim}
-
- Please contact Bacula Systems support to get help on this advanced
- configuration.
+%\item[SharedStorage = \lt{}yes\vb{}no\gt{}]
+% \label{Director:SharedStorage}
+% \index[dir]{SharedStorage}
+% \index[dir]{Directive!SharedStorage}
+%
+% The \texttt{Shared Storage} directive is a Bacula Enterprise feature that
+% allows you to share volumes between different Storage resources. This
+% directive should be used \textbf{only} if all \texttt{Media Type} are
+% correctly set across all Devices.
+%
+% The \texttt{Shared Storage} directive should be used when using the SAN
+% Shared Storage plugin or when accessing from the Director Storage resources
+% directly to Devices of an Autochanger.
+%
+% When sharing volumes between different Storage resources, you will
+% need also to use the \texttt{reset-storageid} script before using the
+% \texttt{update slots} command. This script can be scheduled once a day in
+% an Admin job.
+%
+%\begin{verbatim}
+% $ /opt/bacula/scripts/reset-storageid MediaType StorageName
+% $ bconsole
+% * update slots storage=StorageName drive=0
+%\end{verbatim}
+%
+% Please contact Bacula Systems support to get help on this advanced
+% configuration.
\end{description}
Start of the Job resource. At least one Job resource is required.
\item [Name = \lt{}name\gt{}]
+ \label{Job:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The Job name. This name can be specified on the {\bf Run} command in the
execution. This directive is required.
\item [Enabled = \lt{}yes\vb{}no\gt{}]
+ \label{Job:Enable}
\index[dir]{Enable}
\index[dir]{Directive!Enable}
This directive allows you to enable or disable automatic execution
via the scheduler of a Job.
\item [Type = \lt{}job-type\gt{}]
+ \label{Job:Type}
\index[dir]{Type}
\index[dir]{Directive!Type}
The {\bf Type} directive specifies the Job type, which may be one of the
\label{Level}
\item [Level = \lt{}job-level\gt{}]
+\label{Job:Level}
\index[dir]{Level}
\index[dir]{Directive!Level}
The Level directive specifies the default Job level to be run. Each
\end{description}
\item [Accurate = \lt{}yes\vb{}no\gt{}]
+\label{Job:Accurate}
\index[dir]{Accurate}
In accurate mode, the File daemon knowns exactly which files were present
after the last backup. So it is able to handle deleted or renamed files.
required information.
\item [Verify Job = \lt{}Job-Resource-Name\gt{}]
+ \label{Job:VerifyJob}
\index[dir]{Verify Job}
\index[dir]{Directive!Verify Job}
If you run a verify job without this directive, the last job run will be
written is re-read.
\item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
+\label{Job:JobDefs}
\index[dir]{JobDefs}
\index[dir]{Directive!JobDefs}
If a JobDefs-Resource-Name is specified, all the values contained in the
JobDefs is provided in the default bacula-dir.conf file.
\item [Bootstrap = \lt{}bootstrap-file\gt{}]
+\label{Job:Bootstrap}
\index[dir]{Bootstrap}
\index[dir]{Directive!Bootstrap}
The Bootstrap directive specifies a bootstrap file that, if provided,
\label{writebootstrap}
\item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
+\label{Job:WriteBootstrap}
\index[dir]{Write Bootstrap}
\index[dir]{Directive!Write Bootstrap}
The {\bf writebootstrap} directive specifies a file name where Bacula
\ilink{The Bootstrap File}{BootstrapChapter} of this manual.
\item [Client = \lt{}client-resource-name\gt{}]
+\label{Job:Client}
\index[dir]{Client}
\index[dir]{Directive!Client}
The Client directive specifies the Client (File daemon) that will be used in
This directive is required.
\item [FileSet = \lt{}FileSet-resource-name\gt{}]
+\label{Job:FileSet}
\index[dir]{FileSet}
\index[dir]{Directive!FileSet}
The FileSet directive specifies the FileSet that will be used in the
this chapter. This directive is required.
\item [Base = \lt{}job-resource-name, ...\gt{}]
+\label{Job:Base}
\index[dir]{Base}
\index[dir]{Directive!Base}
The Base directive permits to specify the list of jobs that will be used during
chapter}{basejobs} for more information.
\item [Messages = \lt{}messages-resource-name\gt{}]
+\label{Job:Messages}
\index[dir]{Messages}
\index[dir]{Directive!Messages}
The Messages directive defines what Messages resource should be used for
directive is required.
\item [Pool = \lt{}pool-resource-name\gt{}]
+\label{Job:Pool}
\index[dir]{Pool}
\index[dir]{Directive!Pool}
The Pool directive defines the pool of Volumes where your data can be
section}{PoolResource} of this chapter. This directive is required.
\item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
+\label{Job:FullBackupPool}
\index[dir]{Full Backup Pool}
\index[dir]{Directive!Full Backup Pool}
The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
directive is optional.
\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
+\label{Job:DifferentialBackupPool}
\index[dir]{Differential Backup Pool}
\index[dir]{Directive!Differential Backup Pool}
The {\it Differential Backup Pool} specifies a Pool to be used for
Differential backup. This directive is optional.
\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
+\label{Job:IncrementalBackupPool}
\index[dir]{Incremental Backup Pool}
\index[dir]{Directive!Incremental Backup Pool}
The {\it Incremental Backup Pool} specifies a Pool to be used for
Incremental backup. This directive is optional.
\item [Schedule = \lt{}schedule-name\gt{}]
+\label{Job:Schedule}
\index[dir]{Schedule}
\index[dir]{Directive!Schedule}
The Schedule directive defines what schedule is to be used for the Job.
\item [Storage = \lt{}storage-resource-name\gt{}]
+\label{Job:Storage}
\index[dir]{Storage}
\index[dir]{Directive!Storage}
The Storage directive defines the name of the storage services where you
one or the other, if not an error will result.
\item [Max Start Delay = \lt{}time\gt{}]
+\label{Job:MaxStartDelay}
\index[dir]{Max Start Delay}
\index[dir]{Directive!Max Start Delay}
The time specifies the maximum delay between the scheduled time and the
which indicates no limit.
\item [Max Run Time = \lt{}time\gt{}]
+\label{Job:MaxRunTime}
\index[dir]{Max Run Time}
\index[dir]{Directive!Max Run Time}
The time specifies the maximum allowed time that a job may run, counted
\item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
+\label{Job:IncrementalWaitRunTime}
\index[dir]{Incremental Wait Run Time}
\index[dir]{Differential Wait Run Time}
\index[dir]{Directive!Differential Max Wait Time}
\texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
\item [Incremental Max Run Time = \lt{}time\gt{}]
+\label{Job:IncrementalMaxRunTime}
\index[dir]{Incremental Max Run Time}
\index[dir]{Directive!Incremental Max Run Time}
The time specifies the maximum allowed time that an Incremental backup job may
the job was scheduled).
\item [Differential Max Wait Time = \lt{}time\gt{}]
+\label{Job:DifferentialMaxRunTime}
\index[dir]{Differential Max Run Time}
\index[dir]{Directive!Differential Max Run Time}
The time specifies the maximum allowed time that a Differential backup job may
the job was scheduled).
\item [Max Run Sched Time = \lt{}time\gt{}]
+\label{Job:MaxRunSchedTime}
\index[dir]{Max Run Sched Time}
\index[dir]{Directive!Max Run Sched Time}
Time}.
\item [Max Wait Time = \lt{}time\gt{}]
+\label{Job:MaxWaitTime}
\index[dir]{Max Wait Time}
\index[dir]{Directive!Max Wait Time}
The time specifies the maximum allowed time that a job may block waiting
\end{figure}
\item [Maximum Bandwidth = \lt{}speed\gt{}]
+\label{Job:MaximumBandwidth}
\index[dir]{Maximum Bandwidth}
\index[dir]{Directive!Maximum Bandwidth}
use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
\item [Max Full Interval = \lt{}time\gt{}]
+\label{Job:MaxFullInterval}
\index[dir]{Max Full Interval}
\index[dir]{Directive!Max Full Interval}
The time specifies the maximum allowed age (counting from start time) of
\label{PreferMountedVolumes}
\item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
+\label{Job:Prefer Mounted Volumes}
\index[dir]{Prefer Mounted Volumes}
\index[dir]{Directive!Prefer Mounted Volumes}
If the Prefer Mounted Volumes directive is set to {\bf yes} (default
on different drives.
\item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
+\label{Job:PruneJobs}
\index[dir]{Prune Jobs}
\index[dir]{Directive!Prune Jobs}
Normally, pruning of Jobs from the Catalog is specified on a Client by
\item [Prune Files = \lt{}yes\vb{}no\gt{}]
+\label{Job:PruneFiles}
\index[dir]{Prune Files}
\index[dir]{Directive!Prune Files}
Normally, pruning of Files from the Catalog is specified on a Client by
default is {\bf no}.
\item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
+\label{Job:PruneVolumes}
\index[dir]{Prune Volumes}
\index[dir]{Directive!Prune Volumes}
Normally, pruning of Volumes from the Catalog is specified on a Pool by
Pool resource. The default is {\bf no}.
\item [RunScript \{\lt{}body-of-runscript\gt{}\}]
+ \label{Job:RunScript}
\index[dir]{RunScript}
\index[dir]{Directive!Run Script}
Some character substitutions are not available in all situations. The Job Exit
Status code \%e edits the following values:
+
\index[dir]{Exit Status}
\begin{itemize}
\item OK
/dev/null to prevent the script from blocking.
\item [Run Before Job = \lt{}command\gt{}]
+\label{Job:RunBeforeJob}
\index[dir]{Run Before Job}
\index[dir]{Directive!Run Before Job}
\index[dir]{Directive!Run Before Job}
before leaving will be used.
\item [Run After Job = \lt{}command\gt{}]
+\label{Job:RunAfterJob}
\index[dir]{Run After Job}
\index[dir]{Directive!Run After Job}
The specified {\bf command} is run as an external program if the current
non-normal status.
\item [Run After Failed Job = \lt{}command\gt{}]
+\label{Job:RunAfterJob}
\index[dir]{Run After Job}
\index[dir]{Directive!Run After Job}
The specified {\bf command} is run as an external program after the current
\item [Client Run Before Job = \lt{}command\gt{}]
+\label{Job:ClientRunBeforeJob}
\index[dir]{Client Run Before Job}
\index[dir]{Directive!Client Run Before Job}
This directive is the same as {\bf Run Before Job} except that the
Unix systems as noted above for the {\bf RunScript}.
\item [Client Run After Job = \lt{}command\gt{}]
+ \label{Job:ClientRunAfterJob}
\index[dir]{Client Run After Job}
\index[dir]{Directive!Client Run After Job}
The specified {\bf command} is run on the client machine as soon
concerning Windows clients.
\item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
+ \label{Job:RerunFailedLevels}
\index[dir]{Rerun Failed Levels}
\index[dir]{Directive!Rerun Failed Levels}
If this directive is set to {\bf yes} (default no), and Bacula detects that
trigger a rerun.
\item [Spool Data = \lt{}yes\vb{}no\gt{}]
+ \label{Job:SpoolData}
\index[dir]{Spool Data}
\index[dir]{Directive!Spool Data}
automatically set to yes.
\item [SpoolData=yes\vb{}no]
+ \label{Job:SpoolData}
\index[dir]{SpoolData}
\index[dir]{Directive!SpoolData}
tells Bacula to request the Storage daemon to spool data to a disk file
before writing it to the Volume (normally a tape).
\item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
+ \label{Job:SpoolAttributes}
\index[dir]{Spool Attributes}
\index[dir]{Directive!Spool Attributes}
\index[dir]{slow}
automatically set to yes.
\item [SpoolSize={\it bytes}]
+ \label{Job:SpoolSize}
\index[dir]{SpoolSize}
\index[dir]{Directive!SpoolSize}
where the bytes specify the maximum spool size for this job.
\item [Where = \lt{}directory\gt{}]
+ \label{Job:Where}
\index[dir]{Where}
\index[dir]{Directive!Where}
This directive applies only to a Restore job and specifies a prefix to
\item [Add Prefix = \lt{}directory\gt{}]
\label{confaddprefix}
+ \label{Job:AddPrefix}
\index[dir]{AddPrefix}
\index[dir]{Directive!AddPrefix}
This directive applies only to a Restore job and specifies a prefix to the
Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
\item [Add Suffix = \lt{}extention\gt{}]
+ \label{Job:AddSuffix}
\index[dir]{AddSuffix}
\index[dir]{Directive!AddSuffix}
This directive applies only to a Restore job and specifies a suffix to all
\texttt{/etc/passwsd.old}
\item [Strip Prefix = \lt{}directory\gt{}]
+ \label{Job:StripPrefix}
\index[dir]{StripPrefix}
\index[dir]{Directive!StripPrefix}
This directive applies only to a Restore job and specifies a prefix to remove
\end{verbatim}
\item [RegexWhere = \lt{}expressions\gt{}]
+ \label{Job:RegexWhere}
\index[dir]{RegexWhere}
\index[dir]{Directive!RegexWhere}
This directive applies only to a Restore job and specifies a regex filename
\ilink{this}{useregexwhere}.
\item [Replace = \lt{}replace-option\gt{}]
+ \label{Job:Replace}
\index[dir]{Replace}
\index[dir]{Directive!Replace}
This directive applies only to a Restore job and specifies what happens
\end{description}
\item [Prefix Links=\lt{}yes\vb{}no\gt{}]
+ \label{Job:PrefixLinks}
\index[dir]{Prefix Links}
\index[dir]{Directive!Prefix Links}
If a {\bf Where} path prefix is specified for a recovery job, apply it
original locations, all files linked with absolute names will be broken.
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+ \label{Job:MaximumConcurrentJobs}
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of Jobs from the current
Director's resource.
\item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
+ \label{Job:RescheduleOnError}
\index[dir]{Reschedule On Error}
\index[dir]{Directive!Reschedule On Error}
If this directive is enabled, and the job terminates in error, the job
machines that are not always connected to the network or switched on.
\item [Reschedule Interval = \lt{}time-specification\gt{}]
+ \label{Job:RescheduleInterval}
\index[dir]{Reschedule Interval}
\index[dir]{Directive!Reschedule Interval}
If you have specified {\bf Reschedule On Error = yes} and the job
rescheduled on error.
\item [Reschedule Times = \lt{}count\gt{}]
+ \label{Job:RescheduleTimes}
\index[dir]{Reschedule Times}
\index[dir]{Directive!Reschedule Times}
This directive specifies the maximum number of times to reschedule the
indefinite number of times.
\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
+\label{Job:AllowDuplicateJobs}
\index[general]{Allow Duplicate Jobs}
\begin{figure}[htbp]
will be cancelled.
\item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
+\label{Job:AllowHigherDuplicates}
\index[general]{Allow Higher Duplicates}
This directive was implemented in version 5.0.0, but does not work
as expected. If used, it should always be set to no. In later versions
\item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
+\label{Job:CancelLowerLevelDuplicates}
\index[general]{Cancel Lower Level Duplicates}
If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
directive is set to \textbf{yes}, Bacula will choose between duplicated
Cancel XXX Duplicate directives will be examined.
\item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
+\label{Job:CancelQueuedDuplicates}
\index[general]{Cancel Queued Duplicates}
If {\bf Allow Duplicate Jobs} is set to {\bf no} and
if this directive is set to {\bf yes} any job that is
The default is {\bf no}.
\item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
+\label{Job:CancelRunningDuplicates}
\index[general]{Cancel Running Duplicates}
If {\bf Allow Duplicate Jobs} is set to {\bf no} and
if this directive is set to {\bf yes} any job that is already running
%% idea to cancel it.
\item [Run = \lt{}job-name\gt{}]
+ \label{Job:Run}
\index[dir]{Run}
\index[dir]{Directive!Run}
\index[dir]{Clone a Job}
\label{Priority}
\item [Priority = \lt{}number\gt{}]
+ \label{Job:Priority}
\index[dir]{Priority}
\index[dir]{Directive!Priority}
This directive permits you to control the order in which your jobs will
\label{AllowMixedPriority}
\item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
+\label{Job:AllowMixedPriority}
\index[dir]{Allow Mixed Priority}
This directive is only implemented in version 2.5 and later. When
set to {\bf yes} (default {\bf no}), this job may run even if lower
\label{WritePartAfterJob}
\item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
+\label{Job:WritePartAfterJob}
\index[dir]{Write Part After Job}
\index[dir]{Directive!Write Part After Job}
This directive is only implemented in version 1.37 and later.
automatically started.
\item [Name = \lt{}name\gt{}]
+ \label{Schdedule:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the schedule being defined. The Name directive is required.
\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
+ \label{Schdedule:Run}
\index[dir]{Run}
\index[dir]{Directive!Run}
The Run directive defines when a Job is to be run, and what overrides if
Start of the Client directives.
\item [Name = \lt{}name\gt{}]
+ \label{Client:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The client name which will be used in the Job resource directive or in the
console run command. This directive is required.
\item [Address = \lt{}address\gt{}]
+ \label{Client:Address}
\index[dir]{Address}
\index[dir]{Directive!FD Address}
\index[dir]{File Daemon Address}
This directive is required.
\item [FD Port = \lt{}port-number\gt{}]
+ \label{Client:FdPort}
\index[dir]{FD Port}
\index[dir]{Directive!FD Port}
Where the port is a port number at which the Bacula File server daemon can
be contacted. The default is 9102.
\item [Catalog = \lt{}Catalog-resource-name\gt{}]
+ \label{Client:Catalog}
\index[dir]{Catalog}
\index[dir]{Directive!Catalog}
This specifies the name of the catalog resource to be used for this Client.
This directive is required.
\item [Password = \lt{}password\gt{}]
+ \label{Client:Password}
\index[dir]{Password}
\index[dir]{Directive!Password}
This is the password to be used when establishing a connection with the File
\label{FileRetention}
\item [File Retention = \lt{}time-period-specification\gt{}]
\label{FileRetention}
+ \label{Client:FileRetention}
\index[dir]{File Retention}
\index[dir]{Directive!File Retention}
The File Retention directive defines the length of time that Bacula will
The default is 60 days.
-\label{JobRetention}
\item [Job Retention = \lt{}time-period-specification\gt{}]
\label{JobRetention}
+ \label{Client:JobRetention}
\index[dir]{Job Retention}
\index[dir]{Directive!Job Retention}
The Job Retention directive defines the length of time that Bacula will keep
\label{AutoPrune}
\item [AutoPrune = \lt{}yes\vb{}no\gt{}]
+ \label{Client:AutoPrune}
\index[dir]{AutoPrune}
\index[dir]{Directive!AutoPrune}
If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
stored in the backup archives (on Volumes).
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+ \label{Client:MaximumConcurrentJobs}
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of Jobs with the current Client
The default is set to 1, but you may set it to a larger number.
\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
+\label{Client:MaximumBandwidthPerJob}
\index[dir]{Maximum Bandwidth Per Job}
\index[dir]{Directive!Maximum Bandwidth Per Job}
% \end{figure}
\item [Priority = \lt{}number\gt{}]
+ \label{Client:Priority}
\index[dir]{Priority}
\index[dir]{Directive!Priority}
The number specifies the priority of this client relative to other clients
specified.
\item [Name = \lt{}name\gt{}]
+ \label{Storage:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the storage resource. This name appears on the Storage directive
specified in the Job resource and is required.
\item [Address = \lt{}address\gt{}]
+ \label{Storage:Address}
\index[dir]{Address}
\index[dir]{Directive!SD Address}
\index[dir]{Storage daemon Address}
the name but rather a fully qualified machine name or an IP address. This
directive is required.
- \item [FD Storage Address = \lt{}address\gt{}] \index[dir]{FDStorageAddress}
+ \item [FD Storage Address = \lt{}address\gt{}]
+ \label{Storage:FDStorageAddress}
+ \index[dir]{FDStorageAddress}
\index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
Address} Where the address is a host name, a {\bf fully qualified domain
name}, or an {\bf IP address}. Please note that the \lt{}address\gt{} as
\end{figure}
\item [SD Port = \lt{}port\gt{}]
+ \label{Storage:SdPort}
\index[dir]{SD Port}
\index[dir]{Directive!SD Port}
Where port is the port to use to contact the storage daemon for information
of the Storage daemon's configuration file. The default is 9103.
\item [Password = \lt{}password\gt{}]
+ \label{Storage:Password}
\index[dir]{Password}
\index[dir]{Directive!Password}
This is the password to be used when establishing a connection with the
process, but it is preferable for security reasons to use random text.
\item [Device = \lt{}device-name\gt{}]
+ \label{Storage:Device}
\index[dir]{Device}
\index[dir]{Directive!Device}
This directive specifies the Storage daemon's name of the device
\label{MediaType}
\item [Media Type = \lt{}MediaType\gt{}]
+ \label{Storage:MediaType}
\index[dir]{Media Type}
\index[dir]{Directive!Media Type}
This directive specifies the Media Type to be used to store the data.
\label{Autochanger1}
\item [Autochanger = \lt{}yes\vb{}no\gt{}]
+ \label{Storage:Autochanger}
\index[dir]{Autochanger}
\index[dir]{Directive!Autochanger}
If you specify {\bf yes} for this command (the default is {\bf no}),
details of using autochangers.
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+ \label{Storage:MaximumConcurrentJobs}
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of Jobs with the current
\item [AllowCompression = \lt{}yes\vb{}no\gt{}]
\label{AllowCompression}
+ \label{Storage:AllowCompression}
\index[dir]{AllowCompression}
\index[dir]{Directive!AllowCompression}
resource.
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
+ \label{Storage:Heartbeat Interval}
\index[dir]{Heartbeat Interval}
\index[dir]{Directive!Heartbeat}
This directive is optional and if specified will cause the Director to
\item [Name = \lt{}name\gt{}]
+ \label{Pool:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the pool. For most applications, you will use the default
\label{MaxVolumes}
\item [Maximum Volumes = \lt{}number\gt{}]
+ \label{Pool:MaximumVolumes}
\index[dir]{Maximum Volumes}
\index[dir]{Directive!Maximum Volumes}
This directive specifies the maximum number of volumes (tapes or files)
made to disk files do not become too numerous or consume too much space.
\item [Pool Type = \lt{}type\gt{}]
+ \label{Pool:PoolType}
\index[dir]{Pool Type}
\index[dir]{Directive!Pool Type}
This directive defines the pool type, which corresponds to the type of
Note, only Backup is current implemented.
\item [Storage = \lt{}storage-resource-name\gt{}]
+\label{Pool:Storage}
\index[dir]{Storage}
\index[dir]{Directive!Storage}
The Storage directive defines the name of the storage services where you
one or the other. If not configuration error will result.
\item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:UseVolumeOnce}
\index[dir]{Use Volume Once}
\index[dir]{Directive!Use Volume Once}
This directive if set to {\bf yes} specifies that each volume is to be
using this directive with multiple simultaneous jobs.
\item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
+ \label{Pool:MaximumVolumeJobs}
\index[dir]{Maximum Volume Jobs}
\index[dir]{Directive!Maximum Volume Jobs}
This directive specifies the maximum number of Jobs that can be written
longer be written.
\item [Maximum Volume Files = \lt{}positive-integer\gt{}]
+ \label{Pool:MaximumVolumeFiles}
\index[dir]{Maximum Volume Files}
\index[dir]{Directive!Maximum Volume Files}
This directive specifies the maximum number of files that can be written
Volume you must use the {\bf update} command in the Console.
\item [Maximum Volume Bytes = \lt{}size\gt{}]
+ \label{Pool:MaximumVolumeBytes}
\index[dir]{Maximum Volume Bytes}
\index[dir]{Directive!Maximum Volume Bytes}
This directive specifies the maximum number of bytes that can be written
Volume you must use the {\bf update} command in the Console.
\item [Volume Use Duration = \lt{}time-period-specification\gt{}]
+ \label{Pool:VolumeUseDuration}
\index[dir]{Volume Use Duration}
\index[dir]{Directive!Volume Use Duration}
The Volume Use Duration directive defines the time period that the
\ilink{\bf update volume}{UpdateCommand} command in the Console.
\item [Catalog Files = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:CatalogFiles}
\index[dir]{Catalog Files}
\index[dir]{Directive!Catalog Files}
This directive defines whether or not you want the names of the files
\label{PoolAutoPrune}
\item [AutoPrune = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:AutoPrune}
\index[dir]{AutoPrune}
\index[dir]{Directive!AutoPrune}
If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
\label{VolRetention}
\item [Volume Retention = \lt{}time-period-specification\gt{}]
+ \label{Pool:VolumeRetention}
\index[dir]{Volume Retention}
\index[dir]{Directive!Volume Retention}
The Volume Retention directive defines the length of time that {\bf
Volume you must use the {\bf update} command in the Console.
\item [Action On Purge = \lt{Truncate}]
+\label{Pool:ActionOnPurge}
\index[dir]{actiononpurge}
This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
\label{PoolScratchPool}
\item [ScratchPool = \lt{}pool-resource-name\gt{}]
+ \label{Pool:ScrachPool}
\index[dir]{ScrachPool}
\index[dir]{Directive!ScrachPool}
This directive permits to specify a dedicate \textsl{Scratch} for the
\label{PoolRecyclePool}
\item [RecyclePool = \lt{}pool-resource-name\gt{}]
+ \label{Pool:RecyclePool}
\index[dir]{RecyclePool}
\index[dir]{Directive!RecyclePool}
This directive defines to which pool
\label{PoolRecycle}
\item [Recycle = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:Recycle}
\index[dir]{Recycle}
\index[dir]{Directive!Recycle}
This directive specifies whether or not Purged Volumes may be recycled.
\label{RecycleOldest}
\item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:RecycleOldestVolume}
\index[dir]{Recycle Oldest Volume}
\index[dir]{Directive!Recycle Oldest Volume}
This directive instructs the Director to search for the oldest used
\label{RecycleCurrent}
\item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:RecycleCurrentVolume}
\index[dir]{Recycle Current Volume}
\index[dir]{Directive!Recycle Current Volume}
If Bacula needs a new Volume, this directive instructs Bacula to Prune
\label{PurgeOldest}
\item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
+ \label{Pool:PurgeOldestVolume}
\index[dir]{Purge Oldest Volume}
\index[dir]{Directive!Purge Oldest Volume}
This directive instructs the Director to search for the oldest used
data. The default is {\bf no}.
\item [File Retention = \lt{}time-period-specification\gt{}]
+ \label{Pool:FileRetention}
\index[dir]{File Retention}
\index[dir]{Directive!File Retention}
The File Retention directive defines the length of time that Bacula will
\ilink{FileRetention}{FileRetention}
\item [Job Retention = \lt{}time-period-specification\gt{}]
+ \label{Pool:JobRetention}
\index[dir]{Job Retention}
\index[dir]{Directive!Job Retention}
\ilink{JobRetention}{JobRetention}
\item [Cleaning Prefix = \lt{}string\gt{}]
+ \label{Pool:CleaningPrefix}
\index[dir]{Cleaning Prefix}
\index[dir]{Directive!Cleaning Prefix}
This directive defines a prefix string, which if it matches the
\label{Label}
\item [Label Format = \lt{}format\gt{}]
+ \label{Pool:LabelFormat}
\index[dir]{Label Format}
\index[dir]{Directive!Label Format}
This directive specifies the format of the labels contained in this
\item [Name = \lt{}name\gt{}]
+ \label{Catalog:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the Catalog. No necessary relation to the database server
Catalog. This directive is required.
\item [password = \lt{}password\gt{}]
+ \label{Catalog:Password}
\index[dir]{password}
\index[dir]{Directive!password}
This specifies the password to use when logging into the database. This
directive is required.
\item [DB Name = \lt{}name\gt{}]
+ \label{Catalog:DbName}
\index[dir]{DB Name}
\index[dir]{Directive!DB Name}
This specifies the name of the database. If you use multiple catalogs
tables using this name. This directive is required.
\item [user = \lt{}user\gt{}]
+ \label{Catalog:User}
\index[dir]{user}
\index[dir]{Directive!user}
This specifies what user name to use to log into the database. This
directive is required.
\item [DB Socket = \lt{}socket-name\gt{}]
+ \label{Catalog:DbSocket}
\index[dir]{DB Socket}
\index[dir]{Directive!DB Socket}
This is the name of a socket to use on the local host to connect to the
MySQL server must reside on the same machine as the Director.
\item [DB Address = \lt{}address\gt{}]
+ \label{Catalog:DBAddress}
\index[dir]{DB Address}
\index[dir]{Directive!DB Address}
This is the host address of the database server. Normally, you would specify
This directive is optional.
\item [DB Port = \lt{}port\gt{}]
+ \label{Catalog:DbPort}
\index[dir]{DB Port}
\index[dir]{Directive!DB Port}
This defines the port to be used in conjunction with {\bf DB Address} to
directive is optional.
%% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}]
-%% \index[dir]{Multiple Connections}
+
%% \index[dir]{Directive!Multiple Connections}
%% By default, this directive is set to no. In that case, each job that uses
the
\begin{description}
\item [Name = \lt{}name\gt{}]
+ \label{Console:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the console. This name must match the name specified in the
definitions).
\item [Password = \lt{}password\gt{}]
+ \label{Console:Password}
\index[dir]{Password}
\index[dir]{Directive!Password}
Specifies the password that must be supplied for a named Bacula Console
random text.
\item [JobACL = \lt{}name-list\gt{}]
+ \label{Console:JobAcl}
\index[dir]{JobACL}
\index[dir]{Directive!JobACL}
This directive is used to specify a list of Job resource names that can
for the four jobs named on the JobACL directives, but for no others.
\item [ClientACL = \lt{}name-list\gt{}]
+ \label{Console:ClientAcl}
\index[dir]{ClientACL}
\index[dir]{Directive!ClientACL}
This directive is used to specify a list of Client resource names that can
accessed by the console.
\item [StorageACL = \lt{}name-list\gt{}]
+ \label{Console:StorageAcl}
\index[dir]{StorageACL}
\index[dir]{Directive!StorageACL}
This directive is used to specify a list of Storage resource names that can
be accessed by the console.
\item [ScheduleACL = \lt{}name-list\gt{}]
+ \label{Console:ScheduleAcl}
\index[dir]{ScheduleACL}
\index[dir]{Directive!ScheduleACL}
This directive is used to specify a list of Schedule resource names that can
be accessed by the console.
\item [PoolACL = \lt{}name-list\gt{}]
+ \label{Console:PoolAcl}
\index[dir]{PoolACL}
\index[dir]{Directive!PoolACL}
This directive is used to specify a list of Pool resource names that can be
accessed by the console.
\item [FileSetACL = \lt{}name-list\gt{}]
+ \label{Console:FileSetAcl}
\index[dir]{FileSetACL}
\index[dir]{Directive!FileSetACL}
This directive is used to specify a list of FileSet resource names that
can be accessed by the console.
\item [CatalogACL = \lt{}name-list\gt{}]
+ \label{Console:CatalogAcl}
\index[dir]{CatalogACL}
\index[dir]{Directive!CatalogACL}
This directive is used to specify a list of Catalog resource names that
can be accessed by the console.
\item [CommandACL = \lt{}name-list\gt{}]
+ \label{Console:CommandAcl}
\index[dir]{CommandACL}
\index[dir]{Directive!CommandACL}
This directive is used to specify a list of of console commands that can
be executed by the console.
\item [WhereACL = \lt{}string\gt{}]
+ \label{Console:WhereAcl}
\index[dir]{WhereACL}
\index[dir]{Directive!WhereACL}
This directive permits you to specify where a restricted console
Start of the Counter resource. Counter directives are optional.
\item [Name = \lt{}name\gt{}]
+ \label{Counter:Name}
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the Counter. This is the name you will use in the variable
expansion to reference the counter value.
\item [Minimum = \lt{}integer\gt{}]
+ \label{Counter:Minimum}
\index[dir]{Minimum}
\index[dir]{Directive!Minimum}
This specifies the minimum value that the counter can have. It also becomes
the default. If not supplied, zero is assumed.
\item [Maximum = \lt{}integer\gt{}]
+ \label{Counter:Maximum}
\index[dir]{Maximum}
\index[dir]{Directive!Maximum}
\index[dir]{Directive!Maximum}
to the Minimum.
\item [*WrapCounter = \lt{}counter-name\gt{}]
+ \label{Counter:*WrapCounter}
\index[dir]{*WrapCounter}
\index[dir]{Directive!*WrapCounter}
If this value is specified, when the counter is incremented past the
is incremented. (This is not currently implemented).
\item [Catalog = \lt{}catalog-name\gt{}]
+ \label{Counter:Catalog}
\index[dir]{Catalog}
\index[dir]{Directive!Catalog}
If this directive is specified, the counter and its values will be saved in
projects / bacula / docs / commitdiff