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

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