Start of the Director resource. One and only one director resource must be
supplied.
-\label{Director:Name}
+\label{Director:Director:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The director name used by the system administrator. This directive is
required.
-\label{Director:Description}
+\label{Director:Director:Description}
\item [Description = \lt{}text\gt{}]
\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.
-\label{Director:Password}
+\label{Director:Director:Password}
\item [Password = \lt{}UA-password\gt{}]
\index[dir]{Password}
\index[dir]{Directive!Password}
process but as noted above, it is better to use random text for
security reasons.
- \label{Director:Messages}
+ \label{Director:Director:Messages}
\item [Messages = \lt{}Messages-resource-name\gt{}]
\index[dir]{Directive!Messages}
The messages resource specifies where to deliver Director messages that are
there are a few messages that can occur when no job is running. This
directive is required.
- \label{Director:WorkingDirectory}
+ \label{Director:Director:WorkingDirectory}
\item [Working Directory = \lt{}Directory\gt{}]
\index[dir]{Working Directory}
\index[dir]{Directive!Working Directory}
{\bf {-}{-}with-dir-group} the Working Directory owner and group will
be set to those values.
- \label{Director:PidDirectory}
+ \label{Director:Director:PidDirectory}
\item [Pid Directory = \lt{}Directory\gt{}]
\index[dir]{Pid Directory}
\index[dir]{Directive!Pid Directory}
not installing Bacula in the system directories, you can use the {\bf Working
Directory} as defined above. This directive is required.
- \label{Director:ScriptsDirectory}
+ \label{Director:Director:ScriptsDirectory}
\item [Scripts Directory = \lt{}Directory\gt{}]
\index[dir]{Scripts Directory}
\index[dir]{Directive!Scripts Directory}
file is read so that values such as {\bf \$HOME} will be properly
expanded.
- \label{Director:QueryFile}
+ \label{Director:Director:QueryFile}
\item [QueryFile = \lt{}Path\gt{}]
\index[dir]{QueryFile}
\index[dir]{Directive!QueryFile}
done when the configuration file is read so that values such as {\bf
\$HOME} will be properly expanded. This directive is required.
- \label{Director:HeartbeatInterval}
+ \label{Director:Director:HeartbeatInterval}
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
\index[dir]{Heartbeat Interval}
\index[dir]{Directive!Heartbeat}
\label{DirMaxConJobs}
- \label{Director:MaximumConcurrentJobs}
+ \label{Director:Director:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
to disk simultaneously, then write one spool file at a time to the volume
thus avoiding excessive interleaving of the different job blocks.
- \label{Director:FdConnectTimeout}
+ \label{Director:Director:FdConnectTimeout}
\item [FD Connect Timeout = \lt{}time\gt{}]
\index[dir]{FD Connect Timeout}
\index[dir]{Directive!FD Connect Timeout}
attempting to contact the File daemon to start a job, and after which
the Director will cancel the job. The default is 30 minutes.
- \label{Director:SdConnectTimeout}
+ \label{Director:Director:SdConnectTimeout}
\item [SD Connect Timeout = \lt{}time\gt{}]
\index[dir]{SD Connect Timeout}
\index[dir]{Directive!SD Connect Timeout}
attempting to contact the Storage daemon to start a job, and after which
the Director will cancel the job. The default is 30 minutes.
- \label{Director:DirAddresses}
+ \label{Director:Director:DirAddresses}
\item [DirAddresses = \lt{}IP-address-specification\gt{}]
\index[dir]{DirAddresses}
\index[dir]{Address}
not use either a DirPort or a DirAddress directive in the same
resource.
- \label{Director:DirPort}
+ \label{Director:Director:DirPort}
\item [DirPort = \lt{}port-number\gt{}]
\index[dir]{DirPort}
\index[dir]{Directive!DirPort}
directive should not be used if you specify DirAddresses (N.B plural)
directive.
- \label{Director:DirAddress}
+ \label{Director:Director:DirAddress}
\item [DirAddress = \lt{}IP-Address\gt{}]
\index[dir]{DirAddress}
\index[dir]{Directive!DirAddress}
directive only permits a single address to be specified. This directive
should not be used if you specify a DirAddresses (N.B. plural) directive.
- \label{Director:DirSourceAddress}
+ \label{Director:Director:DirSourceAddress}
\item [DirSourceAddress = \lt{}IP-Address\gt{}]
\index[fd]{DirSourceAddress}
\index[fd]{Directive!DirSourceAddress}
its outgoing connections according to the system routing table (the default).
\phantomsection
-\label{Director:StatisticsRetention}
+\label{Director:Director:StatisticsRetention}
\item[Statistics Retention = \lt{}time\gt{}]
\index[dir]{StatisticsRetention}
\label{PruneStatistics}
The default is 5 years.
- \label{Director:VerId}
+ \label{Director:Director:VerId}
\item[VerId = \lt{}string\gt{}]
\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.
- \label{Director:MaximumConsoleConnections}
+ \label{Director:Director:MaximumConsoleConnections}
\item[MaximumConsoleConnections = \lt{}number\gt{}]
\index[dir]{MaximumConsoleConnections}
\index[dir]{Directive!MaximumConsoleConnections}
could run concurrently. The default is set to 20, but you may set it to a
larger number.
-\label{Director:MaximumReloadRequests}
+\label{Director:Director:MaximumReloadRequests}
\item[MaximumReloadRequests = \lt{}number\gt{}]
\index[dir]{MaximumReloadRequests}
\index[dir]{Directive!MaximumReloadRequests}
\index[dir]{Directive!Job}
Start of the Job resource. At least one Job resource is required.
- \label{Job:Name}
+ \label{Director:Job:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
specify here followed by the date and time the job was scheduled for
execution. This directive is required.
- \label{Job:Enable}
+ \label{Director:Job:Enable}
\item [Enabled = \lt{}yes\vb{}no\gt{}]
\index[dir]{Enable}
\index[dir]{Directive!Enable}
This directive allows you to enable or disable automatic execution
via the scheduler of a Job.
- \label{Job:Type}
+ \label{Director:Job:Type}
\item [Type = \lt{}job-type\gt{}]
\index[dir]{Type}
\index[dir]{Directive!Type}
\label{Level}
-\label{Job:Level}
+\label{Director:Job:Level}
\item [Level = \lt{}job-level\gt{}]
\index[dir]{Level}
\index[dir]{Directive!Level}
have been deleted.
\end{description}
-\label{Job:Accurate}
+\label{Director:Job:Accurate}
\item [Accurate = \lt{}yes\vb{}no\gt{}]
\index[dir]{Accurate}
In accurate mode, the File daemon knowns exactly which files were present
approximately 64 Megabytes of RAM on your File daemon to hold the
required information.
- \label{Job:VerifyJob}
+ \label{Director:Job:VerifyJob}
\item [Verify Job = \lt{}Job-Resource-Name\gt{}]
\index[dir]{Verify Job}
\index[dir]{Directive!Verify Job}
verified (most often a {\bf VolumeToCatalog}) so that the tape just
written is re-read.
-\label{Job:JobDefs}
+\label{Director:Job:JobDefs}
\item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
\index[dir]{JobDefs}
\index[dir]{Directive!JobDefs}
variations such as different Clients. A simple example of the use of
JobDefs is provided in the default bacula-dir.conf file.
-\label{Job:Bootstrap}
+\label{Director:Job:Bootstrap}
\item [Bootstrap = \lt{}bootstrap-file\gt{}]
\index[dir]{Bootstrap}
\index[dir]{Directive!Bootstrap}
of this manual.
\label{writebootstrap}
-\label{Job:WriteBootstrap}
+\label{Director:Job:WriteBootstrap}
\item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
\index[dir]{Write Bootstrap}
\index[dir]{Directive!Write Bootstrap}
For more details on using this file, please see the chapter entitled
\ilink{The Bootstrap File}{BootstrapChapter} of this manual.
-\label{Job:Client}
+\label{Director:Job:Client}
\item [Client = \lt{}client-resource-name\gt{}]
\index[dir]{Client}
\index[dir]{Directive!Client}
\ilink{Client Resource section}{ClientResource} of this chapter.
This directive is required.
-\label{Job:FileSet}
+\label{Director:Job:FileSet}
\item [FileSet = \lt{}FileSet-resource-name\gt{}]
\index[dir]{FileSet}
\index[dir]{Directive!FileSet}
details, see the \ilink{FileSet Resource section}{FileSetResource} of
this chapter. This directive is required.
-\label{Job:Base}
+\label{Director:Job:Base}
\item [Base = \lt{}job-resource-name, \ldots{}\gt{}]
\index[dir]{Base}
\index[dir]{Directive!Base}
Full backup as base. This directive is optional. See the \ilink{Base Job
chapter}{basejobs} for more information.
-\label{Job:Messages}
+\label{Director:Job:Messages}
\item [Messages = \lt{}messages-resource-name\gt{}]
\index[dir]{Messages}
\index[dir]{Directive!Messages}
\ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
directive is required.
-\label{Job:Pool}
+\label{Director:Job:Pool}
\item [Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Pool}
\index[dir]{Directive!Pool}
Pools. For additional details, see the \ilink{Pool Resource
section}{PoolResource} of this chapter. This directive is required.
-\label{Job:FullBackupPool}
+\label{Director:Job:FullBackupPool}
\item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Full Backup Pool}
\index[dir]{Directive!Full Backup Pool}
It will override any Pool specification during a Full backup. This
directive is optional.
-\label{Job:DifferentialBackupPool}
+\label{Director:Job:DifferentialBackupPool}
\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Differential Backup Pool}
\index[dir]{Directive!Differential Backup Pool}
Differential backups. It will override any Pool specification during a
Differential backup. This directive is optional.
-\label{Job:IncrementalBackupPool}
+\label{Director:Job:IncrementalBackupPool}
\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Incremental Backup Pool}
\index[dir]{Directive!Incremental Backup Pool}
Incremental backups. It will override any Pool specification during an
Incremental backup. This directive is optional.
-\label{Job:Schedule}
+\label{Director:Job:Schedule}
\item [Schedule = \lt{}schedule-name\gt{}]
\index[dir]{Schedule}
\index[dir]{Directive!Schedule}
Chapter}{ScheduleResource} of this manual.
-\label{Job:Storage}
+\label{Director:Job:Storage}
\item [Storage = \lt{}storage-resource-name\gt{}]
\index[dir]{Storage}
\index[dir]{Directive!Storage}
the Job resource or in the Pool, but it must be specified in
one or the other, if not an error will result.
-\label{Job:MaxStartDelay}
+\label{Director:Job:MaxStartDelay}
\item [Max Start Delay = \lt{}time\gt{}]
\index[dir]{Max Start Delay}
\index[dir]{Directive!Max Start Delay}
to prevent jobs from running during day time hours. The default is 0
which indicates no limit.
-\label{Job:MaxRunTime}
+\label{Director:Job:MaxRunTime}
\item [Max Run Time = \lt{}time\gt{}]
\index[dir]{Max Run Time}
\index[dir]{Directive!Max Run Time}
and cannot be changed.
-\label{Job:IncrementalWaitRunTime}
+\label{Director:Job:IncrementalWaitRunTime}
\item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
\index[dir]{Incremental Wait Run Time}
\index[dir]{Differential Wait Run Time}
Theses directives have been deprecated in favor of
\texttt{Incremental|Differential Max Run Time} since bacula 2.3.18.
-\label{Job:IncrementalMaxRunTime}
+\label{Director:Job:IncrementalMaxRunTime}
\item [Incremental Max Run Time = \lt{}time\gt{}]
\index[dir]{Incremental Max Run Time}
\index[dir]{Directive!Incremental Max Run Time}
run, counted from when the job starts, ({\bf not} necessarily the same as when
the job was scheduled).
-\label{Job:DifferentialMaxRunTime}
+\label{Director:Job:DifferentialMaxRunTime}
\item [Differential Max Wait Time = \lt{}time\gt{}]
\index[dir]{Differential Max Run Time}
\index[dir]{Directive!Differential Max Run Time}
run, counted from when the job starts, ({\bf not} necessarily the same as when
the job was scheduled).
-\label{Job:MaxRunSchedTime}
+\label{Director:Job:MaxRunSchedTime}
\item [Max Run Sched Time = \lt{}time\gt{}]
\index[dir]{Max Run Sched Time}
\index[dir]{Directive!Max Run Sched Time}
during working hours. We can see it like \texttt{Max Start Delay + Max Run
Time}.
-\label{Job:MaxWaitTime}
+\label{Director:Job:MaxWaitTime}
\item [Max Wait Time = \lt{}time\gt{}]
\index[dir]{Max Wait Time}
\index[dir]{Directive!Max Wait Time}
%% \caption{Job time control directives}
%% \end{figure}
-\label{Job:MaximumBandwidth}
+\label{Director:Job:MaximumBandwidth}
\item [Maximum Bandwidth = \lt{}speed\gt{}]
\index[dir]{Maximum Bandwidth}
\index[dir]{Directive!Maximum Bandwidth}
The speed parameter specifies the maximum allowed bandwidth that a job may
use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s.
-\label{Job:MaxFullInterval}
+\label{Director:Job:MaxFullInterval}
\item [Max Full Interval = \lt{}time\gt{}]
\index[dir]{Max Full Interval}
\index[dir]{Directive!Max Full Interval}
considered.
\label{PreferMountedVolumes}
-\label{Job:PreferMountedVolumes}
+\label{Director:Job:PreferMountedVolumes}
\item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}]
\index[dir]{Prefer Mounted Volumes}
\index[dir]{Directive!Prefer Mounted Volumes}
pools so that Bacula will be forced to mount Volumes from those Pools
on different drives.
-\label{Job:PruneJobs}
+\label{Director:Job:PruneJobs}
\item [Prune Jobs = \lt{}yes\vb{}no\gt{}]
\index[dir]{Prune Jobs}
\index[dir]{Directive!Prune Jobs}
default is {\bf no}.
-\label{Job:PruneFiles}
+\label{Director:Job:PruneFiles}
\item [Prune Files = \lt{}yes\vb{}no\gt{}]
\index[dir]{Prune Files}
\index[dir]{Directive!Prune Files}
yes}, it will override the value specified in the Client resource. The
default is {\bf no}.
-\label{Job:PruneVolumes}
+\label{Director:Job:PruneVolumes}
\item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
\index[dir]{Prune Volumes}
\index[dir]{Directive!Prune Volumes}
and the value is {\bf yes}, it will override the value specified in the
Pool resource. The default is {\bf no}.
- \label{Job:RunScript}
+ \label{Director:Job:RunScript}
\item [RunScript \{\lt{}body-of-runscript\gt{}\}]
\index[dir]{RunScript}
\index[dir]{Directive!Run Script}
It is important to redirect the input and outputs of a backgrounded command to
/dev/null to prevent the script from blocking.
-\label{Job:RunBeforeJob}
+\label{Director:Job:RunBeforeJob}
\item [Run Before Job = \lt{}command\gt{}]
\index[dir]{Run Before Job}
\index[dir]{Directive!Run Before Job}
Thursday job will not run, and on Friday the tape you inserted on Wednesday
before leaving will be used.
-\label{Job:RunAfterJob}
+\label{Director:Job:RunAfterJob}
\item [Run After Job = \lt{}command\gt{}]
\index[dir]{Run After Job}
\index[dir]{Directive!Run After Job}
want to run a script after the job has terminated with any
non-normal status.
-\label{Job:RunAfterJob}
+\label{Director:Job:RunAfterJob}
\item [Run After Failed Job = \lt{}command\gt{}]
\index[dir]{Run After Job}
\index[dir]{Directive!Run After Job}
\bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
-\label{Job:ClientRunBeforeJob}
+\label{Director:Job:ClientRunBeforeJob}
\item [Client Run Before Job = \lt{}command\gt{}]
\index[dir]{Client Run Before Job}
\index[dir]{Directive!Client Run Before Job}
program is run on the client machine. The same restrictions apply to
Unix systems as noted above for the {\bf RunScript}.
- \label{Job:ClientRunAfterJob}
+ \label{Director:Job:ClientRunAfterJob}
\item [Client Run After Job = \lt{}command\gt{}]
\index[dir]{Client Run After Job}
\index[dir]{Directive!Client Run After Job}
Note, please see the notes above in {\bf RunScript}
concerning Windows clients.
- \label{Job:RerunFailedLevels}
+ \label{Director:Job:RerunFailedLevels}
\item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}]
\index[dir]{Rerun Failed Levels}
\index[dir]{Directive!Rerun Failed Levels}
when checking for failed levels, which means that any FileSet change will
trigger a rerun.
- \label{Job:SpoolData}
+ \label{Director:Job:SpoolData}
\item [Spool Data = \lt{}yes\vb{}no\gt{}]
\index[dir]{Spool Data}
\index[dir]{Directive!Spool Data}
NOTE: When this directive is set to yes, Spool Attributes is also
automatically set to yes.
- \label{Job:SpoolData}
+ \label{Director:Job:SpoolData}
\item [SpoolData=yes\vb{}no]
\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).
- \label{Job:SpoolAttributes}
+ \label{Director:Job:SpoolAttributes}
\item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
\index[dir]{Spool Attributes}
\index[dir]{Directive!Spool Attributes}
NOTE: When Spool Data is set to yes, Spool Attributes is also
automatically set to yes.
- \label{Job:SpoolSize}
+ \label{Director:Job:SpoolSize}
\item [SpoolSize={\it bytes}]
\index[dir]{SpoolSize}
\index[dir]{Directive!SpoolSize}
later.
- \label{Job:Where}
+ \label{Director:Job:Where}
\item [Where = \lt{}directory\gt{}]
\index[dir]{Where}
\index[dir]{Directive!Where}
your files.
\label{confaddprefix}
- \label{Job:AddPrefix}
+ \label{Director:Job:AddPrefix}
\item [Add Prefix = \lt{}directory\gt{}]
\index[dir]{AddPrefix}
\index[dir]{Directive!AddPrefix}
directory name of all files being restored. This will use \ilink{File
Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
- \label{Job:AddSuffix}
+ \label{Director:Job:AddSuffix}
\item [Add Suffix = \lt{}extention\gt{}]
\index[dir]{AddSuffix}
\index[dir]{Directive!AddSuffix}
Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
\texttt{/etc/passwsd.old}
- \label{Job:StripPrefix}
+ \label{Director:Job:StripPrefix}
\item [Strip Prefix = \lt{}directory\gt{}]
\index[dir]{StripPrefix}
\index[dir]{Directive!StripPrefix}
Add Prefix = d:
\end{lstlisting}
- \label{Job:RegexWhere}
+ \label{Director:Job:RegexWhere}
\item [RegexWhere = \lt{}expressions\gt{}]
\index[dir]{RegexWhere}
\index[dir]{Directive!RegexWhere}
For more informations about how use this option, see
\ilink{this}{useregexwhere}.
- \label{Job:Replace}
+ \label{Director:Job:Replace}
\item [Replace = \lt{}replace-option\gt{}]
\index[dir]{Replace}
\index[dir]{Directive!Replace}
if the backed up file already exists, Bacula skips restoring this file.
\end{description}
- \label{Job:PrefixLinks}
+ \label{Director:Job:PrefixLinks}
\item [Prefix Links=\lt{}yes\vb{}no\gt{}]
\index[dir]{Prefix Links}
\index[dir]{Directive!Prefix Links}
consistent. However, if you wish to later move the files to their
original locations, all files linked with absolute names will be broken.
- \label{Job:MaximumConcurrentJobs}
+ \label{Director:Job:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
Director's resource.
- \label{Job:RescheduleOnError}
+ \label{Director:Job:RescheduleOnError}
\item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
\index[dir]{Reschedule On Error}
\index[dir]{Directive!Reschedule On Error}
This specification can be useful for portables, laptops, or other
machines that are not always connected to the network or switched on.
- \label{Job:RescheduleInterval}
+ \label{Director:Job:RescheduleInterval}
\item [Reschedule Interval = \lt{}time-specification\gt{}]
\index[dir]{Reschedule Interval}
\index[dir]{Directive!Reschedule Interval}
time specifications. If no interval is specified, the job will not be
rescheduled on error.
- \label{Job:RescheduleTimes}
+ \label{Director:Job:RescheduleTimes}
\item [Reschedule Times = \lt{}count\gt{}]
\index[dir]{Reschedule Times}
\index[dir]{Directive!Reschedule Times}
job. If it is set to zero (the default) the job will be rescheduled an
indefinite number of times.
-\label{Job:AllowDuplicateJobs}
+\label{Director:Job:AllowDuplicateJobs}
\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
\index[general]{Allow Duplicate Jobs}
of Bacula the directive is disabled (disregarded).
-\label{Job:CancelLowerLevelDuplicates}
+\label{Director:Job:CancelLowerLevelDuplicates}
\item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
\index[general]{Cancel Lower Level Duplicates}
If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this
jobs are the same, nothing is done and the other
Cancel XXX Duplicate directives will be examined.
-\label{Job:CancelQueuedDuplicates}
+\label{Director:Job:CancelQueuedDuplicates}
\item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
\index[general]{Cancel Queued Duplicates}
If {\bf Allow Duplicate Jobs} is set to {\bf no} and
already queued to run but not yet running will be canceled.
The default is {\bf no}.
-\label{Job:CancelRunningDuplicates}
+\label{Director:Job:CancelRunningDuplicates}
\item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
\index[general]{Cancel Running Duplicates}
If {\bf Allow Duplicate Jobs} is set to {\bf no} and
%% If the first one is running for long time, this is probably not a good
%% idea to cancel it.
- \label{Job:Run}
+ \label{Director:Job:Run}
\item [Run = \lt{}job-name\gt{}]
\index[dir]{Run}
\index[dir]{Directive!Run}
resource, or a RunBeforeJob directive.
\label{Priority}
- \label{Job:Priority}
+ \label{Director:Job:Priority}
\item [Priority = \lt{}number\gt{}]
\index[dir]{Priority}
\index[dir]{Directive!Priority}
correct order, and that your priority scheme will be respected.
\label{AllowMixedPriority}
-\label{Job:AllowMixedPriority}
+\label{Director:Job:AllowMixedPriority}
\item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}]
\index[dir]{Allow Mixed Priority}
This directive is only implemented in version 2.5 and later. When
be run until the priority 5 job has finished.
\label{WritePartAfterJob}
-\label{Job:WritePartAfterJob}
+\label{Director:Job:WritePartAfterJob}
\item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
\index[dir]{Write Part After Job}
\index[dir]{Directive!Write Part After Job}
required, but you will need at least one if you want Jobs to be
automatically started.
- \label{Schdedule:Name}
+ \label{Director:Schedule:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the schedule being defined. The Name directive is required.
- \label{Schdedule:Run}
+ \label{Director:Schedule:Run}
\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
\index[dir]{Run}
\index[dir]{Directive!Run}
\index[dir]{Directive!Client (or FileDaemon)}
Start of the Client directives.
- \label{Client:Name}
+ \label{Director:Client:Name}
\item [Name = \lt{}name\gt{}]
\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.
- \label{Client:Address}
+ \label{Director:Client:Address}
\item [Address = \lt{}address\gt{}]
\index[dir]{Address}
\index[dir]{Directive!FD Address}
network address in dotted quad notation for a Bacula File server daemon.
This directive is required.
- \label{Client:FdPort}
+ \label{Director:Client:FdPort}
\item [FD Port = \lt{}port-number\gt{}]
\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.
- \label{Client:Catalog}
+ \label{Director:Client:Catalog}
\item [Catalog = \lt{}Catalog-resource-name\gt{}]
\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.
- \label{Client:Password}
+ \label{Director:Client:Password}
\item [Password = \lt{}password\gt{}]
\index[dir]{Password}
\index[dir]{Directive!Password}
\label{FileRetention}
\label{FileRetention}
- \label{Client:FileRetention}
+ \label{Director:Client:FileRetention}
\item [File Retention = \lt{}time-period-specification\gt{}]
\index[dir]{File Retention}
\index[dir]{Directive!File Retention}
The default is 60 days.
\label{JobRetention}
- \label{Client:JobRetention}
+ \label{Director:Client:JobRetention}
\item [Job Retention = \lt{}time-period-specification\gt{}]
\index[dir]{Job Retention}
\index[dir]{Directive!Job Retention}
The default is 180 days.
\label{AutoPrune}
- \label{Client:AutoPrune}
+ \label{Director:Client:AutoPrune}
\item [AutoPrune = \lt{}yes\vb{}no\gt{}]
\index[dir]{AutoPrune}
\index[dir]{Directive!AutoPrune}
run a Job. Pruning affects only information in the catalog and not data
stored in the backup archives (on Volumes).
- \label{Client:MaximumConcurrentJobs}
+ \label{Director:Client:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
Storage resources will also apply in addition to any limit specified here.
The default is set to 1, but you may set it to a larger number.
-\label{Client:MaximumBandwidthPerJob}
+\label{Director:Client:MaximumBandwidthPerJob}
\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
\index[dir]{Maximum Bandwidth Per Job}
\index[dir]{Directive!Maximum Bandwidth Per Job}
% \caption{Backup over WAN using FD Storage Address}
% \end{figure}
- \label{Client:Priority}
+ \label{Director:Client:Priority}
\item [Priority = \lt{}number\gt{}]
\index[dir]{Priority}
\index[dir]{Directive!Priority}
Start of the Storage resources. At least one storage resource must be
specified.
- \label{Storage:Name}
+ \label{Director:Storage:Name}
\item [Name = \lt{}name\gt{}]
\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.
- \label{Storage:Address}
+ \label{Director:Storage:Address}
\item [Address = \lt{}address\gt{}]
\index[dir]{Address}
\index[dir]{Directive!SD Address}
the name but rather a fully qualified machine name or an IP address. This
directive is required.
- \label{Storage:FDStorageAddress}
+ \label{Director:Storage:FdStorageAddress}
\item [FD Storage Address = \lt{}address\gt{}]
\index[dir]{FDStorageAddress}
\index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
%% \caption{Backup over WAN using FD Storage Address}
%% \end{figure}
- \label{Storage:SdPort}
+ \label{Director:Storage:SdPort}
\item [SD Port = \lt{}port\gt{}]
\index[dir]{SD Port}
\index[dir]{Directive!SD Port}
and to start jobs. This same port number must appear in the Storage resource
of the Storage daemon's configuration file. The default is 9103.
- \label{Storage:Password}
+ \label{Director:Storage:Password}
\item [Password = \lt{}password\gt{}]
\index[dir]{Password}
\index[dir]{Directive!Password}
The password is plain text. It is not generated through any special
process, but it is preferable for security reasons to use random text.
- \label{Storage:Device}
+ \label{Director:Storage:Device}
\item [Device = \lt{}device-name\gt{}]
\index[dir]{Device}
\index[dir]{Directive!Device}
open the same device that is already open. This directive is required.
\label{MediaType}
- \label{Storage:MediaType}
+ \label{Director:Storage:MediaType}
\item [Media Type = \lt{}MediaType\gt{}]
\index[dir]{Media Type}
\index[dir]{Directive!Media Type}
check so that you don't try to write data for a DLT onto an 8mm device.
\label{Autochanger1}
- \label{Storage:Autochanger}
+ \label{Director:Storage:Autochanger}
\item [Autochanger = \lt{}yes\vb{}no\gt{}]
\index[dir]{Autochanger}
\index[dir]{Directive!Autochanger}
Autochangers}{AutochangersChapter} manual of this chapter for the
details of using autochangers.
- \label{Storage:MaximumConcurrentJobs}
+ \label{Director:Storage:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[dir]{Maximum Concurrent Jobs}
\index[dir]{Directive!Maximum Concurrent Jobs}
Spooling}{SpoolingChapter} chapter of this manual.
\label{AllowCompression}
- \label{Storage:AllowCompression}
+ \label{Director:Storage:AllowCompression}
\item [AllowCompression = \lt{}yes\vb{}no\gt{}]
\index[dir]{AllowCompression}
\index[dir]{Directive!AllowCompression}
compression options in FileSets used by jobs which use this storage
resource.
- \label{Storage:Heartbeat Interval}
+ \label{Director:Storage:HeartbeatInterval}
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
\index[dir]{Heartbeat Interval}
\index[dir]{Directive!Heartbeat}
defined.
- \label{Pool:Name}
+ \label{Director:Pool:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
pool name {\bf Default}. This directive is required.
\label{MaxVolumes}
- \label{Pool:MaximumVolumes}
+ \label{Director:Pool:MaximumVolumes}
\item [Maximum Volumes = \lt{}number\gt{}]
\index[dir]{Maximum Volumes}
\index[dir]{Directive!Maximum Volumes}
Volumes, or for File storage where you wish to ensure that the backups
made to disk files do not become too numerous or consume too much space.
- \label{Pool:PoolType}
+ \label{Director:Pool:PoolType}
\item [Pool Type = \lt{}type\gt{}]
\index[dir]{Pool Type}
\index[dir]{Directive!Pool Type}
\end{bsysitemize}
Note, only Backup is current implemented.
-\label{Pool:Storage}
+\label{Director:Pool:Storage}
\item [Storage = \lt{}storage-resource-name\gt{}]
\index[dir]{Storage}
\index[dir]{Directive!Storage}
the Job resource or in the Pool, but it must be specified in
one or the other. If not configuration error will result.
- \label{Pool:UseVolumeOnce}
+ \label{Director:Director:Pool:UseVolumeOnce}
\item [Use Volume Once = \lt{}yes\vb{}no\gt{}]
\index[dir]{Use Volume Once}
\index[dir]{Directive!Use Volume Once}
Please see the notes below under {\bf Maximum Volume Jobs} concerning
using this directive with multiple simultaneous jobs.
- \label{Pool:MaximumVolumeJobs}
+ \label{Director:Pool:MaximumVolumeJobs}
\item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
\index[dir]{Maximum Volume Jobs}
\index[dir]{Directive!Maximum Volume Jobs}
updated, multiple simultaneous jobs may fail since the Volume can no
longer be written.
- \label{Pool:MaximumVolumeFiles}
+ \label{Director:Pool:MaximumVolumeFiles}
\item [Maximum Volume Files = \lt{}positive-integer\gt{}]
\index[dir]{Maximum Volume Files}
\index[dir]{Directive!Maximum Volume Files}
what is stored for the Volume. To change the value for an existing
Volume you must use the {\bf update} command in the Console.
- \label{Pool:MaximumVolumeBytes}
+ \label{Director:Pool:MaximumVolumeBytes}
\item [Maximum Volume Bytes = \lt{}size\gt{}]
\index[dir]{Maximum Volume Bytes}
\index[dir]{Directive!Maximum Volume Bytes}
what is stored for the Volume. To change the value for an existing
Volume you must use the {\bf update} command in the Console.
- \label{Pool:VolumeUseDuration}
+ \label{Director:Pool:VolumeUseDuration}
\item [Volume Use Duration = \lt{}time-period-specification\gt{}]
\index[dir]{Volume Use Duration}
\index[dir]{Directive!Volume Use Duration}
must use the
\bsysxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
- \label{Pool:CatalogFiles}
+ \label{Director:Pool:CatalogFiles}
\item [Catalog Files = \lt{}yes\vb{}no\gt{}]
\index[dir]{Catalog Files}
\index[dir]{Directive!Catalog Files}
restore} command nor any other command that references File entries.
\label{PoolAutoPrune}
- \label{Pool:AutoPrune}
+ \label{Director:Pool:AutoPrune}
\item [AutoPrune = \lt{}yes\vb{}no\gt{}]
\index[dir]{AutoPrune}
\index[dir]{Directive!AutoPrune}
the Volume.
\label{VolRetention}
- \label{Pool:VolumeRetention}
+ \label{Director:Pool:VolumeRetention}
\item [Volume Retention = \lt{}time-period-specification\gt{}]
\index[dir]{Volume Retention}
\index[dir]{Directive!Volume Retention}
what is stored for the Volume. To change the value for an existing
Volume you must use the {\bf update} command in the Console.
-\label{Pool:ActionOnPurge}
+\label{Director:Pool:ActionOnPurge}
\item [Action On Purge = \lt{Truncate}]
\index[dir]{actiononpurge}
\end{lstlisting}
\label{PoolScratchPool}
- \label{Pool:ScrachPool}
+ \label{Director:Pool:ScrachPool}
\item [ScratchPool = \lt{}pool-resource-name\gt{}]
\index[dir]{ScrachPool}
\index[dir]{Directive!ScrachPool}
dedicate volumes to a particular set of pool.
\label{PoolRecyclePool}
- \label{Pool:RecyclePool}
+ \label{Director:Pool:RecyclePool}
\item [RecyclePool = \lt{}pool-resource-name\gt{}]
\index[dir]{RecyclePool}
\index[dir]{Directive!RecyclePool}
\label{PoolRecycle}
- \label{Pool:Recycle}
+ \label{Director:Pool:Recycle}
\item [Recycle = \lt{}yes\vb{}no\gt{}]
\index[dir]{Recycle}
\index[dir]{Directive!Recycle}
\label{RecycleOldest}
- \label{Pool:RecycleOldestVolume}
+ \label{Director:Pool:RecycleOldestVolume}
\item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}]
\index[dir]{Recycle Oldest Volume}
\index[dir]{Directive!Recycle Oldest Volume}
\label{RecycleCurrent}
- \label{Pool:RecycleCurrentVolume}
+ \label{Director:Pool:RecycleCurrentVolume}
\item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}]
\index[dir]{Recycle Current Volume}
\index[dir]{Directive!Recycle Current Volume}
\label{PurgeOldest}
- \label{Pool:PurgeOldestVolume}
+ \label{Director:Pool:PurgeOldestVolume}
\item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
\index[dir]{Purge Oldest Volume}
\index[dir]{Directive!Purge Oldest Volume}
sure that some day, Bacula will recycle a Volume that contains current
data. The default is {\bf no}.
- \label{Pool:FileRetention}
+ \label{Director:Pool:FileRetention}
\item [File Retention = \lt{}time-period-specification\gt{}]
\index[dir]{File Retention}
\index[dir]{Directive!File Retention}
For more information see Client documentation about
\ilink{FileRetention}{FileRetention}
- \label{Pool:JobRetention}
+ \label{Director:Pool:JobRetention}
\item [Job Retention = \lt{}time-period-specification\gt{}]
\index[dir]{Job Retention}
\index[dir]{Directive!Job Retention}
For more information see Client side documentation
\ilink{JobRetention}{JobRetention}
- \label{Pool:CleaningPrefix}
+ \label{Director:Pool:CleaningPrefix}
\item [Cleaning Prefix = \lt{}string\gt{}]
\index[dir]{Cleaning Prefix}
\index[dir]{Directive!Cleaning Prefix}
beginning with {\bf CLN} are treated as cleaning tapes.
\label{Label}
- \label{Pool:LabelFormat}
+ \label{Director:Pool:LabelFormat}
\item [Label Format = \lt{}format\gt{}]
\index[dir]{Label Format}
\index[dir]{Directive!Label Format}
defined.
- \label{Catalog:Name}
+ \label{Director:Catalog:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
indicating that all catalog data for that Client is maintained in this
Catalog. This directive is required.
- \label{Catalog:Password}
+ \label{Director:Catalog:Password}
\item [password = \lt{}password\gt{}]
\index[dir]{password}
\index[dir]{Directive!password}
This specifies the password to use when logging into the database. This
directive is required.
- \label{Catalog:DbName}
+ \label{Director:Catalog:DbName}
\item [DB Name = \lt{}name\gt{}]
\index[dir]{DB Name}
\index[dir]{Directive!DB Name}
that is known to the server (i.e. you explicitly created the Bacula
tables using this name. This directive is required.
- \label{Catalog:User}
+ \label{Director:Catalog:User}
\item [user = \lt{}user\gt{}]
\index[dir]{user}
\index[dir]{Directive!user}
This specifies what user name to use to log into the database. This
directive is required.
- \label{Catalog:DbSocket}
+ \label{Director:Catalog:DbSocket}
\item [DB Socket = \lt{}socket-name\gt{}]
\index[dir]{DB Socket}
\index[dir]{Directive!DB Socket}
will use the default socket. If the DB Socket is specified, the
MySQL server must reside on the same machine as the Director.
- \label{Catalog:DBAddress}
+ \label{Director:Catalog:DBAddress}
\item [DB Address = \lt{}address\gt{}]
\index[dir]{DB Address}
\index[dir]{Directive!DB Address}
only by MySQL and PostgreSQL and is ignored by SQLite if provided.
This directive is optional.
- \label{Catalog:DbPort}
+ \label{Director:Catalog:DbPort}
\item [DB Port = \lt{}port\gt{}]
\index[dir]{DB Port}
\index[dir]{Directive!DB Port}
\begin{description}
- \label{Console:Name}
+ \label{Director:Console:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
Console's configuration resource (much as is the case with Client
definitions).
- \label{Console:Password}
+ \label{Director:Console:Password}
\item [Password = \lt{}password\gt{}]
\index[dir]{Password}
\index[dir]{Directive!Password}
process. However, it is preferable for security reasons to choose
random text.
- \label{Console:JobAcl}
+ \label{Director:Console:JobAcl}
\item [JobACL = \lt{}name-list\gt{}]
\index[dir]{JobACL}
\index[dir]{Directive!JobACL}
With the above specification, the console can access the Director's resources
for the four jobs named on the JobACL directives, but for no others.
- \label{Console:ClientAcl}
+ \label{Director:Console:ClientAcl}
\item [ClientACL = \lt{}name-list\gt{}]
\index[dir]{ClientACL}
\index[dir]{Directive!ClientACL}
be
accessed by the console.
- \label{Console:StorageAcl}
+ \label{Director:Console:StorageAcl}
\item [StorageACL = \lt{}name-list\gt{}]
\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.
- \label{Console:ScheduleAcl}
+ \label{Director:Console:ScheduleAcl}
\item [ScheduleACL = \lt{}name-list\gt{}]
\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.
- \label{Console:PoolAcl}
+ \label{Director:Console:PoolAcl}
\item [PoolACL = \lt{}name-list\gt{}]
\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.
- \label{Console:FileSetAcl}
+ \label{Director:Console:FileSetAcl}
\item [FileSetACL = \lt{}name-list\gt{}]
\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.
- \label{Console:CatalogAcl}
+ \label{Director:Console:CatalogAcl}
\item [CatalogACL = \lt{}name-list\gt{}]
\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.
- \label{Console:CommandAcl}
+ \label{Director:Console:CommandAcl}
\item [CommandACL = \lt{}name-list\gt{}]
\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.
- \label{Console:WhereAcl}
+ \label{Director:Console:WhereAcl}
\item [WhereACL = \lt{}string\gt{}]
\index[dir]{WhereACL}
\index[dir]{Directive!WhereACL}
\index[dir]{Directive!Counter}
Start of the Counter resource. Counter directives are optional.
- \label{Counter:Name}
+ \label{Director:Counter:Name}
\item [Name = \lt{}name\gt{}]
\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.
- \label{Counter:Minimum}
+ \label{Director:Counter:Minimum}
\item [Minimum = \lt{}integer\gt{}]
\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.
- \label{Counter:Maximum}
+ \label{Director:Counter:Maximum}
\item [Maximum = \lt{}integer\gt{}]
\index[dir]{Maximum}
\index[dir]{Directive!Maximum}
the 31 power). When the counter is incremented past this value, it is reset
to the Minimum.
- \label{Counter:*WrapCounter}
+ \label{Director:Counter:*WrapCounter}
\item [*WrapCounter = \lt{}counter-name\gt{}]
\index[dir]{*WrapCounter}
\index[dir]{Directive!*WrapCounter}
and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
is incremented. (This is not currently implemented).
- \label{Counter:Catalog}
+ \label{Director:Counter:Catalog}
\item [Catalog = \lt{}catalog-name\gt{}]
\index[dir]{Catalog}
\index[dir]{Directive!Catalog}
\begin{description}
+\label{Storage:Storage:Name}
\item [Name = \lt{}Storage-Daemon-Name\gt{}]
\index[sd]{Name}
\index[sd]{Directive!Name}
Specifies the Name of the Storage daemon. This directive is required.
+\label{Storage:Storage:WorkingDirectory}
\item [Working Directory = \lt{}Directory\gt{}]
\index[sd]{Working Directory}
\index[sd]{Directive!Working Directory}
given to each daemon are unique. This directive is
required
+\label{Storage:Storage:PidDirectory}
\item [Pid Directory = \lt{}Directory\gt{}]
\index[sd]{Pid Directory}
\index[sd]{Directive!Pid Directory}
not installing Bacula in the system directories, you can use the {\bf Working
Directory} as defined above.
+\label{Storage:Storage:HeartbeatInterval}
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
\index[sd]{Heartbeat Interval}
\index[sd]{Directive!Heartbeat Interval}
duration despite the fact that keepalive is set. This usually
results in a broken pipe error message.
+\label{Storage:Storage:ClientConnectWait}
\item [Client Connect Wait = \lt{}time-interval\gt{}]
\index[sd]{Connect Wait}
\index[sd]{Directive!Connect Wait}
longer the Storage daemon waits for a Client, the more
resources will be tied up.
+\label{Storage:Storage:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[sd]{Maximum Concurrent Jobs}
\index[sd]{Directive!Maximum Concurrent Jobs}
the Storage resource in the Director's configuration file and possibly
those in the Job and Client resources.
+\label{Storage:Storage:SDAddresses}
\item [SDAddresses = \lt{}IP-address-specification\gt{}]
\index[sd]{SDAddresses}
\index[sd]{Directive!SDAddresses}
Using this directive, you can replace both the SDPort and SDAddress
directives shown below.
+\label{Storage:Storage:SdPort}
\item [SDPort = \lt{}port-number\gt{}]
\index[sd]{SDPort}
\index[sd]{Directive!SDPort}
Specifies port number on which the Storage daemon listens for Director
connections. The default is 9103.
+\label{Storage:Storage:SdAddress}
\item [SDAddress = \lt{}IP-Address\gt{}]
\index[sd]{SDAddress}
\index[sd]{Directive!SDAddress}
\begin{description}
+\label{Storage:Director:Name}
\item [Name = \lt{}Director-Name\gt{}]
\index[sd]{Name}
\index[sd]{Directive!Name}
Specifies the Name of the Director allowed to connect to the Storage daemon.
This directive is required.
+\label{Storage:Director:Password}
\item [Password = \lt{}Director-password\gt{}]
\index[sd]{Password}
\index[sd]{Directive!Password}
Specifies the password that must be supplied by the above named Director.
This directive is required.
+\label{Storage:Director:Monitor}
\item [Monitor = \lt{}yes\vb{}no\gt{}]
\index[sd]{Monitor}
\index[sd]{Directive!Monitor}
\begin{description}
+\label{Storage:Device:Name}
\item [Name = {\it Device-Name}]
\index[sd]{Name}
\index[sd]{Directive!Name}
\ilink{Device directive}{StorageResource2} in its Storage
resource.
+\label{Storage:Device:ArchiveDevice}
\item [Archive Device = {\it name-string}]
\index[sd]{Archive Device}
\index[sd]{Directive!Archive Device}
The Archive Device directive is required.
+\label{Storage:Device:DeviceType}
\item [Device Type = {\it type-specification}]
\index[sd]{Device Type}
\index[sd]{Directive!Device Type}
This directive was implemented in Bacula version 1.38.6.
+\label{Storage:Device:MediaType}
\item [Media Type = {\it name-string}]
\index[sd]{Media Type}
\index[sd]{Directive!Media Type}
Bacula to select the correct Device resource, each one must have a
unique Media Type.
+
+\label{Storage:Device:Autochanger}
\label{Autochanger}
\item [Autochanger = {\it yes\vb{}no}]
\index[sd]{Autochanger}
\ilink{Storage resource}{Autochanger1} in the Director's
configuration file so that when labeling tapes you are prompted for the slot.
+\label{Storage:Device:ChangerDevice}
\item [Changer Device = {\it name-string}]
\index[sd]{Changer Device}
\index[sd]{Directive!Changer Device}
of this manual for more details of using this and the following
autochanger directives.
+\label{Storage:Device:ChangerCommand}
\item [Changer Command = {\it name-string}]
\index[sd]{Changer Command}
\index[sd]{Directive!Changer Command}
For FreeBSD users, you might want to see one of the several {\bf chio}
scripts in {\bf examples/autochangers}.
+\label{Storage:Device:AlertCommand}
\item [Alert Command = {\it name-string}]
\index[sd]{Alert Command}
The {\bf name-string} specifies an external program to be called at the
\end{lstlisting}
\normalsize
+\label{Storage:Device:DriveIndex}
\item [Drive Index = {\it number}]
\index[sd]{Drive Index}
\index[sd]{Directive!Drive Index}
the past -- the default mtx-changer script works for any number of
drives.
+\label{Storage:Device:Autoselect}
\item [Autoselect = {\it yes\vb{}no}]
\index[sd]{Autoselect}
\index[sd]{Directive!Autoselect}
start new Jobs on any other available compatible drive. This facilitates
writing to multiple drives with multiple Jobs that all use the same Pool.
+\label{Storage:Device:MaximumChangerWait}
\item [Maximum Changer Wait = {\it time}]
\index[sd]{Maximum Changer Wait}
\index[sd]{Directive!Maximum Changer Wait}
% TODO: if this is the format, then maybe "5 minutes" should be in
% TODO: quotes? define style. see others.
+\label{Storage:Device:MaximumRewindWait}
\item [Maximum Rewind Wait = {\it time}]
\index[sd]{Maximum Rewind Wait}
\index[sd]{Directive!Maximum Rewind Wait}
for a rewind before timing out. If this time is exceeded,
Bacula will cancel the job. The default is 5 minutes.
+\label{Storage:Device:MaximumOpenWait}
\item [Maximum Open Wait = {\it time}]
\index[sd]{Maximum Open Wait}
\index[sd]{Directive!Maximum Open Wait}
for a open before timing out. If this time is exceeded,
Bacula will cancel the job. The default is 5 minutes.
+\label{Storage:Device:AlwaysOpen}
\item [Always Open = {\it yes\vb{}no}]
\index[sd]{Always Open}
\index[sd]{Directive!Always Open}
drive autochanger operations will fail. We strongly recommend to keep
{\bf Always Open} set to {\bf Yes}
+\label{Storage:Device:VolumePollInterval}
\item [Volume Poll Interval = {\it time}]
\index[sd]{Volume Poll Interval}
\index[sd]{Directive!Volume Poll Interval}
\bsysxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
in the \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
-\item [Close on Poll= {\it yes\vb{}no}]
+\label{Storage:Device:CloseOnPoll}
+\item [Close on Poll = {\it yes\vb{}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
the drive on the next poll and automatically continue with the backup.
Please see above more more details.
+\label{Storage:Device:MaximumOpenWait}
\item [Maximum Open Wait = {\it time}]
\index[sd]{Maximum Open Wait}
\index[sd]{Directive!Maximum Open Wait}
error. Bacula will re-attempt to open the drive the next time a Job
starts that needs the the drive.
+
+\label{Storage:Device:RemovableMedia}
\label{removablemedia}
-\item [Removable media = {\it yes\vb{}no}]
+\item [Removable Media = {\it yes\vb{}no}]
\index[sd]{Removable media}
\index[sd]{Directive!Removable media}
If {\bf Yes}, this device supports removable media (for example, tapes
{\bf Removable Media}.
-\item [Random access = {\it yes\vb{}no}]
+\label{Storage:Device:RandomAccess}
+\item [Random Access = {\it yes\vb{}no}]
\index[sd]{Random access}
\index[sd]{Directive!Random access}
If {\bf Yes}, the archive device is assumed to be a random access medium
{\bf No} for non-random access devices such as tapes and named pipes.
+\label{Storage:Device:RequiresMount}
\item [Requires Mount = {\it yes\vb{}no}]
\index[sd]{Requires Mount }
When this directive is enabled, the Storage daemon will submit
directives must also be defined: {\bf Mount Point}, {\bf Mount Command},
and {\bf Unmount Command}.
+\label{Storage:Device:MountPoint}
\item [Mount Point = {\it directory}]
\index[sd]{Mount Point}
Directory where the device can be mounted.
for devices that have {\bf Requires Mount} enabled such as
USB file devices.
+\label{Storage:Device:MountCommand}
\item [Mount Command = {\it name-string}]
\index[sd]{Mount Command}
This directive specifies the command that must be executed to mount
If you need to specify multiple commands, create a shell script.
+\label{Storage:Device:UnmountCommand}
\item [Unmount Command = {\it name-string}]
\index[sd]{Unmount Command}
This directive specifies the command that must be executed to unmount
drives or for disk Volumes where doing so may allow corrupted data to go
undetected.
+\label{Storage:Device:MinimumBlockSize}
\item [Minimum block size = {\it size-in-bytes}]
\index[sd]{Minimum block size}
\index[sd]{Directive!Minimum block size}
\end{lstlisting}
\normalsize
+\label{Storage:Device:MaximumBlockSize}
\item [Maximum block size = {\it size-in-bytes}]
\index[sd]{Maximum block size}
\index[sd]{Directive!Maximum block size}
The maximum {\bf size-in-bytes} possible is 2,000,000.
+\label{Storage:Device:HardwareEndOfMedium}
\item [Hardware End of Medium = {\it yes\vb{}no}]
\index[sd]{Hardware End of Medium}
\index[sd]{Directive!Hardware End of Medium}
supports this function. All modern (after 1998) tape drives support this
feature.
+\label{Storage:Device:FastForwardSpaceFile}
\item [Fast Forward Space File = {\it yes\vb{}no}]
\index[sd]{Fast Forward Space File}
\index[sd]{Directive!Fast Forward Space File}
Default setting for Fast Forward Space File is {\bf Yes}.
+\label{Storage:Device:UseMtiocget}
\item [Use MTIOCGET = {\it yes\vb{}no}]
\index[sd]{Use MTIOCGET}
\index[sd]{Directive!Use MTIOCGET}
on a few *BSD systems. Operating systems known to work correctly are
Solaris, Linux and FreeBSD.
+\label{Storage:Device:BsfAtEom}
\item [BSF at EOM = {\it yes\vb{}no}]
\index[sd]{BSF at EOM}
\index[sd]{Directive!BSF at EOM}
the second EOF mark. Determination of whether or not you need this directive
is done using the {\bf test} command in the {\bf btape} program.
+
+\label{Storage:Device:TwoEof}
\item [TWO EOF = {\it yes\vb{}no}]
\index[sd]{TWO EOF}
\index[sd]{Directive!TWO EOF}
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.
+\label{Storage:Device:BackwardSpaceRecord}
\item [Backward Space Record = {\it yes\vb{}no}]
\index[sd]{Backward Space Record}
\index[sd]{Directive!Backward Space Record}
function off, the test will not be done. This causes no harm as the re-read
process is precautionary rather than required.
+\label{Storage:Device:BackwardSpaceFile}
\item [Backward Space File = {\it yes\vb{}no}]
\index[sd]{Backward Space File}
\index[sd]{Directive!Backward Space File}
advanced forward to the desired position. Default is {\bf Yes} for non
random-access devices.
+\label{Storage:Device:ForwardSpaceRecord}
\item [Forward Space Record = {\it yes\vb{}no}]
\index[sd]{Forward Space Record}
\index[sd]{Directive!Forward Space Record}
advance the position on the device. Default is {\bf Yes} for non
random-access devices.
+\label{Storage:Device:ForwardSpaceFile}
\item [Forward Space File = {\it yes\vb{}no}]
\index[sd]{Forward Space File}
\index[sd]{Directive!Forward Space File}
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.
+\label{Storage:Device:OfflineOnUnmount}
\item [Offline On Unmount = {\it yes\vb{}no}]
\index[sd]{Offline On Unmount}
\index[sd]{Directive!Offline On Unmount}
in the \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
+\label{Storage:Device:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[sd]{Device Maximum Concurrent Jobs}
\index[sd]{Directive!Device Maximum Concurrent Jobs}
compatible drive. This facilitates writing to multiple drives with
multiple Jobs that all use the same Pool.
+\label{Storage:Device:MaximumVolumeSize}
\item [Maximum Volume Size = {\it size}]
\index[sd]{Maximum Volume Size}
\index[sd]{Directive!Maximum Volume Size}
directive is deprecated (being phased out) in favor of the {\bf Maximum
Volume Bytes} defined in the Director's configuration file.
+\label{Storage:Device:MaximumFileSize}
\item [Maximum File Size = {\it size}]
\index[sd]{Maximum File Size}
\index[sd]{Directive!Maximum File Size}
{\bf Maximum Volume Bytes} directive in the Director's Pool resource,
which does the same thing but on a Pool (Volume) basis.
+\label{Storage:Device:BlockPositioning}
\item [Block Positioning = {\it yes\vb{}no}]
\index[sd]{Block Positioning}
\index[sd]{Directive!Block Positioning}
tapes with Bacula in variable block mode (the default), but your drive
was in fixed block mode. The default is {\bf yes}.
+\label{Storage:Device:MaximumNetworkBufferSize}
\item [Maximum Network Buffer Size = {\it bytes}]
\index[sd]{Maximum Network Buffer Size}
\index[sd]{Directive!Maximum Network Buffer Size}
in each of your File daemons conf files.
+\label{Storage:Device:MaximumSpoolSize}
\item [Maximum Spool Size = {\it bytes}]
\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.
+\label{Storage:Device:MaximumJobSpoolSize}
\item [Maximum Job Spool Size = {\it bytes}]
\index[sd]{Maximum Job Spool Size}
\index[sd]{Directive!Maximum Job Spool Size}
running. The default is no limit.
This directive is implemented only in version 1.37 and later.
+\label{Storage:Device:SpoolDirectory}
\item [Spool Directory = {\it directory}]
\index[sd]{Spool Directory}
\index[sd]{Directive!Spool Directory}
writing to a device that requires mount (USB). The default is to use the
working directory.
+\label{Storage:Device:MaximumPartSize}
\item [Maximum Part Size = {\it bytes}]
\index[sd]{Maximum Part Size}
\index[sd]{Directive!Maximum Part Size}
\begin{description}
+\label{Storage:Device:RequiresMount}
\item [Requires Mount = {\it yes\vb{}no}]
\index[sd]{Requires Mount}
\index[sd]{Directive!Requires Mount}
set, {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and
{\bf Write Part Command} directives must also be defined.
+\label{Storage:Device:MountPoint}
\item [Mount Point = {\it directory}]
\index[sd]{Mount Point}
\index[sd]{Directive!Mount Point}
Directory where the device can be mounted.
+\label{Storage:Device:MountCommand}
\item [Mount Command = {\it name-string}]
\index[sd]{Mount Command}
\index[sd]{Directive!Mount Command}
Similar consideration should be given to all other Command parameters.
+\label{Storage:Device:UnmountCommand}
\item [Unmount Command = {\it name-string}]
\index[sd]{Unmount Command}
\index[sd]{Directive!Unmount Command}
\begin{description}
+\label{Storage:Device:LabelMedia}
\item [Label Media = {\it yes\vb{}no}]
\index[general]{Label Media}
\index[sd]{Label Media}
when the tape has been recycled. The automatic labeling feature is most
useful when writing to disk rather than tape volumes.
+\label{Storage:Device:AutomaticMount}
\item [Automatic mount = {\it yes\vb{}no}]
\index[sd]{Automatic mount}
\index[sd]{Directive!Automatic mount}
projects / bacula / docs / commitdiff