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

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