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

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