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

   1
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amaddclient.8'>
  11 <refmeta>
  12 <refentrytitle>amaddclient</refentrytitle>
  13 <manvolnum>8</manvolnum>
  14 </refmeta>
  15 <refnamediv>
  16 <refname>amaddclient</refname>
  17 <refpurpose>program to add client to an existing &A; configuration</refpurpose>
  18 </refnamediv>
  19 <!-- body begins here -->
  20 <refsynopsisdiv>
  21 <cmdsynopsis>
  22   <command>amaddclient</command>
  23 <arg choice='plain'>--config </arg>
  24 <arg choice='plain'><replaceable>config</replaceable></arg> ||
  25 <arg choice='plain'>--client </arg><arg
  26     choice='plain'><replaceable>client name</replaceable></arg> ||
  27 <arg choice='plain'>--diskdev </arg><arg
  28     choice='plain'><replaceable>directory to backup</replaceable></arg>
  29 <arg choice='opt'>--m </arg>
  30 <arg choice='opt'>--dumptype <replaceable>string</replaceable></arg>
  31 <arg choice='opt'>--includefile <replaceable>string</replaceable></arg>
  32 <arg choice='opt'>--includelist <replaceable>string</replaceable></arg>
  33 <arg choice='opt'>--excludefile <replaceable>string</replaceable></arg>
  34 <arg choice='opt'>--excludelist <replaceable>string</replaceable></arg>
  35 <arg choice='opt'>--user <replaceable>string</replaceable></arg>
  36 <arg choice='opt'>--auth <replaceable>string</replaceable></arg>
  37 <arg choice='opt'>--gnutar_list_dir <replaceable>string</replaceable></arg>
  38 <arg choice='opt'>--amandates <replaceable>string</replaceable></arg>
  39 <arg choice='opt'>--no-client-update </arg>
  40 <arg choice='opt'>--batch </arg>
  41 <arg choice='opt'>--help </arg>
  42 </cmdsynopsis>
  43 </refsynopsisdiv>
  44
  45 <refsect1><title>DESCRIPTION</title>
  46 <para>After Amanda rpms are successfully installed and
  47 &amserverconfig; is run,
  48           &amaddclient; will add client to the  &A; configuration.
  49 &amaddclient; create or update &A; disklist file and create or update
  50 /var/lib/amanda/.amandahosts file on the server.</para>
  51 <para> If --no-client-update is not specified,
  52 &amaddclient; will attempt to update or create /var/lib/amanda/.amandahost,
  53 amanda-client.conf and gnutar-lists on
  54 the client.
  55 (See <refentrytitle>ssh-keygen</refentrytitle><manvolnum>1</manvolnum> and
  56 <refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum> for detail.)</para>
  57 <para>
  58 &amaddclient; must be run by user amandabackup.</para>
  59 <para> --config, --client and --diskdev must be specified.
  60 </para>
  61 </refsect1>
  62
  63
  64 <refsect1><title>Options</title>
  65 <variablelist remap='TP'>
  66  <varlistentry>
  67 Options may be abbreviated, as long as the abbreviation is not ambiguous. Option argument can either separated by '=' or a space.
  68 Example: --conf=v253, --client client8.zmanda.com
  69 </varlistentry>
  70
  71
  72   <varlistentry>
  73   <term><option>--config config</option></term>
  74   <listitem>
  75 <para>&A; configuration which this program will add the client to.  </para>
  76   </listitem>
  77   </varlistentry>
  78
  79   <varlistentry>
  80   <term><option>--client client</option></term>
  81   <listitem>
  82 <para>The name of the client machine to add. FQDN name recommended. </para>
  83   </listitem>
  84   </varlistentry>
  85
  86   <varlistentry>
  87   <term><option>--diskdev diskdev</option></term>
  88   <listitem>
  89 <para>Directory for this &A; configuration to backup.</para>
  90   </listitem>
  91   </varlistentry>
  92
  93
  94   <varlistentry>
  95   <term><option>--m</option></term>
  96   <listitem>
  97 <para>Modify existing entry in the disklist file.</para>
  98 <para>Note: if disklist file has been modified manually, this option might not work.</para>
  99   </listitem>
 100   </varlistentry>
 101
 102
 103   <varlistentry>
 104   <term><option>--dumptype dumptype</option></term>
 105   <listitem>
 106 <para>dumptype to use. Dumptype must be defined in
 107 /etc/amanda/template.d/dumptypes or /etc/amanda/$config/amanda.conf file.  Default: [user-tar]</para>
 108   </listitem>
 109   </varlistentry>
 110
 111   <varlistentry>
 112   <term><option>--user string</option></term>
 113   <listitem>
 114 <para> name of user using &amrecover; on the client, default is root.</para>
 115   </listitem>
 116   </varlistentry>
 117
 118   <varlistentry>
 119   <term><option>--auth string</option></term>
 120   <listitem>
 121 <para> authentication method to use when running &amrecover; from the client , default is bsdtcp.</para>
 122   </listitem>
 123   </varlistentry>
 124
 125   <varlistentry>
 126   <term><option>--gnutar_list_dir string</option></term>
 127   <listitem>
 128 <para> directory where gnutar keep its state file on the client. Absolute path
 129 required. Default is /var/lib/amanda/gnutar-lists. If --no-client-update is not
 130 set, this program will attempt to create the directory on the client. </para>
 131   </listitem>
 132   </varlistentry>
 133
 134   <varlistentry>
 135   <term><option>--amandates string</option></term>
 136   <listitem>
 137 <para> file where amanda keep the date of each dumplevel on the client, default is /etc/amandates.</para>
 138   </listitem>
 139   </varlistentry>
 140
 141   <varlistentry>
 142   <term><option>--batch</option></term>
 143   <listitem>
 144 <para>Turn on batch mode when copying files to the client, default is off</para>
 145   </listitem>
 146   </varlistentry>
 147
 148 <varlistentry>
 149   <term><option>--no-client-update</option></term>
 150   <listitem>
 151 <para>If this option is set,  &amaddclient; will not attempt to update/create
 152 .amandahosts, amanda-client.conf and gnutar-lists file on the client.</para>
 153   </listitem>
 154   </varlistentry>
 155
 156
 157   <varlistentry>
 158   <term><option>--help</option></term>
 159   <listitem>
 160 <para>Display usage. </para>
 161   </listitem>
 162   </varlistentry>
 163
 164 <varlistentry>
 165 If any of the following four options are used, &amaddclient; will extend the dumptype definition to an in-line definition in the disklist file. See <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry> DISKLIST FILE section for detail.
 166 </varlistentry>
 167
 168   <varlistentry>
 169   <term><option>--includefile string</option></term>
 170   <listitem>
 171 <para>string is a glob expression  </para>
 172   </listitem>
 173   </varlistentry>
 174
 175   <varlistentry>
 176   <term><option>--includelist string</option></term>
 177   <listitem>
 178 <para> string is a file name on the client containing glob expressions.
 179 Specify either --includefile or --includelist. </para>
 180   </listitem>
 181   </varlistentry>
 182
 183   <varlistentry>
 184   <term><option>--excludefile string</option></term>
 185   <listitem>
 186 <para>string is a glob expression  </para>
 187   </listitem>
 188   </varlistentry>
 189
 190   <varlistentry>
 191   <term><option>--excludelist string</option></term>
 192   <listitem>
 193 <para> string is a file name on the client containing glob expressions.
 194 Specify either --excludefile or --excludelist. </para>
 195   </listitem>
 196   </varlistentry>
 197
 198
 199
 200 </variablelist>
 201 </refsect1>
 202
 203 <refsect1><title>Files</title>
 204 <variablelist remap='TP'>
 205  <varlistentry>
 206  <term><option>/var/lib/amanda/template.d</option></term>
 207   <listitem>
 208 <para>Amanda configuration template files install location</para>
 209   </listitem>
 210   </varlistentry>
 211
 212  <varlistentry>
 213  <term><option>/var/lib/amanda</option></term>
 214   <listitem>
 215 <para>amandabackup home directory</para>
 216   </listitem>
 217   </varlistentry>
 218
 219  <varlistentry>
 220  <term><option>/var/lib/amanda/.amandahosts</option></term>
 221   <listitem>
 222 <para>&A; authentication file.</para>
 223   </listitem>
 224   </varlistentry>
 225
 226  <varlistentry>
 227  <term><option>/var/lib/amanda/gnutar-lists</option></term>
 228   <listitem>
 229 <para>A directory which contains backup timestamp and list of files backed up.</para>
 230   </listitem>
 231   </varlistentry>
 232
 233  <varlistentry>
 234  <term><option>/etc/amanda/$config</option></term>
 235   <listitem>
 236 <para>&A; configuration files location for $config(e.g: DailySet1).</para>
 237   </listitem>
 238   </varlistentry>
 239
 240  <varlistentry>
 241  <term><option>/etc/amanda/template.d</option></term>
 242   <listitem>
 243 <para>A directory contains dumptypes and tapetypes files used by all &A; configurations.</para>
 244   </listitem>
 245   </varlistentry>
 246
 247
 248  <varlistentry>
 249  <term><option>/etc/amandates</option></term>
 250   <listitem>
 251 <para>&A; file on the client. It keeps track of structures of previous dumps.</para>
 252   </listitem>
 253   </varlistentry>
 254
 255  <varlistentry>
 256  <term><option>/tmp/amanda</option></term>
 257   <listitem>
 258 <para>directory contains &A; debug log files.</para>
 259   </listitem>
 260   </varlistentry>
 261
 262 </variablelist>
 263 </refsect1>
 264
 265 <refsect1><title>RETURN VALUE</title>
 266 On success, zero is returned.  On error, 1 is returned.
 267 </refsect1>
 268
 269 <refsect1><title>AUTHOR</title>
 270   <para>
 271     The tool and its documentation was written by Zmanda, Inc (http://www.zmanda.com/).
 272   </para>
 273 </refsect1>
 274
 275 <refsect1><title>SEE ALSO</title>
 276 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 277 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 278 <citerefentry><refentrytitle>amserverconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 279 <citerefentry><refentrytitle>ssh-keygen</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 280 <citerefentry><refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 281 <citerefentry><refentrytitle>scp</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 282 <ulink url="http://wiki.zmanda.com"/>
 283 </para>
 284 </refsect1>
 285 </refentry>
 286