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

   1 .\"     Title: amserverconfig
   2 .\"    Author: Kevin Till <kevin.till@zmanda.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMSERVERCONFIG" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amserverconfig \- program to setup initial \fIAmanda\fR configuration
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamserverconfig\fR\ 'u
 174 \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]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 After Amanda rpms are successfully installed,
 179 \fBamserverconfig\fR
 180 will setup initial
 181 \fIAmanda\fR
 182 configuration files\&. It will create /var/lib/amanda/guntar\-lists directory if one does not exist\&.
 183 \fBamserverconfig\fR
 184 does not change existing
 185 \fIAmanda\fR
 186 configurations\&.
 187 \fBamserverconfig\fR
 188 must be run by user amandabackup\&.
 189 .SH "Options"
 190 .PP
 191 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
 192 .PP
 193
 194 \fBamserverconfig\fR
 195 builds a new "config"
 196 \fIAmanda\fR
 197 configuration\&. Customize the configuration with the options below\&.
 198 .PP
 199 \fB\-\-template template\fR
 200 .RS 4
 201 build
 202 \fIAmanda\fR
 203 configuration with pre\-configured template files\&. Currently,
 204 \fBharddisk\fR,
 205 \fBsingle\-tape\fR,
 206 \fBtape\-changer\fR
 207 and
 208 \fBS3\fR
 209 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\&.
 210 .sp
 211 If tape\-changer is chosen for this option, program mtx is required\&.
 212 \fBamserverconfig\fR
 213 will search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin", "/usr/local/bin", "/usr/bin", "/bin" and amandabackup\'s PATH\&.
 214 .sp
 215 If harddisk is chosen and \-\-no\-vtape is not specified,
 216 \fBamserverconfig\fR
 217 will create and label virtual tape file://var/lib/amanda/vtapes/$config\&.
 218 .RE
 219 .PP
 220 \fB\-\-no\-vtape\fR
 221 .RS 4
 222 Do not create virtual tapes in the harddisk template case\&.
 223 .RE
 224 .PP
 225 \fB\-\-tapedev tapedev\fR
 226 .RS 4
 227 The path name of non\-rewinding tape device\&. default [file://var/lib/amanda/vtapes/$config]
 228 .RE
 229 .PP
 230 \fB\-\-tpchanger tpchanger\fR
 231 .RS 4
 232 The name of the tape changer\&. default [chg\-disk]
 233 .RE
 234 .PP
 235 \fB\-\-changerdev changerdev\fR
 236 .RS 4
 237 A tape changer configuration parameter\&. default [/dev/null]
 238 .RE
 239 .PP
 240 \fB\-\-changerfile changerfile\fR
 241 .RS 4
 242 A tape changer configuration parameter\&. default [/etc/amanda/$config/changer\&.conf]
 243 .RE
 244 .PP
 245 \fB\-\-labelstr labelstr\fR
 246 .RS 4
 247 The tape label constraint regular expression\&. default [^$config\-[0\-9][0\-9]*$]
 248 .sp
 249 If this option is used with \-\-template=harddisk, only alphanumeric string is supported\&.
 250 .RE
 251 .PP
 252 \fB\-\-tapetype tapetype\fR
 253 .RS 4
 254 The type of tape drive associated with tapedev or tpchanger\&. default [HARDDISK]
 255 .RE
 256 .PP
 257 \fB\-\-mailto mailto\fR
 258 .RS 4
 259 A space separated list of recipients for mail reports\&. default [amandabackup]
 260 .RE
 261 .PP
 262 \fB\-\-dumpcycle dumpcycle\fR
 263 .RS 4
 264 The number of days in the backup cycle\&. default [1week]
 265 .RE
 266 .PP
 267 \fB\-\-runspercycle runspercycle\fR
 268 .RS 4
 269 The number of days in the backup cycle\&. default [5]
 270 .RE
 271 .PP
 272 \fB\-\-runtapes runtapes\fR
 273 .RS 4
 274 The maximum number of tapes used in a single run\&. default [1]
 275 .RE
 276 .PP
 277 \fB\-\-tapecycle tapecycle\fR
 278 .RS 4
 279 The size of tape rotation\&. default [25]
 280 .RE
 281 .PP
 282 \fB\-\-help\fR
 283 .RS 4
 284 Display usage\&.
 285 .RE
 286 .SH "Files"
 287 .PP
 288 \fB/var/lib/amanda/template\&.d\fR
 289 .RS 4
 290 Amanda configuration template files install location
 291 .RE
 292 .PP
 293 \fB/var/lib/amanda\fR
 294 .RS 4
 295 amandabackup home directory
 296 .RE
 297 .PP
 298 \fB/var/lib/amanda/gnutar\-lists\fR
 299 .RS 4
 300 A directory which contains backup timestamp and list of files backed up\&.
 301 .RE
 302 .PP
 303 \fB/etc/amanda/$config\fR
 304 .RS 4
 305 \fIAmanda\fR
 306 configuration files location for $config(e\&.g: DailySet1)\&.
 307 .RE
 308 .PP
 309 \fB/etc/amanda/template\&.d\fR
 310 .RS 4
 311 A directory contains dumptypes and tapetypes files used by all
 312 \fIAmanda\fR
 313 configurations\&.
 314 .RE
 315 .PP
 316 \fB/etc/amandates\fR
 317 .RS 4
 318 \fIAmanda\fR
 319 file on the client\&. It keeps track of structures of previous dumps\&.
 320 .RE
 321 .PP
 322 \fB/tmp/amanda\fR
 323 .RS 4
 324 directory contains
 325 \fIAmanda\fR
 326 debug log files\&.
 327 .RE
 328 .SH "RETURN VALUE"
 329
 330 On success, zero is returned\&.  On error, 1 is returned\&.
 331 .SH "SEE ALSO"
 332 .PP
 333 \fBamanda\fR(8),
 334 \fBamanda.conf\fR(5),
 335 \fBamaddclient\fR(8),
 336 : http://wiki.zmanda.com
 337 .SH "Author"
 338 .PP
 339 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 340 .RS 4
 341 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 342 .RE