~ubuntu-branches/ubuntu/utopic/bacula-doc/utopic

« back to all changes in this revision

Viewing changes to manuals/en/main/main/Messages_Resource.html

  • Committer: Bazaar Package Importer
  • Author(s): John Goerzen
  • Date: 2010-06-21 10:05:16 UTC
  • mfrom: (1.3.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20100621100516-2ijeolwzhz3ftiak
Tags: 5.0.2-1
* New upstream release.
* urgency medium since the accompanying bacula release is urgency medium
  and I want to get docs into testing the same time as the code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
26
26
 
27
27
<BODY >
28
28
<!--Navigation Panel-->
29
 
<A NAME="tex2html1521"
 
29
<A NAME="tex2html1538"
30
30
  HREF="Console_Configuration.html">
31
31
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
32
 
<A NAME="tex2html1515"
 
32
<A NAME="tex2html1532"
33
33
  HREF="Bacula_Main_Reference.html">
34
34
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
35
 
<A NAME="tex2html1509"
 
35
<A NAME="tex2html1526"
36
36
  HREF="Autochanger_Resource.html">
37
37
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
38
 
<A NAME="tex2html1517"
 
38
<A NAME="tex2html1534"
39
39
  HREF="Contents.html">
40
40
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
41
 
<A NAME="tex2html1519"
 
41
<A NAME="tex2html1536"
42
42
  HREF="Thanks.html">
43
43
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
44
44
<BR>
45
 
<B> Next:</B> <A NAME="tex2html1522"
 
45
<B> Next:</B> <A NAME="tex2html1539"
46
46
  HREF="Console_Configuration.html">Console Configuration</A>
47
 
<B> Up:</B> <A NAME="tex2html1516"
 
47
<B> Up:</B> <A NAME="tex2html1533"
48
48
  HREF="Bacula_Main_Reference.html">Bacula Main Reference</A>
49
 
<B> Previous:</B> <A NAME="tex2html1510"
 
49
<B> Previous:</B> <A NAME="tex2html1527"
50
50
  HREF="Autochanger_Resource.html">Autochanger Resource</A>
51
 
 &nbsp; <B>  <A NAME="tex2html1518"
 
51
 &nbsp; <B>  <A NAME="tex2html1535"
52
52
  HREF="Contents.html">Contents</A></B> 
53
 
 &nbsp; <B>  <A NAME="tex2html1520"
 
53
 &nbsp; <B>  <A NAME="tex2html1537"
54
54
  HREF="Thanks.html">Index</A></B> 
55
55
<BR>
56
56
<BR>
57
57
<!--End of Navigation Panel-->
58
58
 
59
 
<H1><A NAME="SECTION002100000000000000000"></A>
 
59
<H1><A NAME="SECTION002200000000000000000"></A>
60
60
<A NAME="MessagesChapter"></A>
61
61
<BR>
62
62
Messages Resource
63
63
</H1>
64
 
<A NAME="12935"></A>
65
 
<A NAME="12936"></A>
 
64
<A NAME="12946"></A>
 
65
<A NAME="12947"></A>
66
66
 
67
67
<P>
68
68
The Messages resource defines how messages are to be handled and destinations
101
101
<P>
102
102
<DL>
103
103
<DT><STRONG>destination = message-type1, message-type2, message-type3, ...  </STRONG></DT>
104
 
<DD><A NAME="12941"></A>
 
104
<DD><A NAME="12952"></A>
105
105
</DD>
106
106
</DL>
107
107
 
112
112
<DL>
113
113
<DT><STRONG>destination = address = message-type1, message-type2,
114
114
   message-type3, ...  </STRONG></DT>
115
 
<DD><A NAME="12944"></A>
 
115
<DD><A NAME="12955"></A>
116
116
 
117
117
<P>
118
118
Where <B>destination</B> is one of a predefined set of keywords that define
130
130
<P>
131
131
<DL>
132
132
<DT><STRONG>Messages</STRONG></DT>
133
 
<DD><A NAME="12957"></A>
 
133
<DD><A NAME="12968"></A>
134
134
   Start of the Messages records.  
135
135
 
136
136
<P>
137
137
</DD>
138
138
<DT><STRONG>Name = name</STRONG></DT>
139
 
<DD><A NAME="12960"></A>
 
139
<DD><A NAME="12971"></A>
140
140
   The name of the Messages resource.  The name you specify here will be used to
141
141
   tie this Messages  resource to a Job and/or to the daemon.  
142
142
 
143
143
<P>
144
144
<A NAME="mailcommand"></A></DD>
145
145
<DT><STRONG>MailCommand = command</STRONG></DT>
146
 
<DD><A NAME="12964"></A>
 
146
<DD><A NAME="12975"></A>
147
147
   In the absence of this resource,  Bacula will send all mail using the
148
148
   following command:  
149
149
 
210
210
<P>
211
211
</DD>
212
212
<DT><STRONG>OperatorCommand = command</STRONG></DT>
213
 
<DD><A NAME="12991"></A>
 
213
<DD><A NAME="13002"></A>
214
214
   This resource specification is  similar to the <B>MailCommand</B> except that
215
215
   it is used for Operator  messages. The substitutions performed for the <B>   MailCommand</B> are  also done for this command. Normally, you will set this
216
216
   command to the  same value as specified for the <B>MailCommand</B>. 
221
221
</DD>
222
222
<DT><STRONG>destination = message-type1,
223
223
   message-type2, ...</STRONG></DT>
224
 
<DD><A NAME="13098"></A>
 
224
<DD><A NAME="13109"></A>
225
225
 
226
226
<P>
227
227
Where <B>destination</B> may be one of the following:  
229
229
<P>
230
230
<DL>
231
231
<DT><STRONG>stdout</STRONG></DT>
232
 
<DD><A NAME="13008"></A>
 
232
<DD><A NAME="13019"></A>
233
233
   Send the message to standard output.  
234
234
 
235
235
<P>
236
236
</DD>
237
237
<DT><STRONG>stderr</STRONG></DT>
238
 
<DD><A NAME="13009"></A>
 
238
<DD><A NAME="13020"></A>
239
239
   Send the message to standard error.  
240
240
 
241
241
<P>
242
242
</DD>
243
243
<DT><STRONG>console</STRONG></DT>
244
 
<DD><A NAME="13010"></A>
 
244
<DD><A NAME="13021"></A>
245
245
   Send the message to the console (Bacula Console).  These messages are held
246
246
until the console program  connects to the Director.  
247
247
</DD>
252
252
<DT></DT>
253
253
<DD><B>destination = address =
254
254
   message-type1, message-type2, ...</B>
255
 
   <A NAME="13100"></A>
 
255
   <A NAME="13111"></A>
256
256
 
257
257
<P>
258
258
Where <B>address</B> depends on the <B>destination</B>. 
263
263
<P>
264
264
<DL>
265
265
<DT><STRONG>director</STRONG></DT>
266
 
<DD><A NAME="13026"></A>
267
 
   <A NAME="13027"></A>
 
266
<DD><A NAME="13037"></A>
 
267
   <A NAME="13038"></A>
268
268
   Send the message to the Director whose name  is given in the <B>address</B>
269
269
   field. Note, in the current  implementation, the Director Name is ignored, and
270
270
   the message  is sent to the Director that started the Job.  
272
272
<P>
273
273
</DD>
274
274
<DT><STRONG>file</STRONG></DT>
275
 
<DD><A NAME="13029"></A>
276
 
<A NAME="13030"></A>
 
275
<DD><A NAME="13040"></A>
 
276
<A NAME="13041"></A>
277
277
   Send the message to the filename given in  the <B>address</B> field. If the
278
278
   file already exists, it will be  overwritten.  
279
279
 
280
280
<P>
281
281
</DD>
282
282
<DT><STRONG>append</STRONG></DT>
283
 
<DD><A NAME="13032"></A>
284
 
<A NAME="13033"></A>
 
283
<DD><A NAME="13043"></A>
 
284
<A NAME="13044"></A>
285
285
   Append the message to the filename given  in the <B>address</B> field. If the
286
286
   file already exists, it will  be appended to. If the file does not exist, it
287
287
   will be created.  
289
289
<P>
290
290
</DD>
291
291
<DT><STRONG>syslog</STRONG></DT>
292
 
<DD><A NAME="13035"></A>
 
292
<DD><A NAME="13046"></A>
293
293
   Send the message to the system log (syslog)  using the facility specified in
294
294
   the <B>address</B> field.  Note, for the moment, the <B>address</B> field is
295
295
   ignored  and the message is always sent to the LOG_DAEMON facility with
310
310
<P>
311
311
</DD>
312
312
<DT><STRONG>mail</STRONG></DT>
313
 
<DD><A NAME="13045"></A>
 
313
<DD><A NAME="13056"></A>
314
314
   Send the message to the email addresses that are given as a comma
315
315
   separated list in the <B>address</B> field.  Mail messages are grouped
316
316
   together during a job and then sent as a single email message when the
323
323
<P>
324
324
</DD>
325
325
<DT><STRONG>mail on error</STRONG></DT>
326
 
<DD><A NAME="13049"></A>
 
326
<DD><A NAME="13060"></A>
327
327
   Send the message to the email addresses that are given as a comma
328
328
   separated list in the <B>address</B> field if the Job terminates with an
329
329
   error condition.  MailOnError messages are grouped together during a job
337
337
<P>
338
338
</DD>
339
339
<DT><STRONG>mail on success</STRONG></DT>
340
 
<DD><A NAME="13053"></A>
 
340
<DD><A NAME="13064"></A>
341
341
   Send the message to the email addresses that are given as a comma
342
342
   separated list in the <B>address</B> field if the Job terminates
343
343
   normally (no error condition).  MailOnSuccess messages are grouped
350
350
<P>
351
351
</DD>
352
352
<DT><STRONG>operator</STRONG></DT>
353
 
<DD><A NAME="13056"></A>
 
353
<DD><A NAME="13067"></A>
354
354
   Send the message to the email addresses that are specified as a comma
355
355
   separated list in the <B>address</B> field.  This is similar to <B>   mail</B> above, except that each message is sent as received.  Thus there
356
356
   is one email per message.  This is most useful for <B>mount</B> messages
359
359
<P>
360
360
</DD>
361
361
<DT><STRONG>console</STRONG></DT>
362
 
<DD><A NAME="13060"></A>
 
362
<DD><A NAME="13071"></A>
363
363
  Send the message to the Bacula console.
364
364
 
365
365
<P>
366
366
</DD>
367
367
<DT><STRONG>stdout</STRONG></DT>
368
 
<DD><A NAME="13061"></A>
 
368
<DD><A NAME="13072"></A>
369
369
  Send the message to the standard output (normally not used).
370
370
 
371
371
<P>
372
372
</DD>
373
373
<DT><STRONG>stderr</STRONG></DT>
374
 
<DD><A NAME="13062"></A>
 
374
<DD><A NAME="13073"></A>
375
375
  Send the message to the standard error output (normally not used).
376
376
 
377
377
<P>
378
378
</DD>
379
379
<DT><STRONG>catalog</STRONG></DT>
380
 
<DD><A NAME="13063"></A>
 
380
<DD><A NAME="13074"></A>
381
381
   Send the message to the Catalog database. The message will be
382
382
   written to the table named <B>Log</B> and a timestamp field will
383
383
   also be added. This permits Job Reports and other messages to
398
398
<P>
399
399
<DL>
400
400
<DT><STRONG>info</STRONG></DT>
401
 
<DD><A NAME="13069"></A>
 
401
<DD><A NAME="13080"></A>
402
402
   General information messages.  
403
403
 
404
404
<P>
405
405
</DD>
406
406
<DT><STRONG>warning</STRONG></DT>
407
 
<DD><A NAME="13070"></A>
 
407
<DD><A NAME="13081"></A>
408
408
   Warning messages. Generally this is some  unusual condition but not expected
409
409
   to be serious. 
410
410
 
411
411
<P>
412
412
</DD>
413
413
<DT><STRONG>error</STRONG></DT>
414
 
<DD><A NAME="13071"></A>
 
414
<DD><A NAME="13082"></A>
415
415
   Non-fatal error messages. The job continues running.  Any error message should
416
416
   be investigated as it means that something  went wrong.  
417
417
 
418
418
<P>
419
419
</DD>
420
420
<DT><STRONG>fatal</STRONG></DT>
421
 
<DD><A NAME="13072"></A>
 
421
<DD><A NAME="13083"></A>
422
422
   Fatal error messages. Fatal errors cause the  job to terminate.  
423
423
 
424
424
<P>
425
425
</DD>
426
426
<DT><STRONG>terminate</STRONG></DT>
427
 
<DD><A NAME="13073"></A>
 
427
<DD><A NAME="13084"></A>
428
428
   Message generated when the daemon shuts down.  
429
429
 
430
430
<P>
431
431
</DD>
432
432
<DT><STRONG>notsaved</STRONG></DT>
433
 
<DD><A NAME="13074"></A>
434
 
   <A NAME="13075"></A>
 
433
<DD><A NAME="13085"></A>
 
434
   <A NAME="13086"></A>
435
435
   Files not saved because of some error.  Usually because the file cannot be
436
436
   accessed (i.e. it does not  exist or is not mounted).  
437
437
 
438
438
<P>
439
439
</DD>
440
440
<DT><STRONG>skipped</STRONG></DT>
441
 
<DD><A NAME="13076"></A>
442
 
   <A NAME="13077"></A>
 
441
<DD><A NAME="13087"></A>
 
442
   <A NAME="13088"></A>
443
443
   Files that were skipped because of a user supplied option such as an
444
444
   incremental backup or a file that matches an exclusion pattern.  This is
445
445
   not considered an error condition such as the files listed for the <B>   notsaved</B> type because the configuration file explicitly requests these
450
450
<P>
451
451
</DD>
452
452
<DT><STRONG>mount</STRONG></DT>
453
 
<DD><A NAME="13079"></A>
454
 
   <A NAME="13080"></A>
 
453
<DD><A NAME="13090"></A>
 
454
   <A NAME="13091"></A>
455
455
   Volume mount or intervention requests from the Storage daemon.  These
456
456
   requests require a specific operator intervention for the job to
457
457
   continue.
459
459
<P>
460
460
</DD>
461
461
<DT><STRONG>restored</STRONG></DT>
462
 
<DD><A NAME="13081"></A>
463
 
   <A NAME="13082"></A>
 
462
<DD><A NAME="13092"></A>
 
463
   <A NAME="13093"></A>
464
464
   The <B>ls</B> style listing generated for each file restored is sent to
465
465
   this message class.
466
466
 
467
467
<P>
468
468
</DD>
469
469
<DT><STRONG>all</STRONG></DT>
470
 
<DD><A NAME="13084"></A>
 
470
<DD><A NAME="13095"></A>
471
471
   All message types.  
472
472
 
473
473
<P>
474
474
</DD>
475
475
<DT><STRONG>security</STRONG></DT>
476
 
<DD><A NAME="13085"></A>
 
476
<DD><A NAME="13096"></A>
477
477
   Security info/warning messages principally from unauthorized      
478
478
   connection attempts.
479
479
 
480
480
<P>
481
481
</DD>
482
482
<DT><STRONG>alert</STRONG></DT>
483
 
<DD><A NAME="13086"></A>
 
483
<DD><A NAME="13097"></A>
484
484
   Alert messages. These are messages generated by tape alerts.
485
485
 
486
486
<P>
487
487
</DD>
488
488
<DT><STRONG>volmgmt</STRONG></DT>
489
 
<DD><A NAME="13087"></A>
 
489
<DD><A NAME="13098"></A>
490
490
   Volume management messages. Currently there are no volume mangement
491
491
   messages generated.
492
492
</DD>
537
537
<P>
538
538
<HR>
539
539
<!--Navigation Panel-->
540
 
<A NAME="tex2html1521"
 
540
<A NAME="tex2html1538"
541
541
  HREF="Console_Configuration.html">
542
542
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
543
 
<A NAME="tex2html1515"
 
543
<A NAME="tex2html1532"
544
544
  HREF="Bacula_Main_Reference.html">
545
545
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
546
 
<A NAME="tex2html1509"
 
546
<A NAME="tex2html1526"
547
547
  HREF="Autochanger_Resource.html">
548
548
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
549
 
<A NAME="tex2html1517"
 
549
<A NAME="tex2html1534"
550
550
  HREF="Contents.html">
551
551
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
552
 
<A NAME="tex2html1519"
 
552
<A NAME="tex2html1536"
553
553
  HREF="Thanks.html">
554
554
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
555
555
<BR>
556
 
<B> Next:</B> <A NAME="tex2html1522"
 
556
<B> Next:</B> <A NAME="tex2html1539"
557
557
  HREF="Console_Configuration.html">Console Configuration</A>
558
 
<B> Up:</B> <A NAME="tex2html1516"
 
558
<B> Up:</B> <A NAME="tex2html1533"
559
559
  HREF="Bacula_Main_Reference.html">Bacula Main Reference</A>
560
 
<B> Previous:</B> <A NAME="tex2html1510"
 
560
<B> Previous:</B> <A NAME="tex2html1527"
561
561
  HREF="Autochanger_Resource.html">Autochanger Resource</A>
562
 
 &nbsp; <B>  <A NAME="tex2html1518"
 
562
 &nbsp; <B>  <A NAME="tex2html1535"
563
563
  HREF="Contents.html">Contents</A></B> 
564
 
 &nbsp; <B>  <A NAME="tex2html1520"
 
564
 &nbsp; <B>  <A NAME="tex2html1537"
565
565
  HREF="Thanks.html">Index</A></B> 
566
566
<!--End of Navigation Panel-->
567
567
<ADDRESS>
568
568
 
569
 
2010-02-24
 
569
2010-04-27
570
570
</ADDRESS>
571
571
</BODY>
572
572
</HTML>