\begin{description}
\item [destination = message-type1, message-type2, message-type3, ... ]
- \index[dir]{destination}
- \end{description}
+\index[dir]{destination}
+\end{description}
or for those destinations that need and address specification (e.g. email):
\item [destination = address = message-type1, message-type2,
message-type3, ... ]
- \index[dir]{destination}
-
-Where {\bf destination} is one of a predefined set of keywords that define
-where the message is to be sent ({\bf stdout}, {\bf file}, ...), {\bf
-message-type} is one of a predefined set of keywords that define the type of
-message generated by {\bf Bacula} ({\bf ERROR}, {\bf WARNING}, {\bf FATAL},
-...), and {\bf address} varies according to the {\bf destination} keyword, but
-is typically an email address or a filename.
+\index[dir]{destination}
+
+ Where {\bf destination} is one of a predefined set of keywords that define
+ where the message is to be sent ({\bf stdout}, {\bf file}, ...), {\bf
+ message-type} is one of a predefined set of keywords that define the type of
+ message generated by {\bf Bacula} ({\bf ERROR}, {\bf WARNING}, {\bf FATAL},
+ ...), and {\bf address} varies according to the {\bf destination} keyword, but
+ is typically an email address or a filename.
\end{description}
The following are the list of the possible record definitions that can be used
\begin{description}
\item [Messages]
- \index[dir]{Messages}
+\index[dir]{Messages}
Start of the Messages records.
\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
+\index[dir]{Name}
The name of the Messages resource. The name you specify here will be used to
-tie this Messages resource to a Job and/or to the daemon.
-\label{mailcommand}
+ tie this Messages resource to a Job and/or to the daemon.
+\label{mailcommand}
\item [MailCommand = \lt{}command\gt{}]
- \index[dir]{MailCommand}
+\index[dir]{MailCommand}
In the absence of this resource, Bacula will send all mail using the
-following command:
+ following command:
{\bf mail -s "Bacula Message" \lt{}recipients\gt{}}
selective as to what forms are permitted particularly in the from part.
\item [OperatorCommand = \lt{}command\gt{}]
- \index[fd]{OperatorCommand}
+\index[fd]{OperatorCommand}
This resource specification is similar to the {\bf MailCommand} except that
-it is used for Operator messages. The substitutions performed for the {\bf
-MailCommand} are also done for this command. Normally, you will set this
-command to the same value as specified for the {\bf MailCommand}.
+ it is used for Operator messages. The substitutions performed for the {\bf
+ MailCommand} are also done for this command. Normally, you will set this
+ command to the same value as specified for the {\bf MailCommand}.
\item [Debug = \lt{}debug-level\gt{}]
\index[fd]{Debug}
\lt{}message-type1\gt{}, \lt{}message-type2\gt{}, ...}
\index[console]{\lt{}destination\gt{}}
-Where {\bf address} depends on the {\bf destination}, which may be one of the
-following:
+Where {\bf address} depends on the {\bf destination}.
+
+The {\bf destination} may be one of the following:
\begin{description}
\item [director]
\index[dir]{director}
+ \index[general]{director}
Send the message to the Director whose name is given in the {\bf address}
-field. Note, in the current implementation, the Director Name is ignored, and
-the message is sent to the Director that started the Job.
+ field. Note, in the current implementation, the Director Name is ignored, and
+ the message is sent to the Director that started the Job.
\item [file]
- \index[dir]{file}
+\index[dir]{file}
+\index[general]{file}
Send the message to the filename given in the {\bf address} field. If the
-file already exists, it will be overwritten.
+ file already exists, it will be overwritten.
\item [append]
- \index[dir]{append}
+\index[dir]{append}
+\index[general]{append}
Append the message to the filename given in the {\bf address} field. If the
file already exists, it will be appended to. If the file does not exist, it
will be created.
\item [syslog]
- \index[fd]{syslog}
+\index[general]{syslog}
Send the message to the system log (syslog) using the facility specified in
the {\bf address} field. Note, for the moment, the {\bf address} field is
ignored and the message is always sent to the LOG\_DAEMON facility with
\end{verbatim}
\item [mail]
- \index[fd]{mail}
+ \index[general]{mail}
Send the message to the email addresses that are given as a comma
separated list in the {\bf address} field. Mail messages are grouped
together during a job and then sent as a single email message when the
mailcommand}).
\item [mail on error]
- \index[fd]{mail on error}
+ \index[general]{mail on error}
Send the message to the email addresses that are given as a comma
separated list in the {\bf address} field if the Job terminates with an
error condition. MailOnError messages are grouped together during a job
Job terminates normally, the output information is saved.
\item [mail on success]
- \index[fd]{mail on success}
+ \index[general]{mail on success}
Send the message to the email addresses that are given as a comma
separated list in the {\bf address} field if the Job terminates
normally (no error condition). MailOnSuccess messages are grouped
totally discarded (for this destination). If the Job terminates in
normally, it is emailed.
-
\item [operator]
- \index[fd]{operator}
+ \index[general]{operator}
Send the message to the email addresses that are specified as a comma
separated list in the {\bf address} field. This is similar to {\bf
mail} above, except that each message is sent as received. Thus there
is one email per message. This is most useful for {\bf mount} messages
- (see below). \end{description}
+ (see below).
+
+\item [console]
+ \index[general]{console}
+ Send the message to the Bacula console.
+
+\item [stdout]
+ \index[general]{stdout}
+ Send the message to the standard output (normally not used).
+
+\item [stderr]
+ \index[general]{stderr}
+ Send the message to the standard error output (normally not used).
+
+\item [catalog]
+ \index[general]{catalog}
+ Send the message to the Catalog database. The message will be
+ written to the table named {\bf Log} and a timestamp field will
+ also be added. This permits Job Reports and other messages to
+ be recorded in the Catalog so that they can be accessed by
+ reporting software. Bacula will prune the Log records associated
+ with a Job when the Job records are pruned. Otherwise, Bacula
+ never uses these records internally, so this destination is only
+ used for special purpose programs (e.g. {\bf bweb}).
+
+\end{description}
For any destination, the {\bf message-type} field is a comma separated
list of the following types or classes of messages:
\begin{description}
\item [info]
- \index[fd]{info}
+ \index[general]{info}
General information messages.
\item [warning]
- \index[fd]{warning}
+ \index[general]{warning}
Warning messages. Generally this is some unusual condition but not expected
-to be serious.
+ to be serious.
\item [error]
- \index[fd]{error}
+ \index[general]{error}
Non-fatal error messages. The job continues running. Any error message should
-be investigated as it means that something went wrong.
+ be investigated as it means that something went wrong.
\item [fatal]
- \index[fd]{fatal}
+ \index[general]{fatal}
Fatal error messages. Fatal errors cause the job to terminate.
\item [terminate]
- \index[fd]{terminate}
+ \index[general]{terminate}
Message generated when the daemon shuts down.
\item [saved]
\index[fd]{saved}
+ \index[general]{saved}
Files saved normally.
\item [notsaved]
\index[fd]{notsaved}
+ \index[general]{notsaved}
Files not saved because of some error. Usually because the file cannot be
-accessed (i.e. it does not exist or is not mounted).
+ accessed (i.e. it does not exist or is not mounted).
\item [skipped]
\index[fd]{skipped}
+ \index[general]{skipped}
Files that were skipped because of a user supplied option such as an
incremental backup or a file that matches an exclusion pattern. This is
not considered an error condition such as the files listed for the {\bf
\item [mount]
\index[dir]{mount}
+ \index[general]{mount}
Volume mount or intervention requests from the Storage daemon. These
requests require a specific operator intervention for the job to
continue.
\item [restored]
- \index[dir]{restored}
+ \index[fd]{restored}
+ \index[general]{restored}
The {\bf ls} style listing generated for each file restored is sent to
this message class.
\item [all]
- \index[fd]{all}
+ \index[general]{all}
All message types.
-\item [*security]
- \index[fd]{*security}
+\item [security]
+ \index[general]{security}
Security info/warning messages principally from unauthorized
connection attempts.
+
+\item [alert]
+ \index[general]{alert}
+ Alert messages. These are messages generated by tape alerts.
+
+\item [volmgmt]
+ \index[general]{volmgmt}
+ Volume management messages. Currently there are no volume mangement
+ messages generated.
\end{description}
\end{description}
\normalsize
With the exception of the email address (changed to avoid junk mail from
-robot's), Kern's Director's Messages resource is as follows. Note, the {\bf
+robot's), an example Director's Messages resource is as follows. Note, the {\bf
mailcommand} and {\bf operatorcommand} are on a single line -- they had to be
split for this manual:
projects / bacula / docs / commitdiff