\footnotesize
\begin{verbatim}
- DirAddresses = {
- ip = { addr = 1.2.3.4; port = 1205;}
+ DirAddresses = {
+ ip = {addr = 1.2.3.4; port = 1205;}
ipv4 = {
addr = 1.2.3.4; port = http;}
ipv6 = {
addr = 1.2.3.4
port = 1205
}
- ip = { addr = 1.2.3.4 }
- ip = { addr = 201:220:222::2 }
+ ip = {addr = 1.2.3.4 }
+ ip = {addr = 201:220:222::2 }
ip = {
addr = bluedot.thun.net
}
Job records that are older than the specified period.
Theses statistics records aren't use for restore purpose, but mainly for
- capacity planning, billings, etc. See \ilink{Statistics chapter} for
+ capacity planning, billings, etc. See \ilink{Statistics chapter}{TO-BE-REPLACED} for
additional information.
- See the \ilink{ Configuration chapter}{Time} of this manual for additional
+ See the \ilink{Configuration chapter}{Time} of this manual for additional
details of time specification.
The default is 5 years.
where \lt{}string\gt{} is an identifier which can be used for support purpose.
This string is displayed using the \texttt{version} command.
-\item[MaxConsoleConnections = \lt{}number\gt{}]
+\item[MaximumConsoleConnections = \lt{}number\gt{}]
\index[dir]{MaximumConsoleConnections}
- \index[dir]{MaxConsoleConnections}
- \index[dir]{Directive!MaxConsoleConnections}
+ \index[dir]{Directive!MaximumConsoleConnections}
\index[dir]{Console}
where \lt{}number\gt{} is the maximum number of Console Connections that
could run concurrently. The default is set to 20, but you may set it to a
However, to manage deleted files or directories changes in the
catalog during an Incremental backup you can use \texttt{accurate}
- mode. This is quite memory consuming process. See \ilink{Accurate
- mode}{accuratemode} for more details.
+ mode. This is quite memory consuming process. See \ilink{Accurate mode}{accuratemode} for more details.
\item [Differential]
\index[dir]{Differential}
%% TODO: merge this with incremental
However, to manage deleted files or directories changes in the
catalog during an Differential backup you can use \texttt{accurate}
- mode. This is quite memory consuming process. See \ilink{Accurate
- mode}{accuratemode} for more details.
+ mode. This is quite memory consuming process. See \ilink{Accurate mode}{accuratemode} for more details.
Every once and a while, someone asks why we need Differential
backups as long as Incremental backups pickup all changed files.
\item [VolumeToCatalog]
\index[dir]{VolumeToCatalog}
This level causes Bacula to read the file attribute data written to the
- Volume from the last Job. The file attribute data are compared to the
+ Volume from the last backup Job for the job specified on the {\bf VerifyJob}
+ directive. The file attribute data are compared to the
values saved in the Catalog database and any differences are reported.
- This is similar to the {\bf Catalog} level except that instead of
+ This is similar to the {\bf DiskToCatalog} level except that instead of
comparing the disk file attributes to the catalog database, the
attribute data written to the Volume is read and compared to the catalog
database. Although the attribute data including the signatures (MD5 or
This level causes Bacula to read the files as they currently are on
disk, and to compare the current file attributes with the attributes
saved in the catalog from the last backup for the job specified on the
- {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
+ {\bf VerifyJob} directive. This level differs from the {\bf VolumeToCatalog}
level described above by the fact that it doesn't compare against a
previous Verify job but against a previous backup. When you run this
level, you must supply the verify options on your Include statements.
and renamed directories are restored properly.
In this mode, the File daemon must keep data concerning all files in
- memory. So you do not have sufficient memory, the restore may
+ memory. So If you do not have sufficient memory, the backup may
either be terribly slow or fail.
%% $$ memory = \sum_{i=1}^{n}(strlen(path_i + file_i) + sizeof(CurFile))$$
\item [FileSet = \lt{}FileSet-resource-name\gt{}]
\index[dir]{FileSet}
-\index[dir]{FileSet}
+\index[dir]{Directive!FileSet}
The FileSet directive specifies the FileSet that will be used in the
current Job. The FileSet specifies which directories (or files) are to
be backed up, and what options to use (e.g. compression, ...). Only a
details, see the \ilink{FileSet Resource section}{FileSetResource} of
this chapter. This directive is required.
+\item [Base = \lt{}job-resource-name, ...\gt{}]
+\index[dir]{Base}
+\index[dir]{Directive!Base}
+The Base directive permits to specify the list of jobs that will be used during
+Full backup as base. This directive is optional. See the \ilink{Base Job chapter}{basejobs} for more information.
+
\item [Messages = \lt{}messages-resource-name\gt{}]
\index[dir]{Messages}
\index[dir]{Directive!Messages}
backed up. Many Bacula installations will use only the {\bf Default}
pool. However, if you want to specify a different set of Volumes for
different Clients or different Jobs, you will probably want to use
- Pools. For additional details, see the \ilink{Pool Resource
- section}{PoolResource} of this chapter. This directive is required.
+ Pools. For additional details, see the \ilink{Pool Resource section}{PoolResource} of this chapter. This directive is required.
\item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Full Backup Pool}
many different times, and each {\bf run} directive permits overriding
the default Job Level Pool, Storage, and Messages resources. This gives
considerable flexibility in what can be done with a single Job. For
- additional details, see the \ilink{Schedule Resource
- Chapter}{ScheduleResource} of this manual.
+ additional details, see the \ilink{Schedule Resource Chapter}{ScheduleResource} of this manual.
\item [Storage = \lt{}storage-resource-name\gt{}]
\index[dir]{Directive!Max Run Time}
The time specifies the maximum allowed time that a job may run, counted
from when the job starts, ({\bf not} necessarily the same as when the
- job was scheduled).
+ job was scheduled).
+
+ By default, the the watchdog thread will kill any Job that has run more
+ than 6 days. The maximum watchdog timeout is independent of MaxRunTime
+ and cannot be changed.
+
\item [Incremental|Differential Max Wait Time = \lt{}time\gt{}]
\index[dir]{Incremental Wait Run Time}
when the job starts, ({\bf not} necessarily the same as when the job was
scheduled). This directive works as expected since bacula 2.3.18.
-\addcontentsline{lof}{figure}{Job time control directives}
-\includegraphics{\idir different_time.eps}
+\begin{figure}[htbp]
+ \centering
+ \includegraphics[width=\linewidth]{different_time}
+ \caption{Job time control directives}
+ \label{fig:differenttime}
+\end{figure}
+
+\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.
\item [Max Full Interval = \lt{}time\gt{}]
\index[dir]{Max Full Interval}
\item [Prune Volumes = \lt{}yes\vb{}no\gt{}]
\index[dir]{Prune Volumes}
\index[dir]{Directive!Prune Volumes}
- Normally, pruning of Volumes from the Catalog is specified on a Client
- by Client basis in the Client resource with the {\bf AutoPrune}
- directive. If this directive is specified (not normally) and the value
- is {\bf yes}, it will override the value specified in the Client
- resource. The default is {\bf no}.
+ Normally, pruning of Volumes from the Catalog is specified on a Pool by
+ Pool basis in the Pool resource with the {\bf AutoPrune} directive.
+ Note, this is different from File and Job pruning which is done on a
+ Client by Client basis. If this directive is specified (not normally)
+ and the value is {\bf yes}, it will override the value specified in the
+ Pool resource. The default is {\bf no}.
\item [RunScript \{\lt{}body-of-runscript\gt{}\}]
\index[dir]{RunScript}
You can use following options may be specified in the body
of the runscript:\\
-\begin{tabular}{|c|c|c|l}
-Options & Value & Default & Information \\
-\hline
-\hline
-Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
-\hline
-Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
-\hline
-Runs On Client & Yes/No & {\it Yes} & Run command on client\\
-\hline
-Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
-\hline
-Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
- something different from 0 \\
-\hline
-Command & & & Path to your script\\
-\hline
-Console & & & Console command\\
-\hline
-\end{tabular}
- \\
+\LTXtable{\linewidth}{table_runscript}
Any output sent by the command to standard output will be included in the
Bacula job report. The command string must be a valid program name or name
\footnotesize
\begin{verbatim}
%% = %
+ %b = Job Bytes
%c = Client's name
- %d = Director's name
+ %C = If the job is a Cloned job (Only on director side)
+ %d = Daemon's name (Such as host-dir or host-fd)
+ %D = Director's name (Also valid on file daemon)
%e = Job Exit Status
+ %f = Job FileSet (Only on director side)
+ %F = Job Files
+ %h = Client address
%i = JobId
%j = Unique Job id
%l = Job Level
%n = Job name
+ %p = Pool name (Only on director side)
+ %P = Current PID
%s = Since time
%t = Job type (Backup, ...)
%v = Volume name (Only on director side)
+ %w = Storage name (Only on director side)
+ %x = Spooling enabled? ("yes" or "no")
\end{verbatim}
\normalsize
-The Job Exit Status code \%e edits the following values:
+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}
You can use these following shortcuts:\\
-\begin{tabular}{|c|c|c|c|c|c}
-Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
-\hline
-Run Before Job & & & Yes & No & Before \\
-\hline
-Run After Job & Yes & No & & No & After \\
-\hline
-Run After Failed Job & No & Yes & & No & After \\
-\hline
-Client Run Before Job & & & Yes & Yes & Before \\
-\hline
-Client Run After Job & Yes & No & & Yes & After \\
-\end{tabular}
-
+\LTXtable{\linewidth}{table_runscriptshortcuts}
Examples:
\begin{verbatim}
RunScript {
You can run scripts just after snapshots initializations with
\textsl{AfterVSS} keyword.
- In addition, for a Windows client on version 1.33 and above, please take
+ In addition, for a Windows client, please take
note that you must ensure a correct path to your script. The script or
program can be a .com, .exe or a .bat file. If you just put the program
name in then Bacula will search using the same rules that cmd.exe uses
substitution as described above for the {\bf RunScript} directive.
An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
+ \borgxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
See the {\bf Run After Failed Job} if you
want to run a script after the job has terminated with any
\end{verbatim}
An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
+ \borgxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
\item [Client Run Before Job = \lt{}command\gt{}]
If this directive is set to {\bf yes} (default no), the Storage daemon will
be requested to spool the data for this Job to disk rather than write it
- directly to tape. Once all the data arrives or the spool files' maximum sizes
- are reached, the data will be despooled and written to tape. Spooling data
- prevents tape shoe-shine (start and stop) during
- Incremental saves. If you are writing to a disk file using this option
- will probably just slow down the backup jobs.
+ directly to the Volume (normally a tape).
+
+ Thus the data is written in large blocks to the Volume rather than small
+ blocks. This directive is particularly useful when running multiple
+ simultaneous backups to tape. Once all the data arrives or the spool
+ files' maximum sizes are reached, the data will be despooled and written
+ to tape.
+
+ Spooling data prevents interleaving date from several job and reduces or
+ eliminates tape drive stop and start commonly known as "shoe-shine".
+
+ We don't recommend using this option if you are writing to a disk file
+ using this option will probably just slow down the backup jobs.
NOTE: When this directive is set to yes, Spool Attributes is also
automatically set to yes.
NOTE: When Spool Data is set to yes, Spool Attributes is also
automatically set to yes.
+\item [SpoolSize={\it bytes}]
+ \index[dir]{SpoolSize}
+ \index[dir]{Directive!SpoolSize}
+ where the bytes specify the maximum spool size for this job.
+ The default is take from Device Maximum Spool Size limit.
+ This directive is available only in Bacula version 2.3.5 or
+ later.
+
+
\item [Where = \lt{}directory\gt{}]
\index[dir]{Where}
\index[dir]{Directive!Where}
\index[dir]{AddPrefix}
\index[dir]{Directive!AddPrefix}
This directive applies only to a Restore job and specifies a prefix to the
- directory name of all files being restored. This will use \ilink{File
- Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
+ directory name of all files being restored. This will use \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
\item [Add Suffix = \lt{}extention\gt{}]
\index[dir]{AddSuffix}
\index[dir]{RegexWhere}
\index[dir]{Directive!RegexWhere}
This directive applies only to a Restore job and specifies a regex filename
- manipulation of all files being restored. This will use \ilink{File
- Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
+ manipulation of all files being restored. This will use \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
For more informations about how use this option, see
\ilink{this}{useregexwhere}.
Director, Client, or Storage resources will also apply in addition to
the limit specified here. The default is set to 1, but you may set it
to a larger number. We strongly recommend that you read the WARNING
- documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
+ documented under \ilink{Maximum Concurrent Jobs}{DirMaxConJobs} in the
Director's resource.
\item [Reschedule On Error = \lt{}yes\vb{}no\gt{}]
\index[dir]{Directive!Reschedule Interval}
If you have specified {\bf Reschedule On Error = yes} and the job
terminates in error, it will be rescheduled after the interval of time
- specified by {\bf time-specification}. See \ilink{the time
- specification formats}{Time} in the Configure chapter for details of
+ specified by {\bf time-specification}. See \ilink{the time specification formats}{Time} in the Configure chapter for details of
time specifications. If no interval is specified, the job will not be
- rescheduled on error.
+ rescheduled on error. The default Reschedule Interval
+ is 30 minutes (1800 seconds).
\item [Reschedule Times = \lt{}count\gt{}]
\index[dir]{Reschedule Times}
\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
\index[general]{Allow Duplicate Jobs}
+\begin{figure}[htbp]
+ \centering
+ \includegraphics[width=\linewidth]{duplicate-real}
+ \caption{Allow Duplicate Jobs usage}
+ \label{fig:allowduplicatejobs}
+\end{figure}
+
A duplicate job in the sense we use it here means a second or subsequent job
with the same name starts. This happens most frequently when the first job
runs longer than expected because no tapes are available.
\item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}]
\index[general]{Allow Higher Duplicates}
- If this directive is set to {\bf yes} (default) the job with a higher
- priority (lower priority number) will be permitted to run, and
- the current job will be cancelled. If the
- priorities of the two jobs are the same, the outcome is determined by
- other directives (see below).
+ 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
+ of Bacula the directive is disabled (disregarded).
+
+
+\item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}]
+\index[general]{Cancel Lower Level Duplicates}
+ If \textbf{Allow Duplicate Jobs} is set to \textbf{no} and this
+ directive is set to \textbf{yes}, Bacula will choose between duplicated
+ jobs the one with the highest level. For example, it will cancel a
+ previous Incremental to run a Full backup. It works only for Backup
+ jobs. The default is \texttt{no}. If the levels of the duplicated
+ jobs are the same, nothing is done and the other
+ Cancel XXX Duplicate directives will be examined.
\item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}]
\index[general]{Cancel Queued Duplicates}
if this directive is set to {\bf yes} any job that is already running
will be canceled. The default is {\bf no}.
+
+%%\item[DuplicateJobProximity = \lt{}time-specification\gt{}]
+%%\index[general]{Duplicate Job Proximity}
+%% This directive permits to determine if two jobs are really duplicated.
+%% If the first one is running for long time, this is probably not a good
+%% idea to cancel it.
+
\item [Run = \lt{}job-name\gt{}]
\index[dir]{Run}
\index[dir]{Directive!Run}
keep these points in mind:
\begin{itemize}
-\item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
- concurrent jobs.
+\item See \borgxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup
+ concurrent jobs in the \problemsman{}.
\item Bacula concurrently runs jobs of only one priority at a time. It
will not simultaneously run a priority 1 and a priority 2 job.
the running jobs finishes. However, new priority 10 jobs will not
be run until the priority 5 job has finished.
-\label{WritePartAfterJob}
-\item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
-\index[dir]{Write Part After Job}
-\index[dir]{Directive!Write Part After Job}
- This directive is only implemented in version 1.37 and later.
- If this directive is set to {\bf yes} (default {\bf no}), a new part file
- will be created after the job is finished.
-
- It should be set to {\bf yes} when writing to devices that require mount
- (for example DVD), so you are sure that the current part, containing
- this job's data, is written to the device, and that no data is left in
- the temporary file on the hard disk. However, on some media, like DVD+R
- and DVD-R, a lot of space (about 10Mb) is lost every time a part is
- written. So, if you run several jobs each after another, you could set
- this directive to {\bf no} for all jobs, except the last one, to avoid
- wasting too much space, but to ensure that the data is written to the
- medium when all jobs are finished.
-
- This directive is ignored with tape and FIFO devices.
+%% \label{WritePartAfterJob}
+%% \item [Write Part After Job = \lt{}yes\vb{}no\gt{}]
+%% \index[dir]{Write Part After Job}
+%% \index[dir]{Directive!Write Part After Job}
+%% This directive is only implemented in version 1.37 and later.
+%% If this directive is set to {\bf yes} (default {\bf no}), a new part file
+%% will be created after the job is finished.
+
+%% It should be set to {\bf yes} when writing to devices that require mount
+%% (for example DVD), so you are sure that the current part, containing
+%% this job's data, is written to the device, and that no data is left in
+%% the temporary file on the hard disk. However, on some media, like DVD+R
+%% and DVD-R, a lot of space (about 10Mb) is lost every time a part is
+%% written. So, if you run several jobs each after another, you could set
+%% this directive to {\bf no} for all jobs, except the last one, to avoid
+%% wasting too much space, but to ensure that the data is written to the
+%% medium when all jobs are finished.
+
+%% This directive is ignored with tape and FIFO devices.
\end{description}
specifies to use the Pool named {\bf Incremental} if the job is an
incremental backup.
-\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). Thus the data is
- written in large blocks to the Volume rather than small blocks. This
- directive is particularly useful when running multiple simultaneous
- backups to tape. It prevents interleaving of the job data and reduces
- or eliminates tape drive stop and start commonly known as "shoe-shine".
-\item [SpoolSize={\it bytes}]
- \index[dir]{SpoolSize}
- \index[dir]{Directive!SpoolSize}
- where the bytes specify the maximum spool size for this job.
- The default is take from Device Maximum Spool Size limit.
- This directive is available only in Bacula version 2.3.5 or
- later.
+\item [Accurate=yes\vb{}no]
+ \index[dir]{Accurate}
+ \index[dir]{Directive!Accurate}
+ tells Bacula to use or not the Accurate code for the specific job. It can
+ allow you to save memory and and CPU resources on the catalog server in some
+ cases.
-\item [WritePartAfterJob=yes\vb{}no]
- \index[dir]{WritePartAfterJob}
- \index[dir]{Directive!WritePartAfterJob}
- tells Bacula to request the Storage daemon to write the current part
- file to the device when the job is finished (see \ilink{Write Part After
- Job directive in the Job resource}{WritePartAfterJob}). Please note,
- this directive is implemented only in version 1.37 and later. The
- default is yes. We strongly recommend that you keep this set to yes
- otherwise, when the last job has finished one part will remain in the
- spool file and restore may or may not work.
+
+%% \item [WritePartAfterJob=yes\vb{}no]
+%% \index[dir]{WritePartAfterJob}
+%% \index[dir]{Directive!WritePartAfterJob}
+%% tells Bacula to request the Storage daemon to write the current part
+%% file to the device when the job is finished (see \ilink{Write Part After Job directive in the Job resource}{WritePartAfterJob}). Please note,
+%% this directive is implemented only in version 1.37 and later. The
+%% default is yes. We strongly recommend that you keep this set to yes
+%% otherwise, when the last job has finished one part will remain in the
+%% spool file and restore may or may not work.
\end{description}
process, but it is preferable for security reasons to make the text
random.
-\label{FileRetention}
\item [File Retention = \lt{}time-period-specification\gt{}]
\label{FileRetention}
\index[dir]{File Retention}
keep File records in the Catalog database after the End time of the
Job corresponding to the File records.
When this time period expires, and if
- {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
- that are older than the specified File Retention period. Note, this affects
- only records in the catalog database. It does not affect your archive
- backups.
-
- File records may actually be retained for a shorter period than you specify
- on this directive if you specify either a shorter {\bf Job Retention} or a
- shorter {\bf Volume Retention} period. The shortest retention period of the
- three takes precedence. The time may be expressed in seconds, minutes,
- hours, days, weeks, months, quarters, or years. See the
- \ilink{ Configuration chapter}{Time} of this manual for
- additional details of time specification.
+ {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File
+ records that are older than the specified File Retention period. Note,
+ this affects only records in the catalog database. It does not affect
+ your archive backups.
+
+ File records may actually be retained for a shorter period than you
+ specify on this directive if you specify either a shorter {\bf Job
+ Retention} or a shorter {\bf Volume Retention} period. The shortest
+ retention period of the three takes precedence. The time may be
+ expressed in seconds, minutes, hours, days, weeks, months, quarters, or
+ years. See the \ilink{Configuration chapter}{Time} of this manual for
+ additional details of time specification.
The default is 60 days.
-\label{JobRetention}
\item [Job Retention = \lt{}time-period-specification\gt{}]
\label{JobRetention}
\index[dir]{Job Retention}
The Job retention period is specified as seconds, minutes, hours, days,
weeks, months, quarters, or years. See the
- \ilink{ Configuration chapter}{Time} of this manual for
+ \ilink{Configuration chapter}{Time} of this manual for
additional details of time specification.
The default is 180 days.
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.
+\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
+\index[dir]{Maximum Bandwidth Per Job}
+\index[dir]{Directive!Maximum Bandwidth Per Job}
+
+The speed parameter specifies the maximum allowed bandwidth that a job may use
+when started for this Client. The speed parameter should be specified in
+k/s, Kb/s, m/s or Mb/s.
+
\item [Priority = \lt{}number\gt{}]
\index[dir]{Priority}
\index[dir]{Directive!Priority}
since they are found in different directories. For this reason, you
probably should use two different Media Types for your two disk Devices
(even though you might think of them as both being File types). You can
- find more on this subject in the \ilink{Basic Volume
- Management}{DiskChapter} chapter of this manual.
+ find more on this subject in the \ilink{Basic Volume Management}{DiskChapter} chapter of this manual.
The {\bf MediaType} specified in the Director's Storage resource, {\bf
must} correspond to the {\bf Media Type} specified in the {\bf Device}
For the autochanger to be used, you must also specify {\bf Autochanger =
yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
configuration file as well as other important Storage daemon
- configuration information. Please consult the \ilink{Using
- Autochangers}{AutochangersChapter} manual of this chapter for the
+ configuration information. Please consult the \ilink{Using Autochangers}{AutochangersChapter} manual of this chapter for the
details of using autochangers.
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
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. However, if
you set the Storage daemon's number of concurrent jobs greater than one,
- we recommend that you read the waring documented under \ilink{Maximum
- Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
- turn data spooling on as documented in the \ilink{Data
- Spooling}{SpoolingChapter} chapter of this manual.
+ we recommend that you read the waring documented under \ilink{Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
+ turn data spooling on as documented in the \ilink{Data Spooling}{SpoolingChapter} chapter of this manual.
\item [AllowCompression = \lt{}yes\vb{}no\gt{}]
\label{AllowCompression}
to the Volume. If you specify zero (the default), there is no limit
except the physical size of the Volume. Otherwise, when the number of
bytes written to the Volume equals {\bf size} the Volume will be marked
- {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
- used for appending Jobs, much like the {\bf Full} status but it can be
+ {\bf Full}. When the Volume is marked {\bf Full} it can no longer be
+ used for appending Jobs, but it can be
recycled if recycling is enabled, and thus the Volume can be re-used
- after recycling. This value is checked and the {\bf Used} status set
- while the job is writing to the particular volume.
+ after recycling. The size specified is checked just before each
+ block is written to the Volume and if the Volume size would exceed the
+ specified Maximum Volume Bytes the {\bf Full} status will be set and
+ the Job will request the next available Volume to continue.
This directive is particularly useful for restricting the size
of disk volumes, and will work correctly even in the case of
created, changing the value in the bacula-dir.conf file will not change what
is stored for the Volume. To change the value for an existing Volume you
must use the
- \ilink{\bf update volume}{UpdateCommand} command in the Console.
+ \borgxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
\item [Catalog Files = \lt{}yes\vb{}no\gt{}]
\index[dir]{Catalog Files}
\item [Volume Retention = \lt{}time-period-specification\gt{}]
\index[dir]{Volume Retention}
\index[dir]{Directive!Volume Retention}
- The Volume Retention directive defines the length of time that {\bf
- Bacula} will keep records associated with the Volume in
- the Catalog database after the End time of each Job written to the
- Volume. When this time period expires, and if {\bf AutoPrune} is set to
- {\bf yes} Bacula may prune (remove) Job records that are older than the
- specified Volume Retention period if it is necessary to free up a
- Volume. Recycling will not occur until it is absolutely necessary to
+ The Volume Retention directive defines the longest amount of time that
+ {\bf Bacula} will keep records associated with the Volume in the Catalog
+ database after the End time of each Job written to the Volume. When
+ this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
+ Bacula may prune (remove) Job records that are older than the specified
+ Volume Retention period if it is necessary to free up a Volume. Note,
+ it is also possible for all the Job and File records to be pruned before
+ the Volume Retention period is reached. In that case the Volume can
+ then be marked Pruned and subsequently recycled prior to expiration of
+ the Volume Retention period.
+
+\smallskip
+ Recycling will not occur until it is absolutely necessary to
free up a volume (i.e. no other writable volume exists).
All File records associated with pruned Jobs are also
pruned. The time may be specified as seconds, minutes, hours, days,
weeks, months, quarters, or years. The {\bf Volume Retention} is
applied independently of the {\bf Job Retention} and the {\bf File
Retention} periods defined in the Client resource. This means that all
- the retentions periods are applied in turn and that the shorter period
+ the retention periods are applied in turn and that the shorter period
is the one that effectively takes precedence. Note, that when the {\bf
Volume Retention} period has been reached, and it is necessary to obtain
- a new volume, Bacula will prune both the Job and the File records. This
- pruning could also occur during a {\bf status dir} command because it
- uses similar algorithms for finding the next available Volume.
+ a new volume, Bacula will prune both the Job and the File records. And
+ the inverse is also true that if all the Job and File records that
+ refer to a Volume are pruned, then the Volume may be pruned and recycled
+ regardless of its retention period. Pruning may also occur during a
+ {\bf status dir} command because it uses similar algorithms for finding
+ the next available Volume.
It is important to know that when the Volume Retention period expires,
+ or all the Job and File records have been pruned that refer to a Volume,
Bacula does not automatically recycle a Volume. It attempts to keep the
Volume data intact as long as possible before over writing the Volume.
directive with care. The default is {\bf no}.
\label{PurgeOldest}
-
\item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}]
\index[dir]{Purge Oldest Volume}
\index[dir]{Directive!Purge Oldest Volume}
begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
specify variable expansion characters, you should always enclose the
format with double quote characters ({\bf "}). For more details on
- variable expansion, please see the \ilink{Variable
- Expansion}{VarsChapter} Chapter of this manual.
+ variable expansion, please see the \borgxrlink{Variable Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
If no variable expansion characters are found in the string, the Volume
name will be formed from the {\bf format} string appended with the
File-0002}, ...
With the exception of Job specific variables, you can test your {\bf
- LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
- of this manual.
+ LabelFormat} by using the \borgxrlink{var}{var}{console}{command} in the
+ \consoleman{}.
In almost all cases, you should enclose the format specification (part
after the equal sign) in double quotes. Please note that this directive
\item [DB Port = \lt{}port\gt{}]
\index[dir]{DB Port}
- \index[dir]{Directive!DB Port}
+ \index[dir]{Directive!DBPort}
This defines the port to be used in conjunction with {\bf DB Address} to
access the database if it is on another machine. This directive is used only
by MySQL and PostgreSQL and is ignored by SQLite if provided. This
# from root to your address. See the "mail" and "operator"
# directives in the Messages resource.
#
-Director { # define myself
+Director { # define myself
Name = rufus-dir
QueryFile = "/home/kern/bacula/bin/query.sql"
WorkingDirectory = "/home/kern/bacula/bin/working"
FileSet {
Name = "Full Set"
Include {
- Options { signature=SHA1}
+ Options {signature=SHA1}
#
# Put your list of files here, one per line or include an
# external list with:
projects / bacula / docs / blobdiff