<?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;
]>

<refentry id='amserverconfig.8'>
<refmeta>
<refentrytitle>amserverconfig</refentrytitle>
<manvolnum>8</manvolnum>
&rmi.source;
&rmi.version;
&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amserverconfig</refname>
<refpurpose>program to setup initial Amanda configuration</refpurpose>
</refnamediv>
<refentryinfo>
&author.ktill;
</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
  <command>amserverconfig</command>  
<arg choice='plain'><replaceable>config</replaceable></arg>
<arg choice='opt'>--template <replaceable>template</replaceable></arg>
<arg choice='opt'>--no-vtape </arg>
<arg choice='opt'>--tapetype <replaceable>tapetype</replaceable></arg>
<arg choice='opt'>--tpchanger <replaceable>tpchanger</replaceable></arg>
<arg choice='opt'>--tapedev <replaceable>tapedev</replaceable></arg>
<arg choice='opt'>--changerfile <replaceable>changerfile</replaceable></arg>
<arg choice='opt'>--changerdev <replaceable>changerdev</replaceable></arg>
<arg choice='opt'>--labelstr <replaceable>labelstr</replaceable></arg>
<arg choice='opt'>--mailto <replaceable>mailto</replaceable></arg>
<arg choice='opt'>--dumpcycle <replaceable>dumpcycle</replaceable></arg>
<arg choice='opt'>--runspercycle <replaceable>runspercycle</replaceable></arg>
<arg choice='opt'>--runtapes <replaceable>runtapes</replaceable></arg>
<arg choice='opt'>--tapecycle <replaceable>tapecycle</replaceable></arg>
<arg choice='opt'>--help </arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>DESCRIPTION</title>
<para>After Amanda rpms are successfully installed,
	  &amserverconfig; will setup initial Amanda configuration files.
It will create /var/lib/amanda/guntar-lists directory if one does
	  not exist.
&amserverconfig; does not change existing Amanda configurations.
&amserverconfig; must be run by user backup.
</para> 
</refsect1>


<refsect1><title>Options</title>
<para>Options may be abbreviated, as long as the abbreviation is not ambiguous. Option argument can either separated by '=' or a space.
Example:  --templ=harddisk --tapedev /dev/nst0</para>

<para>&amserverconfig; builds a new "config" Amanda configuration. Customize the configuration with the options below.</para>

<variablelist remap='TP'>
  <varlistentry>
  <term><option>--template template</option></term>
  <listitem>
<para>build Amanda configuration with pre-configured template files. Currently,
		 <emphasis remap='B'>harddisk</emphasis>, <emphasis
		remap='B'>single-tape</emphasis>, <emphasis remap='B'>tape-changer</emphasis> and <emphasis remap='B'>S3</emphasis> 
		are the valid inputs for this option. Pre-configured template files can be found in 
		/var/lib/amanda/template.d. This option may be combined with other options.
	        </para>
<para>If tape-changer is chosen for this option, program mtx is required. &amserverconfig; will
search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin",
"/usr/local/bin", "/usr/bin", "/bin" and backup's PATH.
</para>
<para>
If harddisk is chosen and --no-vtape is not specified, &amserverconfig; will create and label virtual tape
file://var/lib/amanda/vtapes/$config.
</para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--no-vtape</option></term>
  <listitem>
<para>Do not create virtual tapes in the harddisk template case. </para>
  </listitem>
  </varlistentry>


  <varlistentry>
  <term><option>--tapedev tapedev</option></term>
  <listitem>
<para>The path name of non-rewinding tape device. 
default [file://var/lib/amanda/vtapes/$config]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--tpchanger tpchanger</option></term>
  <listitem>
<para>The name of the tape changer. default [chg-disk]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--changerdev changerdev</option></term>
  <listitem>
<para>A tape changer configuration parameter. default [/dev/null]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--changerfile changerfile</option></term>
  <listitem>
<para>A tape changer configuration parameter. default [/etc/amanda/$config/changer.conf]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--labelstr labelstr</option></term>
  <listitem>
<para>The tape label constraint regular expression. default [^$config-[0-9][0-9]*$]  </para>
<para>If this option is used with --template=harddisk, only alphanumeric string
is supported.</para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--tapetype tapetype</option></term>
  <listitem>
<para>The type of tape drive associated with tapedev or  tpchanger. default [HARDDISK]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--mailto mailto</option></term>
  <listitem>
<para> A space separated list of recipients for mail reports. default [backup]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--dumpcycle dumpcycle</option></term>
  <listitem>
<para>The number of days in the backup cycle. default [1week]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--runspercycle runspercycle</option></term>
  <listitem>
<para>The number of days in the backup cycle. default [5]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--runtapes runtapes</option></term>
  <listitem>
<para>The maximum number of tapes used in a single run. default [1]  </para>
  </listitem>
  </varlistentry>

  <varlistentry>
  <term><option>--tapecycle tapecycle</option></term>
  <listitem>
<para>The size of tape rotation. default [25]  </para>
  </listitem>
  </varlistentry>


  <varlistentry>
  <term><option>--help</option></term>
  <listitem>
<para>Display usage. </para>
  </listitem>
  </varlistentry>

</variablelist>
</refsect1>

<refsect1><title>Files</title>
<variablelist remap='TP'>
 <varlistentry>
 <term><option>/var/lib/amanda/template.d</option></term>
  <listitem>
<para>Amanda configuration template files install location</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/var/lib/amanda</option></term>
  <listitem>
<para>backup home directory</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/var/lib/amanda/gnutar-lists</option></term>
  <listitem>
<para>A directory which contains backup timestamp and list of files backed up.</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/etc/amanda/$config</option></term>
  <listitem>
<para>Amanda configuration files location for $config(e.g: DailySet1).</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/etc/amanda/template.d</option></term>
  <listitem>
<para>A directory contains dumptypes and tapetypes files used by all Amanda configurations.</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/etc/amandates</option></term>
  <listitem>
<para>Amanda file on the client. It keeps track of structures of previous dumps.</para>
  </listitem>
  </varlistentry>

 <varlistentry>
 <term><option>/tmp/amanda</option></term>
  <listitem>
<para>directory contains Amanda debug log files.</para>
  </listitem>
  </varlistentry>

</variablelist>
</refsect1>

<refsect1><title>RETURN VALUE</title>
On success, zero is returned.  On error, 1 is returned.
</refsect1>

<seealso>
<manref name="amanda.conf" vol="5"/>,
<manref name="amaddclient" vol="8"/>
</seealso>

</refentry>