.\"     Title: amaddclient
.\"    Author: Kevin Till <kevin.till@zmanda.com>
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\"      Date: 01/22/2009
.\"    Manual: System Administration Commands
.\"    Source: Amanda 2.6.1
.\"  Language: English
.\"
.TH "AMADDCLIENT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
.\" -----------------------------------------------------------------
.\" * (re)Define some macros
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" toupper - uppercase a string (locale-aware)
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\$*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH-xref - format a cross-reference to an SH section
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH - level-one heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
.\" put an extra blank line of space above the head in non-TTY output
.if t \{\
.sp 1
.\}
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SS - level-two heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BB/BE - put background/screen (filled box) around block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BM/EM - put colored marker in margin next to block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
..
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
amaddclient \- program to add client to an existing \fIAmanda\fR configuration
.SH "Synopsis"
.fam C
.HP \w'\fBamaddclient\fR\ 'u
\fBamaddclient\fR \-\-config \fIconfig\fR ||
 \-\-client \fIclient\ name\fR ||
 \-\-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]
.fam
.SH "DESCRIPTION"
.PP
After Amanda rpms are successfully installed and
\fBamserverconfig\fR
is run,
\fBamaddclient\fR
will add client to the
\fIAmanda\fR
configuration\&.
\fBamaddclient\fR
create or update
\fIAmanda\fR
\fBdisklist\fR(5)
file and create or update /var/lib/amanda/\&.amandahosts file on the server\&.
.PP
If \-\-no\-client\-update is not specified,
\fBamaddclient\fR
will attempt to update or create /var/lib/amanda/\&.amandahost, amanda\-client\&.conf and gnutar\-lists on the client\&. (See
ssh\-keygen(1)
and
ssh\-add(1)
for detail\&.)
.PP

\fBamaddclient\fR
must be run by user amandabackup\&.
.PP
\-\-config, \-\-client and \-\-diskdev must be specified\&.
.SH "Options"
.PP
.RS 4

Options may be abbreviated, as long as the abbreviation is not ambiguous\&. Option argument can either separated by \'=\' or a space\&.
Example: \-\-conf=v253, \-\-client client8\&.zmanda\&.com
.RE
.PP
\fB\-\-config config\fR
.RS 4
\fIAmanda\fR
configuration which this program will add the client to\&.
.RE
.PP
\fB\-\-client client\fR
.RS 4
The name of the client machine to add\&. FQDN name recommended\&.
.RE
.PP
\fB\-\-diskdev diskdev\fR
.RS 4
Directory for this
\fIAmanda\fR
configuration to backup\&.
.RE
.PP
\fB\-\-m\fR
.RS 4
Modify existing entry in the
\fBdisklist\fR(5)
file\&.
.sp
Note: if
\fBdisklist\fR(5)
file has been modified manually, this option might not work\&.
.RE
.PP
\fB\-\-dumptype dumptype\fR
.RS 4
dumptype to use\&. Dumptype must be defined in /etc/amanda/template\&.d/dumptypes or /etc/amanda/$config/amanda\&.conf file\&. Default: [user\-tar]
.RE
.PP
\fB\-\-user string\fR
.RS 4
name of user using
\fBamrecover\fR
on the client, default is root\&.
.RE
.PP
\fB\-\-auth string\fR
.RS 4
authentication method to use when running
\fBamrecover\fR
from the client , default is bsdtcp\&.
.RE
.PP
\fB\-\-gnutar_list_dir string\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-amandates string\fR
.RS 4
file where amanda keep the date of each dumplevel on the client, default is /etc/amandates\&.
.RE
.PP
\fB\-\-batch\fR
.RS 4
Turn on batch mode when copying files to the client, default is off
.RE
.PP
\fB\-\-no\-client\-update\fR
.RS 4
If this option is set,
\fBamaddclient\fR
will not attempt to update/create \&.amandahosts, amanda\-client\&.conf and gnutar\-lists file on the client\&.
.RE
.PP
\fB\-\-help\fR
.RS 4
Display usage\&.
.RE
.PP
.RS 4
 
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\&.
.RE
.PP
\fB\-\-includefile string\fR
.RS 4
string is a glob expression
.RE
.PP
\fB\-\-includelist string\fR
.RS 4
string is a file name on the client containing glob expressions\&. Specify either \-\-includefile or \-\-includelist\&.
.RE
.PP
\fB\-\-excludefile string\fR
.RS 4
string is a glob expression
.RE
.PP
\fB\-\-excludelist string\fR
.RS 4
string is a file name on the client containing glob expressions\&. Specify either \-\-excludefile or \-\-excludelist\&.
.RE
.SH "Files"
.PP
\fB/var/lib/amanda/template\&.d\fR
.RS 4
Amanda configuration template files install location
.RE
.PP
\fB/var/lib/amanda\fR
.RS 4
amandabackup home directory
.RE
.PP
\fB/var/lib/amanda/\&.amandahosts\fR
.RS 4
\fIAmanda\fR
authentication file\&.
.RE
.PP
\fB/var/lib/amanda/gnutar\-lists\fR
.RS 4
A directory which contains backup timestamp and list of files backed up\&.
.RE
.PP
\fB/etc/amanda/$config\fR
.RS 4
\fIAmanda\fR
configuration files location for $config(e\&.g: DailySet1)\&.
.RE
.PP
\fB/etc/amanda/template\&.d\fR
.RS 4
A directory contains dumptypes and tapetypes files used by all
\fIAmanda\fR
configurations\&.
.RE
.PP
\fB/etc/amandates\fR
.RS 4
\fIAmanda\fR
file on the client\&. It keeps track of structures of previous dumps\&.
.RE
.PP
\fB/tmp/amanda\fR
.RS 4
directory contains
\fIAmanda\fR
debug log files\&.
.RE
.SH "RETURN VALUE"

On success, zero is returned\&.  On error, 1 is returned\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
\fBamanda.conf\fR(5),
\fBamserverconfig\fR(8)
\fBssh-keygen\fR(1)
\fBssh-add\fR(1)
\fBscp\fR(1)
: http://wiki.zmanda.com
.SH "Author"
.PP
\fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
.RS 4
Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
.RE