File: amcleanup.8.xml

package info (click to toggle)
amanda 1%3A3.5.4-2.1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 23,420 kB
  • sloc: ansic: 197,218; perl: 109,331; xml: 16,126; sh: 4,180; makefile: 2,811; awk: 502; lex: 407; yacc: 347; tcl: 118; sql: 19; sed: 16; php: 2
file content (133 lines) | stat: -rw-r--r-- 3,901 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
  <!-- entities files to use -->
  <!ENTITY % global_entities SYSTEM 'global.entities'>
  %global_entities;
]>

<!-- lifted from troff+man by doclifter -->
<refentry id='amcleanup.8'>

<refmeta>
<refentrytitle>amcleanup</refentrytitle>
<manvolnum>8</manvolnum>
&rmi.source;
&rmi.version;
&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amcleanup</refname>
<refpurpose>run the Amanda cleanup process after a failure</refpurpose>
</refnamediv>
<refentryinfo>
&author.jds;
&author.sgw.xml;
</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
  <command>amcleanup</command>
    <arg choice='opt'><option>-k</option></arg>
    <arg choice='opt'><option>-p</option></arg>
    <arg choice='opt'><option>-r</option></arg>
    <arg choice='opt'><option>-v</option></arg>
    <arg choice='opt'><option>--note <replaceable>string</replaceable></option></arg>
    <arg choice='plain'><replaceable>config</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1><title>DESCRIPTION</title>
<para><emphasis remap='B'>Amcleanup</emphasis>
generates the
<emphasis remap='I'>Amanda Mail Report</emphasis>
and updates the Amanda databases after a system failure on a tape server host.
This cleanup process is normally done automatically as part of the
<emphasis remap='B'>amdump</emphasis>
program, but if
<emphasis remap='B'>amdump</emphasis>
cannot complete for some reason (usually because of a tape server host crash),
<command>amcleanup</command>
must be run some time later (usually during system boot).</para>

<para>The <emphasis remap='B'>amcleanupdisk</emphasis> program is run with
the same <arg choice='opt'><option>-r</option></arg> and
<arg choice='opt'><option>-v</option></arg> options.</para>

<para>See the
<manref name="amanda" vol="8"/>
man page for more details about Amanda.</para>
</refsect1>

<refsect1><title>OPTIONS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-k</option></term>
  <listitem>
   <para>Kill all process listed in the log file are their child. if there
is no log file, then kill all amdump, amflush and amvault process and their
child.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-p</option></term>
  <listitem>
   <para>Do the cleanup only if all process listed in the log file are already terminated.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-r</option></term>
  <listitem>
   <para>Remove bad file in holding disk.  This options is passed to amcleanupdisk.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-v</option></term>
  <listitem>
   <para>Generate verbose output.  This options is passed to amcleanupdisk.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--note</option> <replaceable>string</replaceable></term>
  <listitem>
   <para>Add the <replaceable>string</replaceable> to the log files, it
will show up in the NOTES section of the report.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1><title>EXAMPLES</title>
<para>This example runs the Amanda cleanup process by hand after
a failure.</para>

<programlisting>
% amcleanup daily
</programlisting>

<para>Putting the following line in a system boot script (e.g.
<filename>/etc/rc.local</filename>)
runs the Amanda cleanup process as part of the reboot,
eliminating the need to run it by hand.</para>

<programlisting>
/usr/local/sbin/amcleanup daily
</programlisting>

<para>If nothing needs to be done,
<command>amcleanup</command>
exits normally with the message:</para>

<programlisting>
amcleanup: no unprocessed logfile to clean up.
</programlisting>
</refsect1>

<seealso>
<manref name="amdump" vol="8"/>
</seealso>

</refentry>