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