2 .\" Author: Kevin Till <kevin.till@zmanda.com>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: System Administration Commands
6 .\" Source: Amanda 2.6.1
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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
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[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 amaddclient \- program to add client to an existing \fIAmanda\fR configuration
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]
180 After Amanda rpms are successfully installed and
184 will add client to the
191 file and create or update /var/lib/amanda/\&.amandahosts file on the server\&.
193 If \-\-no\-client\-update is not specified,
195 will attempt to update or create /var/lib/amanda/\&.amandahost, amanda\-client\&.conf and gnutar\-lists on the client\&. (See
203 must be run by user amandabackup\&.
205 \-\-config, \-\-client and \-\-diskdev must be specified\&.
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
214 \fB\-\-config config\fR
217 configuration which this program will add the client to\&.
220 \fB\-\-client client\fR
222 The name of the client machine to add\&. FQDN name recommended\&.
225 \fB\-\-diskdev diskdev\fR
229 configuration to backup\&.
234 Modify existing entry in the
240 file has been modified manually, this option might not work\&.
243 \fB\-\-dumptype dumptype\fR
245 dumptype to use\&. Dumptype must be defined in /etc/amanda/template\&.d/dumptypes or /etc/amanda/$config/amanda\&.conf file\&. Default: [user\-tar]
248 \fB\-\-user string\fR
252 on the client, default is root\&.
255 \fB\-\-auth string\fR
257 authentication method to use when running
259 from the client , default is bsdtcp\&.
262 \fB\-\-gnutar_list_dir string\fR
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\&.
267 \fB\-\-amandates string\fR
269 file where amanda keep the date of each dumplevel on the client, default is /etc/amandates\&.
274 Turn on batch mode when copying files to the client, default is off
277 \fB\-\-no\-client\-update\fR
279 If this option is set,
281 will not attempt to update/create \&.amandahosts, amanda\-client\&.conf and gnutar\-lists file on the client\&.
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\&.
294 \fB\-\-includefile string\fR
296 string is a glob expression
299 \fB\-\-includelist string\fR
301 string is a file name on the client containing glob expressions\&. Specify either \-\-includefile or \-\-includelist\&.
304 \fB\-\-excludefile string\fR
306 string is a glob expression
309 \fB\-\-excludelist string\fR
311 string is a file name on the client containing glob expressions\&. Specify either \-\-excludefile or \-\-excludelist\&.
315 \fB/var/lib/amanda/template\&.d\fR
317 Amanda configuration template files install location
320 \fB/var/lib/amanda\fR
322 amandabackup home directory
325 \fB/var/lib/amanda/\&.amandahosts\fR
328 authentication file\&.
331 \fB/var/lib/amanda/gnutar\-lists\fR
333 A directory which contains backup timestamp and list of files backed up\&.
336 \fB/etc/amanda/$config\fR
339 configuration files location for $config(e\&.g: DailySet1)\&.
342 \fB/etc/amanda/template\&.d\fR
344 A directory contains dumptypes and tapetypes files used by all
352 file on the client\&. It keeps track of structures of previous dumps\&.
363 On success, zero is returned\&. On error, 1 is returned\&.
367 \fBamanda.conf\fR(5),
368 \fBamserverconfig\fR(8)
372 : http://wiki.zmanda.com
375 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
377 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])