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

   1 .\"     Title: amaddclient
   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 "AMADDCLIENT" "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 amaddclient \- program to add client to an existing \fIAmanda\fR configuration
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamaddclient\fR\ 'u
 174 \fBamaddclient\fR \-\-config \fIconfig\fR ||
 175  \-\-client \fIclient\ name\fR ||
 176  \-\-diskdev \fIdirectory\ to\ backup\fR [\-\-m] [\-\-dumptype\ \fIstring\fR] [\-\-includefile\ \fIstring\fR] [\-\-includelist\ \fIstring\fR] [\-\-excludefile\ \fIstring\fR] [\-\-excludelist\ \fIstring\fR] [\-\-user\ \fIstring\fR] [\-\-auth\ \fIstring\fR] [\-\-gnutar_list_dir\ \fIstring\fR] [\-\-amandates\ \fIstring\fR] [\-\-no\-client\-update] [\-\-batch] [\-\-help]
 177 .fam
 178 .SH "DESCRIPTION"
 179 .PP
 180 After Amanda rpms are successfully installed and
 181 \fBamserverconfig\fR
 182 is run,
 183 \fBamaddclient\fR
 184 will add client to the
 185 \fIAmanda\fR
 186 configuration\&.
 187 \fBamaddclient\fR
 188 create or update
 189 \fIAmanda\fR
 190 \fBdisklist\fR(5)
 191 file and create or update /var/lib/amanda/\&.amandahosts file on the server\&.
 192 .PP
 193 If \-\-no\-client\-update is not specified,
 194 \fBamaddclient\fR
 195 will attempt to update or create /var/lib/amanda/\&.amandahost, amanda\-client\&.conf and gnutar\-lists on the client\&. (See
 196 ssh\-keygen(1)
 197 and
 198 ssh\-add(1)
 199 for detail\&.)
 200 .PP
 201
 202 \fBamaddclient\fR
 203 must be run by user amandabackup\&.
 204 .PP
 205 \-\-config, \-\-client and \-\-diskdev must be specified\&.
 206 .SH "Options"
 207 .PP
 208 .RS 4
 209
 210 Options may be abbreviated, as long as the abbreviation is not ambiguous\&. Option argument can either separated by \'=\' or a space\&.
 211 Example: \-\-conf=v253, \-\-client client8\&.zmanda\&.com
 212 .RE
 213 .PP
 214 \fB\-\-config config\fR
 215 .RS 4
 216 \fIAmanda\fR
 217 configuration which this program will add the client to\&.
 218 .RE
 219 .PP
 220 \fB\-\-client client\fR
 221 .RS 4
 222 The name of the client machine to add\&. FQDN name recommended\&.
 223 .RE
 224 .PP
 225 \fB\-\-diskdev diskdev\fR
 226 .RS 4
 227 Directory for this
 228 \fIAmanda\fR
 229 configuration to backup\&.
 230 .RE
 231 .PP
 232 \fB\-\-m\fR
 233 .RS 4
 234 Modify existing entry in the
 235 \fBdisklist\fR(5)
 236 file\&.
 237 .sp
 238 Note: if
 239 \fBdisklist\fR(5)
 240 file has been modified manually, this option might not work\&.
 241 .RE
 242 .PP
 243 \fB\-\-dumptype dumptype\fR
 244 .RS 4
 245 dumptype to use\&. Dumptype must be defined in /etc/amanda/template\&.d/dumptypes or /etc/amanda/$config/amanda\&.conf file\&. Default: [user\-tar]
 246 .RE
 247 .PP
 248 \fB\-\-user string\fR
 249 .RS 4
 250 name of user using
 251 \fBamrecover\fR
 252 on the client, default is root\&.
 253 .RE
 254 .PP
 255 \fB\-\-auth string\fR
 256 .RS 4
 257 authentication method to use when running
 258 \fBamrecover\fR
 259 from the client , default is bsdtcp\&.
 260 .RE
 261 .PP
 262 \fB\-\-gnutar_list_dir string\fR
 263 .RS 4
 264 directory where gnutar keep its state file on the client\&. Absolute path required\&. Default is /var/lib/amanda/gnutar\-lists\&. If \-\-no\-client\-update is not set, this program will attempt to create the directory on the client\&.
 265 .RE
 266 .PP
 267 \fB\-\-amandates string\fR
 268 .RS 4
 269 file where amanda keep the date of each dumplevel on the client, default is /etc/amandates\&.
 270 .RE
 271 .PP
 272 \fB\-\-batch\fR
 273 .RS 4
 274 Turn on batch mode when copying files to the client, default is off
 275 .RE
 276 .PP
 277 \fB\-\-no\-client\-update\fR
 278 .RS 4
 279 If this option is set,
 280 \fBamaddclient\fR
 281 will not attempt to update/create \&.amandahosts, amanda\-client\&.conf and gnutar\-lists file on the client\&.
 282 .RE
 283 .PP
 284 \fB\-\-help\fR
 285 .RS 4
 286 Display usage\&.
 287 .RE
 288 .PP
 289 .RS 4
 290
 291 If any of the following four options are used,  \fBamaddclient\fR will extend the dumptype definition to an in\-line definition in the \fBdisklist\fR(5) file\&.
 292 .RE
 293 .PP
 294 \fB\-\-includefile string\fR
 295 .RS 4
 296 string is a glob expression
 297 .RE
 298 .PP
 299 \fB\-\-includelist string\fR
 300 .RS 4
 301 string is a file name on the client containing glob expressions\&. Specify either \-\-includefile or \-\-includelist\&.
 302 .RE
 303 .PP
 304 \fB\-\-excludefile string\fR
 305 .RS 4
 306 string is a glob expression
 307 .RE
 308 .PP
 309 \fB\-\-excludelist string\fR
 310 .RS 4
 311 string is a file name on the client containing glob expressions\&. Specify either \-\-excludefile or \-\-excludelist\&.
 312 .RE
 313 .SH "Files"
 314 .PP
 315 \fB/var/lib/amanda/template\&.d\fR
 316 .RS 4
 317 Amanda configuration template files install location
 318 .RE
 319 .PP
 320 \fB/var/lib/amanda\fR
 321 .RS 4
 322 amandabackup home directory
 323 .RE
 324 .PP
 325 \fB/var/lib/amanda/\&.amandahosts\fR
 326 .RS 4
 327 \fIAmanda\fR
 328 authentication file\&.
 329 .RE
 330 .PP
 331 \fB/var/lib/amanda/gnutar\-lists\fR
 332 .RS 4
 333 A directory which contains backup timestamp and list of files backed up\&.
 334 .RE
 335 .PP
 336 \fB/etc/amanda/$config\fR
 337 .RS 4
 338 \fIAmanda\fR
 339 configuration files location for $config(e\&.g: DailySet1)\&.
 340 .RE
 341 .PP
 342 \fB/etc/amanda/template\&.d\fR
 343 .RS 4
 344 A directory contains dumptypes and tapetypes files used by all
 345 \fIAmanda\fR
 346 configurations\&.
 347 .RE
 348 .PP
 349 \fB/etc/amandates\fR
 350 .RS 4
 351 \fIAmanda\fR
 352 file on the client\&. It keeps track of structures of previous dumps\&.
 353 .RE
 354 .PP
 355 \fB/tmp/amanda\fR
 356 .RS 4
 357 directory contains
 358 \fIAmanda\fR
 359 debug log files\&.
 360 .RE
 361 .SH "RETURN VALUE"
 362
 363 On success, zero is returned\&.  On error, 1 is returned\&.
 364 .SH "SEE ALSO"
 365 .PP
 366 \fBamanda\fR(8),
 367 \fBamanda.conf\fR(5),
 368 \fBamserverconfig\fR(8)
 369 \fBssh-keygen\fR(1)
 370 \fBssh-add\fR(1)
 371 \fBscp\fR(1)
 372 : http://wiki.zmanda.com
 373 .SH "Author"
 374 .PP
 375 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 376 .RS 4
 377 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 378 .RE