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

   1 .\"     Title: amserverconfig
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 05/14/2008
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "AMSERVERCONFIG" "8" "05/14/2008" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 amserverconfig - program to setup initial Amanda configuration
  15 .SH "SYNOPSIS"
  16 .HP 15
  17 \fBamserverconfig\fR \fIconfig\fR [\-\-template\ \fItemplate\fR] [\-\-no\-vtape] [\-\-tapetype\ \fItapetype\fR] [\-\-tpchanger\ \fItpchanger\fR] [\-\-tapedev\ \fItapedev\fR] [\-\-changerfile\ \fIchangerfile\fR] [\-\-changerdev\ \fIchangerdev\fR] [\-\-labelstr\ \fIlabelstr\fR] [\-\-mailto\ \fImailto\fR] [\-\-dumpcycle\ \fIdumpcycle\fR] [\-\-runspercycle\ \fIrunspercycle\fR] [\-\-runtapes\ \fIruntapes\fR] [\-\-tapecycle\ \fItapecycle\fR] [\-\-help]
  18 .SH "DESCRIPTION"
  19 .PP
  20 After Amanda rpms are successfully installed,
  21 \fBamserverconfig\fR
  22 will setup initial
  23 \fIAmanda\fR
  24 configuration files\. It will create /var/lib/amanda/guntar\-lists directory if one does not exist\.
  25 \fBamserverconfig\fR
  26 does not change existing
  27 \fIAmanda\fR
  28 configurations\.
  29 \fBamserverconfig\fR
  30 must be run by user amandabackup\.
  31 .SH "OPTIONS"
  32 .PP
  33 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
  34 .PP
  35
  36 \fBamserverconfig\fR
  37 builds a new "config"
  38 \fIAmanda\fR
  39 configuration\. Customize the configuration with the options below\.
  40 .PP
  41 \fB\-\-template template\fR
  42 .RS 4
  43 build
  44 \fIAmanda\fR
  45 configuration with pre\-configured template files\. Currently,
  46 \fBharddisk\fR,
  47 \fBsingle\-tape\fR,
  48 \fBtape\-changer\fR
  49 and
  50 \fBS3\fR
  51 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\.
  52 .sp
  53 If tape\-changer is chosen for this option, program mtx is required\.
  54 \fBamserverconfig\fR
  55 will search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin", "/usr/local/bin", "/usr/bin", "/bin" and amandabackup\'s PATH\.
  56 .sp
  57 If harddisk is chosen and \-\-no\-vtape is not specified,
  58 \fBamserverconfig\fR
  59 will create and label virtual tape file://var/lib/amanda/vtapes/$config\.
  60 .RE
  61 .PP
  62 \fB\-\-no\-vtape\fR
  63 .RS 4
  64 Do not create virtual tapes in the harddisk template case\.
  65 .RE
  66 .PP
  67 \fB\-\-tapedev tapedev\fR
  68 .RS 4
  69 The path name of non\-rewinding tape device\. default [file://var/lib/amanda/vtapes/$config]
  70 .RE
  71 .PP
  72 \fB\-\-tpchanger tpchanger\fR
  73 .RS 4
  74 The name of the tape changer\. default [chg\-disk]
  75 .RE
  76 .PP
  77 \fB\-\-changerdev changerdev\fR
  78 .RS 4
  79 A tape changer configuration parameter\. default [/dev/null]
  80 .RE
  81 .PP
  82 \fB\-\-changerfile changerfile\fR
  83 .RS 4
  84 A tape changer configuration parameter\. default [/etc/amanda/$config/changer\.conf]
  85 .RE
  86 .PP
  87 \fB\-\-labelstr labelstr\fR
  88 .RS 4
  89 The tape label constraint regular expression\. default [^$config\-[0\-9][0\-9]*$]
  90 .sp
  91 If this option is used with \-\-template=harddisk, only alphanumeric string is supported\.
  92 .RE
  93 .PP
  94 \fB\-\-tapetype tapetype\fR
  95 .RS 4
  96 The type of tape drive associated with tapedev or tpchanger\. default [HARDDISK]
  97 .RE
  98 .PP
  99 \fB\-\-mailto mailto\fR
 100 .RS 4
 101 A space separated list of recipients for mail reports\. default [amandabackup]
 102 .RE
 103 .PP
 104 \fB\-\-dumpcycle dumpcycle\fR
 105 .RS 4
 106 The number of days in the backup cycle\. default [1week]
 107 .RE
 108 .PP
 109 \fB\-\-runspercycle runspercycle\fR
 110 .RS 4
 111 The number of days in the backup cycle\. default [5]
 112 .RE
 113 .PP
 114 \fB\-\-runtapes runtapes\fR
 115 .RS 4
 116 The maximum number of tapes used in a single run\. default [1]
 117 .RE
 118 .PP
 119 \fB\-\-tapecycle tapecycle\fR
 120 .RS 4
 121 The size of tape rotation\. default [25]
 122 .RE
 123 .PP
 124 \fB\-\-help\fR
 125 .RS 4
 126 Display usage\.
 127 .RE
 128 .SH "FILES"
 129 .PP
 130 \fB/var/lib/amanda/template\.d\fR
 131 .RS 4
 132 Amanda configuration template files install location
 133 .RE
 134 .PP
 135 \fB/var/lib/amanda\fR
 136 .RS 4
 137 amandabackup home directory
 138 .RE
 139 .PP
 140 \fB/var/lib/amanda/gnutar\-lists\fR
 141 .RS 4
 142 A directory which contains backup timestamp and list of files backed up\.
 143 .RE
 144 .PP
 145 \fB/etc/amanda/$config\fR
 146 .RS 4
 147 \fIAmanda\fR
 148 configuration files location for $config(e\.g: DailySet1)\.
 149 .RE
 150 .PP
 151 \fB/etc/amanda/template\.d\fR
 152 .RS 4
 153 A directory contains dumptypes and tapetypes files used by all
 154 \fIAmanda\fR
 155 configurations\.
 156 .RE
 157 .PP
 158 \fB/etc/amandates\fR
 159 .RS 4
 160 \fIAmanda\fR
 161 file on the client\. It keeps track of structures of previous dumps\.
 162 .RE
 163 .PP
 164 \fB/tmp/amanda\fR
 165 .RS 4
 166 directory contains
 167 \fIAmanda\fR
 168 debug log files\.
 169 .RE
 170 .SH "RETURN VALUE"
 171
 172 On success, zero is returned\.  On error, 1 is returned\.
 173 .SH "AUTHOR"
 174 .PP
 175 The tool and its documentation was written by Zmanda, Inc (http://www\.zmanda\.com/)\.
 176 .SH "SEE ALSO"
 177 .PP
 178 \fBamanda\fR(8),
 179 \fBamanda.conf\fR(5),
 180 \fBamaddclient\fR(8),
 181 \fI\%http://wiki.zmanda.com\fR