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

   1 .\"     Title: amaddclient
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 05/14/2008
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "AMADDCLIENT" "8" "05/14/2008" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 amaddclient - program to add client to an existing Amanda configuration
  15 .SH "SYNOPSIS"
  16 .HP 12
  17 \fBamaddclient\fR \-\-config \fIconfig\fR ||
  18  \-\-client \fIclient\ name\fR ||
  19  \-\-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]
  20 .SH "DESCRIPTION"
  21 .PP
  22 After Amanda rpms are successfully installed and
  23 \fBamserverconfig\fR
  24 is run,
  25 \fBamaddclient\fR
  26 will add client to the
  27 \fIAmanda\fR
  28 configuration\.
  29 \fBamaddclient\fR
  30 create or update
  31 \fIAmanda\fR
  32 disklist file and create or update /var/lib/amanda/\.amandahosts file on the server\.
  33 .PP
  34 If \-\-no\-client\-update is not specified,
  35 \fBamaddclient\fR
  36 will attempt to update or create /var/lib/amanda/\.amandahost, amanda\-client\.conf and gnutar\-lists on the client\. (See
  37 ssh\-keygen(1)
  38 and
  39 ssh\-add(1)
  40 for detail\.)
  41 .PP
  42
  43 \fBamaddclient\fR
  44 must be run by user amandabackup\.
  45 .PP
  46 \-\-config, \-\-client and \-\-diskdev must be specified\.
  47 .SH "OPTIONS"
  48 .PP
  49 .RS 4
  50
  51 Options may be abbreviated, as long as the abbreviation is not ambiguous\. Option argument can either separated by \'=\' or a space\.
  52 Example: \-\-conf=v253, \-\-client client8\.zmanda\.com
  53 .RE
  54 .PP
  55 \fB\-\-config config\fR
  56 .RS 4
  57 \fIAmanda\fR
  58 configuration which this program will add the client to\.
  59 .RE
  60 .PP
  61 \fB\-\-client client\fR
  62 .RS 4
  63 The name of the client machine to add\. FQDN name recommended\.
  64 .RE
  65 .PP
  66 \fB\-\-diskdev diskdev\fR
  67 .RS 4
  68 Directory for this
  69 \fIAmanda\fR
  70 configuration to backup\.
  71 .RE
  72 .PP
  73 \fB\-\-m\fR
  74 .RS 4
  75 Modify existing entry in the disklist file\.
  76 .sp
  77 Note: if disklist file has been modified manually, this option might not work\.
  78 .RE
  79 .PP
  80 \fB\-\-dumptype dumptype\fR
  81 .RS 4
  82 dumptype to use\. Dumptype must be defined in /etc/amanda/template\.d/dumptypes or /etc/amanda/$config/amanda\.conf file\. Default: [user\-tar]
  83 .RE
  84 .PP
  85 \fB\-\-user string\fR
  86 .RS 4
  87 name of user using
  88 \fBamrecover\fR
  89 on the client, default is root\.
  90 .RE
  91 .PP
  92 \fB\-\-auth string\fR
  93 .RS 4
  94 authentication method to use when running
  95 \fBamrecover\fR
  96 from the client , default is bsdtcp\.
  97 .RE
  98 .PP
  99 \fB\-\-gnutar_list_dir string\fR
 100 .RS 4
 101 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\.
 102 .RE
 103 .PP
 104 \fB\-\-amandates string\fR
 105 .RS 4
 106 file where amanda keep the date of each dumplevel on the client, default is /etc/amandates\.
 107 .RE
 108 .PP
 109 \fB\-\-batch\fR
 110 .RS 4
 111 Turn on batch mode when copying files to the client, default is off
 112 .RE
 113 .PP
 114 \fB\-\-no\-client\-update\fR
 115 .RS 4
 116 If this option is set,
 117 \fBamaddclient\fR
 118 will not attempt to update/create \.amandahosts, amanda\-client\.conf and gnutar\-lists file on the client\.
 119 .RE
 120 .PP
 121 \fB\-\-help\fR
 122 .RS 4
 123 Display usage\.
 124 .RE
 125 .PP
 126 .RS 4
 127
 128 If any of the following four options are used,  \fBamaddclient\fR will extend the dumptype definition to an in\-line definition in the disklist file\. See \fBamanda\fR(8) DISKLIST FILE section for detail\.
 129 .RE
 130 .PP
 131 \fB\-\-includefile string\fR
 132 .RS 4
 133 string is a glob expression
 134 .RE
 135 .PP
 136 \fB\-\-includelist string\fR
 137 .RS 4
 138 string is a file name on the client containing glob expressions\. Specify either \-\-includefile or \-\-includelist\.
 139 .RE
 140 .PP
 141 \fB\-\-excludefile string\fR
 142 .RS 4
 143 string is a glob expression
 144 .RE
 145 .PP
 146 \fB\-\-excludelist string\fR
 147 .RS 4
 148 string is a file name on the client containing glob expressions\. Specify either \-\-excludefile or \-\-excludelist\.
 149 .RE
 150 .SH "FILES"
 151 .PP
 152 \fB/var/lib/amanda/template\.d\fR
 153 .RS 4
 154 Amanda configuration template files install location
 155 .RE
 156 .PP
 157 \fB/var/lib/amanda\fR
 158 .RS 4
 159 amandabackup home directory
 160 .RE
 161 .PP
 162 \fB/var/lib/amanda/\.amandahosts\fR
 163 .RS 4
 164 \fIAmanda\fR
 165 authentication file\.
 166 .RE
 167 .PP
 168 \fB/var/lib/amanda/gnutar\-lists\fR
 169 .RS 4
 170 A directory which contains backup timestamp and list of files backed up\.
 171 .RE
 172 .PP
 173 \fB/etc/amanda/$config\fR
 174 .RS 4
 175 \fIAmanda\fR
 176 configuration files location for $config(e\.g: DailySet1)\.
 177 .RE
 178 .PP
 179 \fB/etc/amanda/template\.d\fR
 180 .RS 4
 181 A directory contains dumptypes and tapetypes files used by all
 182 \fIAmanda\fR
 183 configurations\.
 184 .RE
 185 .PP
 186 \fB/etc/amandates\fR
 187 .RS 4
 188 \fIAmanda\fR
 189 file on the client\. It keeps track of structures of previous dumps\.
 190 .RE
 191 .PP
 192 \fB/tmp/amanda\fR
 193 .RS 4
 194 directory contains
 195 \fIAmanda\fR
 196 debug log files\.
 197 .RE
 198 .SH "RETURN VALUE"
 199
 200 On success, zero is returned\.  On error, 1 is returned\.
 201 .SH "AUTHOR"
 202 .PP
 203 The tool and its documentation was written by Zmanda, Inc (http://www\.zmanda\.com/)\.
 204 .SH "SEE ALSO"
 205 .PP
 206 \fBamanda\fR(8),
 207 \fBamanda.conf\fR(5),
 208 \fBamserverconfig\fR(8)
 209 \fBssh-keygen\fR(1)
 210 \fBssh-add\fR(1)
 211 \fBscp\fR(1)
 212 \fI\%http://wiki.zmanda.com\fR