\label{DirMaxConJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[dir]{Maximum Concurrent Jobs }
+\index[dir]{Maximum Concurrent Jobs }
+\index[general]{Simultaneous Jobs}
+\index[general]{Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of total Director Jobs that
should run concurrently. The default is set to 1, but you may set it to a
larger number.
It is important to know that when the Volume Retention period expires,
Bacula does not automatically recycle a Volume. It attempts to keep the
- Volume data intact as long as possible before pruning it.
+ Volume data intact as long as possible before over writing the Volume.
- The default is 365 days. Note, this directive sets the default value
- for each Volume entry in the Catalog when the Volume is created. The
- value in the catalog may be later individually changed for each Volume
- using the Console program.
+ The default Volume retention period is 365 days. Note, this directive
+ sets the default value for each Volume entry in the Catalog when the
+ Volume is created. The value in the catalog may be later individually
+ changed for each Volume using the Console program.
By defining multiple Pools with different Volume Retention periods, you
may effectively have a set of tapes that is recycled weekly, another
\label{PoolRecycle}
\item [Recycle = \lt{}yes|no\gt{}]
\index[dir]{Recycle }
- This directive specifies the default for recycling Purged Volumes. If it is
-set to {\bf yes} and Bacula needs a volume but finds none that are
-appendable, it will search for Purged Volumes (i.e. volumes with all the Jobs
-and Files expired and thus deleted from the Catalog). If the Volume is
-recycled, all previous data written to that Volume will be overwritten.
+ This directive specifies whether or not Purged Volumes will be recycled.
+ If it is set to {\bf yes} (default) and Bacula needs a volume but finds
+ none that are appendable, it will search for and recycle (reuse) Purged
+ Volumes (i.e. volumes with all the Jobs and Files expired and thus
+ deleted from the Catalog). If the Volume is recycled, all previous data
+ written to that Volume will be overwritten. If Recycle is set to {\bf
+ no} you must manually set the recycle flag (update command) for
+ a Volume to be reused.
+
+ Please note that the value defined by this directive in the
+ bacula-dir.conf file is the default value used when a Volume is created.
+ Once the volume is 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 {\bf update} command in the
+ Console.
-Please note that the value defined by this directive in the bacula-dir.conf
-file is the default value used when a Volume is created. Once the volume is
-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 {\bf update} command in the Console.
\label{RecycleOldest}
-
\item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
\index[dir]{Recycle Oldest Volume }
- This directive instructs the Director to search for the oldest used Volume
-in the Pool when another Volume is requested by the Storage daemon and none
-are available. The catalog is then {\bf pruned} respecting the retention
-periods of all Files and Jobs written to this Volume. If all Jobs are
-pruned (i.e. the volume is Purged), then the Volume is recycled and will
-be used as the next Volume to be written. This directive respects any Job,
-File, or Volume retention periods that you may have specified, and as such
-it is {\bf much} better to use this directive than the Purge Oldest Volume.
-
-This directive can be useful if you have a fixed number of Volumes in the
-Pool and you want to cycle through them and you have specified the correct
-retention periods.
-However, if you use this directive and have only one
-Volume in the Pool, you will immediately recycle your Volume if you fill
-it and Bacula needs another one. Thus your backup will be totally invalid.
-Please use this directive with care.
+ This directive instructs the Director to search for the oldest used
+ Volume in the Pool when another Volume is requested by the Storage
+ daemon and none are available. The catalog is then {\bf pruned}
+ respecting the retention periods of all Files and Jobs written to this
+ Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
+ Volume is recycled and will be used as the next Volume to be written.
+ This directive respects any Job, File, or Volume retention periods that
+ you may have specified, and as such it is {\bf much} better to use this
+ directive than the Purge Oldest Volume.
+
+ This directive can be useful if you have a fixed number of Volumes in the
+ Pool and you want to cycle through them and you have specified the correct
+ retention periods.
+
+ However, if you use this directive and have only one
+ Volume in the Pool, you will immediately recycle your Volume if you fill
+ it and Bacula needs another one. Thus your backup will be totally invalid.
+ Please use this directive with care. The default is {\no}.
\label{RecycleCurrent}
\item [Recycle Current Volume = \lt{}yes|no\gt{}]
\index[dir]{Recycle Current Volume }
- If Bacula needs a new Volume, this directive instructs Bacula to Prune the
-volume respecting the Job and File retention periods. If all Jobs are pruned
-(i.e. the volume is Purged), then the Volume is recycled and will be used as
-the next Volume to be written. This directive respects any Job, File, or
-Volume retention periods that you may have specified, and thus it is {\bf
-much} better to use it rather than the Purge Oldest Volume directive.
-
-This directive can be useful if you have: a fixed number of Volumes in the
-Pool, you want to cycle through them, and you have specified retention
-periods that prune Volumes before you have cycled through the Volume in the
-Pool.
-However, if you use this directive and have only one
-Volume in the Pool, you will immediately recycle your Volume if you fill
-it and Bacula needs another one. Thus your backup will be totally invalid.
-Please use this directive with care.
+ If Bacula needs a new Volume, this directive instructs Bacula to Prune
+ the volume respecting the Job and File retention periods. If all Jobs
+ are pruned (i.e. the volume is Purged), then the Volume is recycled and
+ will be used as the next Volume to be written. This directive respects
+ any Job, File, or Volume retention periods that you may have specified,
+ and thus it is {\bf much} better to use it rather than the Purge Oldest
+ Volume directive.
+
+ This directive can be useful if you have: a fixed number of Volumes in
+ the Pool, you want to cycle through them, and you have specified
+ retention periods that prune Volumes before you have cycled through the
+ Volume in the Pool.
+
+ However, if you use this directive and have only one Volume in the Pool,
+ you will immediately recycle your Volume if you fill it and Bacula needs
+ another one. Thus your backup will be totally invalid. Please use this
+ directive with care. The default is {\no}.
\label{PurgeOldest}
\item [Purge Oldest Volume = \lt{}yes|no\gt{}]
\index[dir]{Purge Oldest Volume }
- This directive instructs the Director to search for the oldest used Volume
-in the Pool when another Volume is requested by the Storage daemon and none
-are available. The catalog is then {\bf purged} irrespective of retention
-periods of all Files and Jobs written to this Volume. The Volume is then
-recycled and will be used as the next Volume to be written. This directive
-overrides any Job, File, or Volume retention periods that you may have
-specified.
-
-This directive can be useful if you have a fixed number of Volumes in the
-Pool and you want to cycle through them and reusing the oldest one when all
-Volumes are full, but you don't want to worry about setting proper retention
-periods. However, by using this option you risk losing valuable data.
-
-{\bf Please be aware that {\bf Purge Oldest Volume} disregards all retention
-periods.} If you have only a single Volume defined and you turn this variable
-on, that Volume will always be immediately overwritten when it fills! So at a
-minimum, ensure that you have a decent number of Volumes in your Pool before
-running any jobs. If you want retention periods to apply do not use this
-directive. To specify a retention period, use the {\bf Volume Retention}
-directive (see above).
-
-We {\bf highly} recommend against using this directive, because it is sure that
-some day, Bacula will recycle a Volume that contains current data.
+ This directive instructs the Director to search for the oldest used
+ Volume in the Pool when another Volume is requested by the Storage
+ daemon and none are available. The catalog is then {\bf purged}
+ irrespective of retention periods of all Files and Jobs written to this
+ Volume. The Volume is then recycled and will be used as the next Volume
+ to be written. This directive overrides any Job, File, or Volume
+ retention periods that you may have specified.
+
+ This directive can be useful if you have a fixed number of Volumes in
+ the Pool and you want to cycle through them and reusing the oldest one
+ when all Volumes are full, but you don't want to worry about setting
+ proper retention periods. However, by using this option you risk losing
+ valuable data.
+
+ Please be aware that {\bf Purge Oldest Volume} disregards all retention
+ periods. If you have only a single Volume defined and you turn this
+ variable on, that Volume will always be immediately overwritten when it
+ fills! So at a minimum, ensure that you have a decent number of Volumes
+ in your Pool before running any jobs. If you want retention periods to
+ apply do not use this directive. To specify a retention period, use the
+ {\bf Volume Retention} directive (see above).
+
+ We {\bf highly} recommend against using this directive, because it is
+ sure that some day, Bacula will recycle a Volume that contains current
+ data. The default is {\no}.
\item [Cleaning Prefix = \lt{}string\gt{}]
\index[dir]{Cleaning Prefix }
- This directive defines a prefix string, which if it matches the beginning
-of
-a Volume name during labeling of a Volume, the Volume will be defined with
-the VolStatus set to {\bf Cleaning} and thus Bacula will never attempt to use
-this tape. This is primarily for use with autochangers that accept barcodes
-where the convention is that barcodes beginning with {\bf CLN} are treated as
-cleaning tapes.
-\label{Label}
+ This directive defines a prefix string, which if it matches the
+ beginning of a Volume name during labeling of a Volume, the Volume will
+ be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
+ never attempt to use this tape. This is primarily for use with
+ autochangers that accept barcodes where the convention is that barcodes
+ beginning with {\bf CLN} are treated as cleaning tapes.
+\label{Label}
\item [Label Format = \lt{}format\gt{}]
\index[dir]{Label Format }
This directive specifies the format of the labels contained in this
pool. The format directive is used as a sort of template to create new
Volume names during automatic Volume labeling.
-The {\bf format} should be specified in double quotes, and consists of
-letters, numbers and the special characters hyphen ({\bf -}), underscore
-({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
-characters for a Volume name. The {\bf format} should be enclosed in double
-quotes (").
-
-In addition, the format may contain a number of variable expansion characters
-which will be expanded by a complex algorithm allowing you to create Volume
-names of many different formats. In all cases, the expansion process must
-resolve to the set of characters noted above that are legal Volume names.
-Generally, these variable expansion characters 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}{_ChapterStart50} Chapter of this manual.
-
-If no variable expansion characters are found in the string, the Volume name
-will be formed from the {\bf format} string appended with the number of
-volumes in the pool plus one, which will be edited as four digits with
-leading zeros. For example, with a {\bf Label Format = "File-"}, the first
-volumes will be named {\bf File-0001}, {\bf 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.
-
-In almost all cases, you should enclose the format specification (part after
-the equal sign) in double quotes. Please note that this directive is
-deprecated and is replaced in version 1.37 and greater with a Python script
-for creating volume names.
+ The {\bf format} should be specified in double quotes, and consists of
+ letters, numbers and the special characters hyphen ({\bf -}), underscore
+ ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
+ characters for a Volume name. The {\bf format} should be enclosed in
+ double quotes (").
+
+ In addition, the format may contain a number of variable expansion
+ characters which will be expanded by a complex algorithm allowing you to
+ create Volume names of many different formats. In all cases, the
+ expansion process must resolve to the set of characters noted above that
+ are legal Volume names. Generally, these variable expansion characters
+ 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}{_ChapterStart50} Chapter of this manual.
+
+ If no variable expansion characters are found in the string, the Volume
+ name will be formed from the {\bf format} string appended with the
+ number of volumes in the pool plus one, which will be edited as four
+ digits with leading zeros. For example, with a {\bf Label Format =
+ "File-"}, the first volumes will be named {\bf File-0001}, {\bf
+ 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.
+
+ In almost all cases, you should enclose the format specification (part
+ after the equal sign) in double quotes. Please note that this directive
+ is deprecated and is replaced in version 1.37 and greater with a Python
+ script for creating volume names.
\end{description}
In order for a Pool to be used during a Backup Job, the Pool must have at
-least one Volume associated with it. Volumes are created for a Pool using the
-{\bf label} or the {\bf add} commands in the {\bf Bacula Console}, program. In
-addition to adding Volumes to the Pool (i.e. putting the Volume names in the
-Catalog database), the physical Volume must be labeled with a valid Bacula
-software volume label before {\bf Bacula} will accept the Volume. This will be
-automatically done if you use the {\bf label} command. Bacula can
-automatically label Volumes if instructed to do so, but this feature is not
-yet fully implemented.
+least one Volume associated with it. Volumes are created for a Pool using
+the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
+program. In addition to adding Volumes to the Pool (i.e. putting the
+Volume names in the Catalog database), the physical Volume must be labeled
+with a valid Bacula software volume label before {\bf Bacula} will accept
+the Volume. This will be automatically done if you use the {\bf label}
+command. Bacula can automatically label Volumes if instructed to do so,
+but this feature is not yet fully implemented.
The following is an example of a valid Pool resource definition:
\addcontentsline{toc}{subsection}{Catalog Resource}
The Catalog Resource defines what catalog to use for the current job.
-Currently, Bacula can only handle a single database server (SQLite, MySQL,
-PostgreSQL) that is defined when configuring {\bf Bacula}. However, there may be
-as many Catalogs (databases) defined as you wish. For example, you may want
-each Client to have its own Catalog database, or you may want backup jobs to
-use one database and verify or restore jobs to use another database.
+Currently, Bacula can only handle a single database server (SQLite, MySQL,
+PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
+may be as many Catalogs (databases) defined as you wish. For example, you
+may want each Client to have its own Catalog database, or you may want
+backup jobs to use one database and verify or restore jobs to use another
+database.
\begin{description}
\begin{itemize}
\item The first console type is an {\bf anonymous} or {\bf default} console,
- which has full privileges. There is no console resource necessary for this
- type since the password is specified in the Director's resource and
-consequently such consoles do not have a name as defined on a {\bf Name =}
-directive. This is the kind of console that was initially implemented in
-versions prior to 1.33 and remains valid. Typically you would use it only for
- administrators.
+ which has full privileges. There is no console resource necessary for
+ this type since the password is specified in the Director's resource and
+ consequently such consoles do not have a name as defined on a {\bf Name
+ =} directive. This is the kind of console that was initially
+ implemented in versions prior to 1.33 and remains valid. Typically you
+ would use it only for administrators.
+
\item The second type of console, and new to version 1.33 and higher is a
- "named" console defined within a Console resource in both the Director's
- configuration file and in the Console's configuration file. Both the names
-and the passwords in these two entries must match much as is the case for
-Client programs.
-
-This second type of console begins with absolutely no privileges except those
-explicitly specified in the Director's Console resource. Thus you can have
-multiple Consoles with different names and passwords, sort of like multiple
-users, each with different privileges. As a default, these consoles can do
-absolutely nothing -- no commands whatsoever. You give them privileges or
-rather access to commands and resources by specifying access control lists
-in the Director's Console resource. The ACLs are specified by a directive
-followed by a list of access names. Examples of this are shown below.
+ "named" console defined within a Console resource in both the Director's
+ configuration file and in the Console's configuration file. Both the
+ names and the passwords in these two entries must match much as is the
+ case for Client programs.
+
+ This second type of console begins with absolutely no privileges except
+ those explicitly specified in the Director's Console resource. Thus you
+ can have multiple Consoles with different names and passwords, sort of
+ like multiple users, each with different privileges. As a default,
+ these consoles can do absolutely nothing -- no commands whatsoever. You
+ give them privileges or rather access to commands and resources by
+ specifying access control lists in the Director's Console resource. The
+ ACLs are specified by a directive followed by a list of access names.
+ Examples of this are shown below.
+
\item The third type of console is similar to the above mentioned one in that
- it requires a Console resource definition in both the Director and the
- Console. In addition, if the console name, provided on the {\bf Name =}
-directive, is the same as a Client name, that console is permitted to use the
-{\bf SetIP} command to change the Address directive in the Director's client
-resource to the IP address of the Console. This permits portables or other
-machines using DHCP (non-fixed IP addresses) to "notify" the Director of
-their current IP address.
+ it requires a Console resource definition in both the Director and the
+ Console. In addition, if the console name, provided on the {\bf Name =}
+ directive, is the same as a Client name, that console is permitted to
+ use the {\bf SetIP} command to change the Address directive in the
+ Director's client resource to the IP address of the Console. This
+ permits portables or other machines using DHCP (non-fixed IP addresses)
+ to "notify" the Director of their current IP address.
\end{itemize}
The Console resource is optional and need not be specified. The following
\item [Password = \lt{}password\gt{}]
\index[dir]{Password }
- Specifies the password that must be supplied for a named Bacula Console to
-be
-authorized. The same password must appear in the {\bf Console} resource of
-the Console configuration file. For added security, the password is never
-actually passed across the network but rather a challenge response hash code
-created with the password. This directive is required. If you have either
-{\bf /dev/random} {\bf bc} on your machine, Bacula will generate a random
-password during the configuration process, otherwise it will be left blank.
+ Specifies the password that must be supplied for a named Bacula Console
+ to be authorized. The same password must appear in the {\bf Console}
+ resource of the Console configuration file. For added security, the
+ password is never actually passed across the network but rather a
+ challenge response hash code created with the password. This directive
+ is required. If you have either {\bf /dev/random} {\bf bc} on your
+ machine, Bacula will generate a random password during the configuration
+ process, otherwise it will be left blank.
\item [JobACL = \lt{}name-list\gt{}]
\index[dir]{JobACL }
- This directive is used to specify a list of Job resource names that can be
-accessed by the console. Without this directive, the console cannot access
-any of the Director's Job resources. Multiple Job resource names may be
-specified by separating them with commas, and/or by specifying multiple
-JobACL directives. For example, the directive may be specified as:
+ This directive is used to specify a list of Job resource names that can
+ be accessed by the console. Without this directive, the console cannot
+ access any of the Director's Job resources. Multiple Job resource names
+ may be specified by separating them with commas, and/or by specifying
+ multiple JobACL directives. For example, the directive may be specified
+ as:
\footnotesize
\begin{verbatim}
projects / bacula / docs / blobdiff