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 'global.entities'>
10 <refentry id='amserverconfig.8'>
12 <refentrytitle>amserverconfig</refentrytitle>
13 <manvolnum>8</manvolnum>
19 <refname>amserverconfig</refname>
20 <refpurpose>program to setup initial Amanda configuration</refpurpose>
25 <!-- body begins here -->
28 <command>amserverconfig</command>
29 <arg choice='plain'><replaceable>config</replaceable></arg>
30 <arg choice='opt'>--template <replaceable>template</replaceable></arg>
31 <arg choice='opt'>--no-vtape </arg>
32 <arg choice='opt'>--tapetype <replaceable>tapetype</replaceable></arg>
33 <arg choice='opt'>--tpchanger <replaceable>tpchanger</replaceable></arg>
34 <arg choice='opt'>--tapedev <replaceable>tapedev</replaceable></arg>
35 <arg choice='opt'>--changerfile <replaceable>changerfile</replaceable></arg>
36 <arg choice='opt'>--changerdev <replaceable>changerdev</replaceable></arg>
37 <arg choice='opt'>--labelstr <replaceable>labelstr</replaceable></arg>
38 <arg choice='opt'>--mailto <replaceable>mailto</replaceable></arg>
39 <arg choice='opt'>--dumpcycle <replaceable>dumpcycle</replaceable></arg>
40 <arg choice='opt'>--runspercycle <replaceable>runspercycle</replaceable></arg>
41 <arg choice='opt'>--runtapes <replaceable>runtapes</replaceable></arg>
42 <arg choice='opt'>--tapecycle <replaceable>tapecycle</replaceable></arg>
43 <arg choice='opt'>--help </arg>
47 <refsect1><title>DESCRIPTION</title>
48 <para>After Amanda rpms are successfully installed,
49 &amserverconfig; will setup initial Amanda configuration files.
50 It will create /var/lib/amanda/guntar-lists directory if one does
52 &amserverconfig; does not change existing Amanda configurations.
53 &amserverconfig; must be run by user backup.
58 <refsect1><title>Options</title>
59 <para>Options may be abbreviated, as long as the abbreviation is not ambiguous. Option argument can either separated by '=' or a space.
60 Example: --templ=harddisk --tapedev /dev/nst0</para>
62 <para>&amserverconfig; builds a new "config" Amanda configuration. Customize the configuration with the options below.</para>
64 <variablelist remap='TP'>
66 <term><option>--template template</option></term>
68 <para>build Amanda configuration with pre-configured template files. Currently,
69 <emphasis remap='B'>harddisk</emphasis>, <emphasis
70 remap='B'>single-tape</emphasis>, <emphasis remap='B'>tape-changer</emphasis> and <emphasis remap='B'>S3</emphasis>
71 are the valid inputs for this option. Pre-configured template files can be found in
72 /var/lib/amanda/template.d. This option may be combined with other options.
74 <para>If tape-changer is chosen for this option, program mtx is required. &amserverconfig; will
75 search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin",
76 "/usr/local/bin", "/usr/bin", "/bin" and backup's PATH.
79 If harddisk is chosen and --no-vtape is not specified, &amserverconfig; will create and label virtual tape
80 file://var/lib/amanda/vtapes/$config.
86 <term><option>--no-vtape</option></term>
88 <para>Do not create virtual tapes in the harddisk template case. </para>
94 <term><option>--tapedev tapedev</option></term>
96 <para>The path name of non-rewinding tape device.
97 default [file://var/lib/amanda/vtapes/$config] </para>
102 <term><option>--tpchanger tpchanger</option></term>
104 <para>The name of the tape changer. default [chg-disk] </para>
109 <term><option>--changerdev changerdev</option></term>
111 <para>A tape changer configuration parameter. default [/dev/null] </para>
116 <term><option>--changerfile changerfile</option></term>
118 <para>A tape changer configuration parameter. default [/etc/amanda/$config/changer.conf] </para>
123 <term><option>--labelstr labelstr</option></term>
125 <para>The tape label constraint regular expression. default [^$config-[0-9][0-9]*$] </para>
126 <para>If this option is used with --template=harddisk, only alphanumeric string
132 <term><option>--tapetype tapetype</option></term>
134 <para>The type of tape drive associated with tapedev or tpchanger. default [HARDDISK] </para>
139 <term><option>--mailto mailto</option></term>
141 <para> A space separated list of recipients for mail reports. default [backup] </para>
146 <term><option>--dumpcycle dumpcycle</option></term>
148 <para>The number of days in the backup cycle. default [1week] </para>
153 <term><option>--runspercycle runspercycle</option></term>
155 <para>The number of days in the backup cycle. default [5] </para>
160 <term><option>--runtapes runtapes</option></term>
162 <para>The maximum number of tapes used in a single run. default [1] </para>
167 <term><option>--tapecycle tapecycle</option></term>
169 <para>The size of tape rotation. default [25] </para>
175 <term><option>--help</option></term>
177 <para>Display usage. </para>
184 <refsect1><title>Files</title>
185 <variablelist remap='TP'>
187 <term><option>/var/lib/amanda/template.d</option></term>
189 <para>Amanda configuration template files install location</para>
194 <term><option>/var/lib/amanda</option></term>
196 <para>backup home directory</para>
201 <term><option>/var/lib/amanda/gnutar-lists</option></term>
203 <para>A directory which contains backup timestamp and list of files backed up.</para>
208 <term><option>/etc/amanda/$config</option></term>
210 <para>Amanda configuration files location for $config(e.g: DailySet1).</para>
215 <term><option>/etc/amanda/template.d</option></term>
217 <para>A directory contains dumptypes and tapetypes files used by all Amanda configurations.</para>
222 <term><option>/etc/amandates</option></term>
224 <para>Amanda file on the client. It keeps track of structures of previous dumps.</para>
229 <term><option>/tmp/amanda</option></term>
231 <para>directory contains Amanda debug log files.</para>
238 <refsect1><title>RETURN VALUE</title>
239 On success, zero is returned. On error, 1 is returned.
243 <manref name="amanda.conf" vol="5"/>,
244 <manref name="amaddclient" vol="8"/>