git.gag.com Git - debian/amanda/blob - man/xml-source/amserverconfig.8.xml

   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"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amserverconfig.8'>
  11 <refmeta>
  12 <refentrytitle>amserverconfig</refentrytitle>
  13 <manvolnum>8</manvolnum>
  14 </refmeta>
  15 <refnamediv>
  16 <refname>amserverconfig</refname>
  17 <refpurpose>program to setup initial &A; configuration</refpurpose>
  18 </refnamediv>
  19 <!-- body begins here -->
  20 <refsynopsisdiv>
  21 <cmdsynopsis>
  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>
  38 </cmdsynopsis>
  39 </refsynopsisdiv>
  40
  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
  45           not exist.
  46 &amserverconfig; does not change existing &A; configurations.
  47 &amserverconfig; must be run by user amandabackup.
  48 </para>
  49 </refsect1>
  50
  51
  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>
  55
  56 <para>&amserverconfig; builds a new "config" &A; configuration. Customize the configuration with the options below.</para>
  57
  58 <variablelist remap='TP'>
  59   <varlistentry>
  60   <term><option>--template template</option></term>
  61   <listitem>
  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.
  67                 </para>
  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.
  71 </para>
  72 <para>
  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.
  75 </para>
  76   </listitem>
  77   </varlistentry>
  78
  79   <varlistentry>
  80   <term><option>--no-vtape</option></term>
  81   <listitem>
  82 <para>Do not create virtual tapes in the harddisk template case. </para>
  83   </listitem>
  84   </varlistentry>
  85
  86
  87   <varlistentry>
  88   <term><option>--tapedev tapedev</option></term>
  89   <listitem>
  90 <para>The path name of non-rewinding tape device.
  91 default [file://var/lib/amanda/vtapes/$config]  </para>
  92   </listitem>
  93   </varlistentry>
  94
  95   <varlistentry>
  96   <term><option>--tpchanger tpchanger</option></term>
  97   <listitem>
  98 <para>The name of the tape changer. default [chg-disk]  </para>
  99   </listitem>
 100   </varlistentry>
 101
 102   <varlistentry>
 103   <term><option>--changerdev changerdev</option></term>
 104   <listitem>
 105 <para>A tape changer configuration parameter. default [/dev/null]  </para>
 106   </listitem>
 107   </varlistentry>
 108
 109   <varlistentry>
 110   <term><option>--changerfile changerfile</option></term>
 111   <listitem>
 112 <para>A tape changer configuration parameter. default [/etc/amanda/$config/changer.conf]  </para>
 113   </listitem>
 114   </varlistentry>
 115
 116   <varlistentry>
 117   <term><option>--labelstr labelstr</option></term>
 118   <listitem>
 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
 121 is supported.</para>
 122   </listitem>
 123   </varlistentry>
 124
 125   <varlistentry>
 126   <term><option>--tapetype tapetype</option></term>
 127   <listitem>
 128 <para>The type of tape drive associated with tapedev or  tpchanger. default [HARDDISK]  </para>
 129   </listitem>
 130   </varlistentry>
 131
 132   <varlistentry>
 133   <term><option>--mailto mailto</option></term>
 134   <listitem>
 135 <para> A space separated list of recipients for mail reports. default [amandabackup]  </para>
 136   </listitem>
 137   </varlistentry>
 138
 139   <varlistentry>
 140   <term><option>--dumpcycle dumpcycle</option></term>
 141   <listitem>
 142 <para>The number of days in the backup cycle. default [1week]  </para>
 143   </listitem>
 144   </varlistentry>
 145
 146   <varlistentry>
 147   <term><option>--runspercycle runspercycle</option></term>
 148   <listitem>
 149 <para>The number of days in the backup cycle. default [5]  </para>
 150   </listitem>
 151   </varlistentry>
 152
 153   <varlistentry>
 154   <term><option>--runtapes runtapes</option></term>
 155   <listitem>
 156 <para>The maximum number of tapes used in a single run. default [1]  </para>
 157   </listitem>
 158   </varlistentry>
 159
 160   <varlistentry>
 161   <term><option>--tapecycle tapecycle</option></term>
 162   <listitem>
 163 <para>The size of tape rotation. default [25]  </para>
 164   </listitem>
 165   </varlistentry>
 166
 167
 168   <varlistentry>
 169   <term><option>--help</option></term>
 170   <listitem>
 171 <para>Display usage. </para>
 172   </listitem>
 173   </varlistentry>
 174
 175 </variablelist>
 176 </refsect1>
 177
 178 <refsect1><title>Files</title>
 179 <variablelist remap='TP'>
 180  <varlistentry>
 181  <term><option>/var/lib/amanda/template.d</option></term>
 182   <listitem>
 183 <para>Amanda configuration template files install location</para>
 184   </listitem>
 185   </varlistentry>
 186
 187  <varlistentry>
 188  <term><option>/var/lib/amanda</option></term>
 189   <listitem>
 190 <para>amandabackup home directory</para>
 191   </listitem>
 192   </varlistentry>
 193
 194  <varlistentry>
 195  <term><option>/var/lib/amanda/gnutar-lists</option></term>
 196   <listitem>
 197 <para>A directory which contains backup timestamp and list of files backed up.</para>
 198   </listitem>
 199   </varlistentry>
 200
 201  <varlistentry>
 202  <term><option>/etc/amanda/$config</option></term>
 203   <listitem>
 204 <para>&A; configuration files location for $config(e.g: DailySet1).</para>
 205   </listitem>
 206   </varlistentry>
 207
 208  <varlistentry>
 209  <term><option>/etc/amanda/template.d</option></term>
 210   <listitem>
 211 <para>A directory contains dumptypes and tapetypes files used by all &A; configurations.</para>
 212   </listitem>
 213   </varlistentry>
 214
 215  <varlistentry>
 216  <term><option>/etc/amandates</option></term>
 217   <listitem>
 218 <para>&A; file on the client. It keeps track of structures of previous dumps.</para>
 219   </listitem>
 220   </varlistentry>
 221
 222  <varlistentry>
 223  <term><option>/tmp/amanda</option></term>
 224   <listitem>
 225 <para>directory contains &A; debug log files.</para>
 226   </listitem>
 227   </varlistentry>
 228
 229 </variablelist>
 230 </refsect1>
 231
 232 <refsect1><title>RETURN VALUE</title>
 233 On success, zero is returned.  On error, 1 is returned.
 234 </refsect1>
 235
 236 <refsect1><title>AUTHOR</title>
 237   <para>
 238     The tool and its documentation was written by Zmanda, Inc (http://www.zmanda.com/).
 239   </para>
 240 </refsect1>
 241
 242
 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"/>
 248 </para>
 249 </refsect1>
 250 </refentry>
 251