1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <refentry id='amserverconfig.8'>
12 <refentrytitle>amserverconfig</refentrytitle>
13 <manvolnum>8</manvolnum>
16 <refname>amserverconfig</refname>
17 <refpurpose>program to setup initial &A; configuration</refpurpose>
19 <!-- body begins here -->
22 <command>amserverconfig</command>
23 <arg choice='plain'><replaceable>config</replaceable></arg>
24 <arg choice='opt'>--template <replaceable>template</replaceable></arg>
25 <arg choice='opt'>--no-vtape </arg>
26 <arg choice='opt'>--tapetype <replaceable>tapetype</replaceable></arg>
27 <arg choice='opt'>--tpchanger <replaceable>tpchanger</replaceable></arg>
28 <arg choice='opt'>--tapedev <replaceable>tapedev</replaceable></arg>
29 <arg choice='opt'>--changerfile <replaceable>changerfile</replaceable></arg>
30 <arg choice='opt'>--changerdev <replaceable>changerdev</replaceable></arg>
31 <arg choice='opt'>--labelstr <replaceable>labelstr</replaceable></arg>
32 <arg choice='opt'>--mailto <replaceable>mailto</replaceable></arg>
33 <arg choice='opt'>--dumpcycle <replaceable>dumpcycle</replaceable></arg>
34 <arg choice='opt'>--runspercycle <replaceable>runspercycle</replaceable></arg>
35 <arg choice='opt'>--runtapes <replaceable>runtapes</replaceable></arg>
36 <arg choice='opt'>--tapecycle <replaceable>tapecycle</replaceable></arg>
37 <arg choice='opt'>--help </arg>
41 <refsect1><title>DESCRIPTION</title>
42 <para>After Amanda rpms are successfully installed,
43 &amserverconfig; will setup initial &A; configuration files.
44 It will create /var/lib/amanda/guntar-lists directory if one does
46 &amserverconfig; does not change existing &A; configurations.
47 &amserverconfig; must be run by user amandabackup.
52 <refsect1><title>Options</title>
53 <para>Options may be abbreviated, as long as the abbreviation is not ambiguous. Option argument can either separated by '=' or a space.
54 Example: --templ=harddisk --tapedev /dev/nst0</para>
56 <para>&amserverconfig; builds a new "config" &A; configuration. Customize the configuration with the options below.</para>
58 <variablelist remap='TP'>
60 <term><option>--template template</option></term>
62 <para>build &A; configuration with pre-configured template files. Currently,
63 <emphasis remap='B'>harddisk</emphasis>, <emphasis
64 remap='B'>single-tape</emphasis>, <emphasis remap='B'>tape-changer</emphasis> and <emphasis remap='B'>S3</emphasis>
65 are the valid inputs for this option. Pre-configured template files can be found in
66 /var/lib/amanda/template.d. This option may be combined with other options.
68 <para>If tape-changer is chosen for this option, program mtx is required. &amserverconfig; will
69 search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin",
70 "/usr/local/bin", "/usr/bin", "/bin" and amandabackup's PATH.
73 If harddisk is chosen and --no-vtape is not specified, &amserverconfig; will create and label virtual tape
74 file://var/lib/amanda/vtapes/$config.
80 <term><option>--no-vtape</option></term>
82 <para>Do not create virtual tapes in the harddisk template case. </para>
88 <term><option>--tapedev tapedev</option></term>
90 <para>The path name of non-rewinding tape device.
91 default [file://var/lib/amanda/vtapes/$config] </para>
96 <term><option>--tpchanger tpchanger</option></term>
98 <para>The name of the tape changer. default [chg-disk] </para>
103 <term><option>--changerdev changerdev</option></term>
105 <para>A tape changer configuration parameter. default [/dev/null] </para>
110 <term><option>--changerfile changerfile</option></term>
112 <para>A tape changer configuration parameter. default [/etc/amanda/$config/changer.conf] </para>
117 <term><option>--labelstr labelstr</option></term>
119 <para>The tape label constraint regular expression. default [^$config-[0-9][0-9]*$] </para>
120 <para>If this option is used with --template=harddisk, only alphanumeric string
126 <term><option>--tapetype tapetype</option></term>
128 <para>The type of tape drive associated with tapedev or tpchanger. default [HARDDISK] </para>
133 <term><option>--mailto mailto</option></term>
135 <para> A space separated list of recipients for mail reports. default [amandabackup] </para>
140 <term><option>--dumpcycle dumpcycle</option></term>
142 <para>The number of days in the backup cycle. default [1week] </para>
147 <term><option>--runspercycle runspercycle</option></term>
149 <para>The number of days in the backup cycle. default [5] </para>
154 <term><option>--runtapes runtapes</option></term>
156 <para>The maximum number of tapes used in a single run. default [1] </para>
161 <term><option>--tapecycle tapecycle</option></term>
163 <para>The size of tape rotation. default [25] </para>
169 <term><option>--help</option></term>
171 <para>Display usage. </para>
178 <refsect1><title>Files</title>
179 <variablelist remap='TP'>
181 <term><option>/var/lib/amanda/template.d</option></term>
183 <para>Amanda configuration template files install location</para>
188 <term><option>/var/lib/amanda</option></term>
190 <para>amandabackup home directory</para>
195 <term><option>/var/lib/amanda/gnutar-lists</option></term>
197 <para>A directory which contains backup timestamp and list of files backed up.</para>
202 <term><option>/etc/amanda/$config</option></term>
204 <para>&A; configuration files location for $config(e.g: DailySet1).</para>
209 <term><option>/etc/amanda/template.d</option></term>
211 <para>A directory contains dumptypes and tapetypes files used by all &A; configurations.</para>
216 <term><option>/etc/amandates</option></term>
218 <para>&A; file on the client. It keeps track of structures of previous dumps.</para>
223 <term><option>/tmp/amanda</option></term>
225 <para>directory contains &A; debug log files.</para>
232 <refsect1><title>RETURN VALUE</title>
233 On success, zero is returned. On error, 1 is returned.
236 <refsect1><title>AUTHOR</title>
238 The tool and its documentation was written by Zmanda, Inc (http://www.zmanda.com/).
243 <refsect1><title>SEE ALSO</title>
244 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
245 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
246 <citerefentry><refentrytitle>amaddclient</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
247 <ulink url="http://wiki.zmanda.com"/>