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 vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSERVERCONFIG" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amserverconfig \- program to setup initial Amanda configuration
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamserverconfig\fR\ 'u
  25 \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]
  26 .SH "DESCRIPTION"
  27 .PP
  28 After Amanda rpms are successfully installed,
  29 \fBamserverconfig\fR
  30 will setup initial Amanda configuration files\&. It will create /var/lib/amanda/guntar\-lists directory if one does not exist\&.
  31 \fBamserverconfig\fR
  32 does not change existing Amanda configurations\&.
  33 \fBamserverconfig\fR
  34 must be run by user amandabackup\&.
  35 .SH "OPTIONS"
  36 .PP
  37 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
  38 .PP
  39
  40 \fBamserverconfig\fR
  41 builds a new "config" Amanda configuration\&. Customize the configuration with the options below\&.
  42 .PP
  43 \fB\-\-template template\fR
  44 .RS 4
  45 build Amanda 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 Amanda configuration files location for $config(e\&.g: DailySet1)\&.
 148 .RE
 149 .PP
 150 \fB/etc/amanda/template\&.d\fR
 151 .RS 4
 152 A directory contains dumptypes and tapetypes files used by all Amanda configurations\&.
 153 .RE
 154 .PP
 155 \fB/etc/amandates\fR
 156 .RS 4
 157 Amanda file on the client\&. It keeps track of structures of previous dumps\&.
 158 .RE
 159 .PP
 160 \fB/tmp/amanda\fR
 161 .RS 4
 162 directory contains Amanda debug log files\&.
 163 .RE
 164 .SH "RETURN VALUE"
 165
 166 On success, zero is returned\&.  On error, 1 is returned\&.
 167 .SH "SEE ALSO"
 168 .PP
 169 \fBamanda\fR(8),
 170 \fBamanda.conf\fR(5),
 171 \fBamaddclient\fR(8)
 172 .PP
 173 The Amanda Wiki:
 174 : http://wiki.zmanda.com/
 175 .SH "AUTHOR"
 176 .PP
 177 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 178 .RS 4
 179 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 180 .RE