-1.38.6-beta3 (04 March 2006)
+1.38.6-beta5 (14 March 2006)
-1.38.6-beta3 (04 March 2006)
+1.38.6-beta5 (14 March 2006)
the case of nested prompts). In a few places such as where it is asking for a
Volume name, the period will be taken to be the Volume name. In that case, you
will most likely be able to cancel at the next prompt.
-\label{list}
+There are three keywords used to refer to Jobs that must be clearly
+understood. They are the following:
+\begin{description}
+\item [jobid]
+ The JobId is the numeric jobid that is printed in the Job
+ Report output. It is the index of the database record for the
+ given job. While it is unique for all the existing Job records
+ in the catalog database, the same JobId can be reused once a
+ Job is removed from the catalog. Probably you will refer
+ specific Jobs that ran using their numeric JobId.
+\item [ujobid]
+ The ujobid is a unique job identification that is printed
+ in the Job Report output. At the current time, it consists
+ of the Job name (from the Name directive for the job) appended
+ with the date and time the job was run. This keyword is useful
+ if you want to completely identify the Job instance run.
+\item [job | jobname]
+ The Job or Jobname keyword refers to the name you specified
+ in the Job resource, and hence it refers to any number of
+ Jobs that ran. It is typically useful if you want to list
+ all jobs of a particular name.
+\end{description}
+
+\label{list}
\subsection*{Alphabetic List of Console Commands}
\index[general]{Commands!Alphabetic List of Console }
\index[general]{Alphabetic List of Console Commands }
off, you must explicitly {\bf mount} the tape after a label command to
use it.
-\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{}]}]
+\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
\index[console]{cancel jobid}
This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
job=xxx} as an argument where nnn is replaced by the JobId and xxx is
list jobid=\lt{}id\gt{} (list jobid id)
- list jobuname=\lt{}job-uname\gt{} (list job with unique name)
+ list ujobid\lt{}unique job name\gt{} (list job with unique name)
- list job=\lt{}job-name\gt{} (list all jobs with "job-name"
+ list job=\lt{}job-name\gt{} (list all jobs with "job-name")
list jobname=\lt{}job-name\gt{} (same as above)
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
only IPv4 resolutions will be permitted, and likewise with ip6.
+Please note that if you use the DirAddresess directive, you must
+not use either a DirPort or a DirAddress directive in the same
+resource.
+
\item [DIRport = \lt{}port-number\gt{}]
\index[dir]{DIRport}
\index[dir]{Directive!DIRport}
\item [FileSet = \lt{}FileSet-resource-name\gt{}]
\index[dir]{FileSet}
\index[dir]{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 single FileSet
- resource may be specified in any one Job. For additional details, see the
- \ilink{FileSet Resource section}{FileSetResource} of this
- chapter. This directive is required.
+ 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
+ single FileSet resource may be specified in any one Job. For additional
+ details, see the \ilink{FileSet Resource section}{FileSetResource} of
+ this chapter. This directive is required.
\item [Messages = \lt{}messages-resource-name\gt{}]
\index[dir]{Messages}
\index[dir]{Directive!Messages}
- The Messages directive defines what Messages resource should be used for
-this
- job, and thus how and where the various messages are to be delivered. For
- example, you can direct some messages to a log file, and others can be sent
- by email. For additional details, see the
- \ilink{Messages Resource}{_ChapterStart15} Chapter of this
- manual. This directive is required.
+ The Messages directive defines what Messages resource should be used for
+ this job, and thus how and where the various messages are to be
+ delivered. For example, you can direct some messages to a log file, and
+ others can be sent by email. For additional details, see the
+ \ilink{Messages Resource}{_ChapterStart15} Chapter of this manual. This
+ directive is required.
\item [Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Pool}
\index[dir]{Directive!Pool}
- The Pool directive defines the pool of Volumes where your data can be 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.
+ The Pool directive defines the pool of Volumes where your data can be
+ 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.
\item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Full Backup Pool}
\index[dir]{Replace}
\index[dir]{Directive!Replace}
This directive applies only to a Restore job and specifies what happens when
-Bacula wants to restore a file or directory that already exists. You have the
- following options for {\bf replace-option}:
+ Bacula wants to restore a file or directory that already exists. You have the
+ following options for {\bf replace-option}:
\begin{description}
\item [always]
\index[dir]{always}
- when the file to be restored already exists, it is deleted and then replaced
-by
- the copy that was backed up.
+ when the file to be restored already exists, it is deleted and then
+ replaced by the copy that was backed up.
\item [ifnewer]
\index[dir]{ifnewer}
\item [Ignore FileSet Changes = \lt{}yes|no\gt{}]
\index[dir]{Ignore FileSet Changes}
+ Normally, if you modify the FileSet Include or Exclude lists,
+ the next backup will be forced to a Full so that Bacula can
+ guarantee that any additions or deletions are properly backed
+ up.
If this directive is set to {\bf yes}, any changes you make to the FileSet
Include or Exclude lists will be ignored and not cause Bacula to immediately
perform a Full backup. The default is {\bf no}, in which case, if you change
the Include or Exclude, Bacula will force a Full backup to ensure that
everything is properly backed up. It is not recommended to set this directive
- to yes. This directive is available in Bacula version 1.35.4 or later.
+ to yes.
\item [Enable VSS = \lt{}yes|no\gt{}]
\index[dir]{Enable VSS}
Note, see below for the definition of \lt{}file-list\gt{}.
The Include resource may also contain one or more Options resources that
specify options such as compression to be applied to all or any subset of
-the files found when processing the file-list for backup.
+the files found when processing the file-list for backup. Please see
+below for more details concerning Options resources.
There can be any number of {\bf Include} resources within the FileSet, each
having its own list of directories or files to be backed up and the backup
Multiple Options resources may be specified one after another. As the
files are found in the specified directories, the Options will applied to
the filenames to determine if and how the file should be backed up. The
-Options resources are applied in the order they are specified in the
-FileSet until the first one that matches.
+wildcard and regular expression pattern matching parts of the
+Options resources are checked in the order they are specified in the
+FileSet until the first one that matches. Once one matches, the
+compression and other flags within the Options specification will
+apply to the pattern matched.
A key point is that in the absence of an Option or no other Option is
matched, every file is accepted for backing up. This means that if
resources that may be present. This means that any wild cards must appear
before an Options resource without wild cards.
-If for some reason, Bacula applies all the Options resources to a file
-under consideration for backup, but there are no matches (generally because
-of wild cards that don't match), Bacula as a default will then backup the
-file. This is quite logical if you consider the case of no Options, where
-you want everything to be backed up, and it is important to keep in
-mind when excluding as mentioned above.
-
-However, one additional point is that
-in the case that no match was found, Bacula will use the options found in
-the last Options resource. As a consequence, if you want a particular set
-of "default" options, you should put them in an Options resource after
-any other Options.
+If for some reason, Bacula checks all the Options resources to a file under
+consideration for backup, but there are no matches (generally because of wild
+cards that don't match), Bacula as a default will then backup the file. This
+is quite logical if you consider the case of no Options clause is specified,
+where you want everything to be backed up, and it is important to keep in mind
+when excluding as mentioned above.
+
+However, one additional point is that in the case that no match was found,
+Bacula will use the options found in the last Options resource. As a
+consequence, if you want a particular set of "default" options, you should put
+them in an Options resource after any other Options.
It is a good idea to put all your wild-card and regex expressions inside
double quotes to prevent conf file scanning problems.
a number of methods (subroutines) that can be called. They
are:
\begin{description}
-\item [set\_events] The set\_events takes a single
+\item [set\_events] The set\_events method takes a single
argument, which is the instantation of the Job Events class
that contains the methods that you want called. The method
names that will be called must correspond to the Bacula
started, or -1 if there was an error.
\item [write] The write method is used to be able to send
print output to the Job Report. This will be described later.
-\item [DoesVolumeExist] The DoesVolumeExist takes a single
+\item[cancel] The cancel method takes a single integer argument,
+ which is a JobId. If JobId is found, it will be canceled.
+\item [DoesVolumeExist] The DoesVolumeExist method takes a single
string argument, which is the Volume name, and returns
1 if the volume exists in the Catalog and 0 if the volume
does not exist.
\begin{description}
\item [Priority] Read or set the Job priority.
-Note, that setting a Job Priority is effective only before
-the Job actually starts. (not functional yet)
+ Note, that setting a Job Priority is effective only before
+ the Job actually starts.
+\item [Level] This attribute contains a string representing the Job
+ level, e.g. Full, Differential, Incremental, ... if read.
+ The level can also be set.
\end{description}
The following read-only attributes are available within the Director
\begin{description}
-\item [Level] This attribute contains a string representing the Job
- level, e.g. Full, Differential, Incremental, ...
\item [Type] This attribute contains a string representing the Job
type, e.g. Backup, Restore, Verify, ...
\item [JobId] This attribute contains an integer representing the
The second change was to add a new Client resource that defines {\bf matou-fd}
and has the correct address {\bf matou}, but in real life, you may need a
-fully qualified machine address or an IP address. I also kept the password the
+fully qualified domain name or an IP address. I also kept the password the
same (shown as xxxxx for the example).
At this point, if you stop Bacula and restart it, and start the Client on the
If you are having difficulties getting one or more of your File daemons to
connect to the Storage daemon, it is most likely because you have not used a
-fully qualified Internet address on the {\bf Address} directive in the
+fully qualified domain name on the {\bf Address} directive in the
Director's Storage resource. That is the resolver on the File daemon's machine
(not on the Director's) must be able to resolve the name you supply into an IP
address. An example of an address that is guaranteed not to work: {\bf
-1.38.6-beta3 (04 March 2006)
+1.38.6-beta5 (14 March 2006)
projects / bacula / docs / commitdiff