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"
4 <!-- entities files to use -->
5 <!ENTITY % global_entities SYSTEM 'global.entities'>
9 <refentry id='amaddclient.8'>
11 <refentrytitle>amaddclient</refentrytitle>
12 <manvolnum>8</manvolnum>
18 <refname>amaddclient</refname>
19 <refpurpose>program to add client to an existing Amanda configuration</refpurpose>
24 <!-- body begins here -->
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>
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
61 (See <refentrytitle>ssh-keygen</refentrytitle><manvolnum>1</manvolnum> and
62 <refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum> for detail.)</para>
64 &amaddclient; must be run by user amandabackup.</para>
65 <para> --config, --client and --diskdev must be specified.
70 <refsect1><title>Options</title>
71 <variablelist remap='TP'>
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
79 <term><option>--config config</option></term>
81 <para>Amanda configuration which this program will add the client to. </para>
86 <term><option>--client client</option></term>
88 <para>The name of the client machine to add. FQDN name recommended. </para>
93 <term><option>--diskdev diskdev</option></term>
95 <para>Directory for this Amanda configuration to backup.</para>
101 <term><option>--m</option></term>
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>
110 <term><option>--dumptype dumptype</option></term>
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>
118 <term><option>--user string</option></term>
120 <para> name of user using &amrecover; on the client, default is root.</para>
125 <term><option>--auth string</option></term>
127 <para> authentication method to use when running &amrecover; from the client , default is bsdtcp.</para>
132 <term><option>--gnutar_list_dir string</option></term>
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>
141 <term><option>--amandates string</option></term>
143 <para> file where amanda keep the date of each dumplevel on the client, default is /etc/amandates.</para>
148 <term><option>--batch</option></term>
150 <para>Turn on batch mode when copying files to the client, default is off</para>
155 <term><option>--no-client-update</option></term>
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>
164 <term><option>--help</option></term>
166 <para>Display usage. </para>
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.
175 <term><option>--includefile string</option></term>
177 <para>string is a glob expression </para>
182 <term><option>--includelist string</option></term>
184 <para> string is a file name on the client containing glob expressions.
185 Specify either --includefile or --includelist. </para>
190 <term><option>--excludefile string</option></term>
192 <para>string is a glob expression </para>
197 <term><option>--excludelist string</option></term>
199 <para> string is a file name on the client containing glob expressions.
200 Specify either --excludefile or --excludelist. </para>
209 <refsect1><title>Files</title>
210 <variablelist remap='TP'>
212 <term><option>/var/lib/amanda/template.d</option></term>
214 <para>Amanda configuration template files install location</para>
219 <term><option>/var/lib/amanda</option></term>
221 <para>amandabackup home directory</para>
226 <term><option>/var/lib/amanda/.amandahosts</option></term>
228 <para>Amanda authentication file.</para>
233 <term><option>/var/lib/amanda/gnutar-lists</option></term>
235 <para>A directory which contains backup timestamp and list of files backed up.</para>
240 <term><option>/etc/amanda/$config</option></term>
242 <para>Amanda configuration files location for $config(e.g: DailySet1).</para>
247 <term><option>/etc/amanda/template.d</option></term>
249 <para>A directory contains dumptypes and tapetypes files used by all Amanda configurations.</para>
255 <term><option>/etc/amandates</option></term>
257 <para>Amanda file on the client. It keeps track of structures of previous dumps.</para>
262 <term><option>/tmp/amanda</option></term>
264 <para>directory contains Amanda debug log files.</para>
271 <refsect1><title>RETURN VALUE</title>
272 On success, zero is returned. On error, 1 is returned.
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"/>