git.gag.com Git - debian/amanda/blob - man/xml-source/amanda-client.conf.5.xml

   1 <?xml version="1.0" encoding="ISO-8859-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='amanda-client.conf.5'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda-client.conf</refentrytitle>
  14 <manvolnum>5</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.5;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amanda-client.conf</refname>
  21 <refpurpose>Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jds;
  25 &author.sgw.xml;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28
  29 <refsect1><title>DESCRIPTION</title>
  30 <para>&amclientconf; is the client configuration file for &A;. This manpage lists the
  31 relevant sections and parameters of this file for quick reference.</para>
  32 <para> The files <emphasis remap='B'>&lt;CONFIG_DIR&gt;/amanda-client.conf</emphasis> and <emphasis remap='B'>&lt;CONFIG_DIR&gt;/&lt;config&gt;/amanda-client.conf</emphasis> are loaded.</para>
  33 </refsect1>
  34
  35 <refsect1><title>SYNTAX</title>
  36
  37 The syntax of &amclientconf; is identical to that for
  38 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  39
  40 </refsect1>
  41
  42 <refsect1>
  43 <title>GLOBAL PARAMETERS</title>
  44
  45 <variablelist remap='TP'>
  46   <varlistentry>
  47   <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
  48   <listitem>
  49 <para>Default:
  50 <emphasis remap='I'>Set by configure</emphasis>.
  51 The conf use by amrecover.</para>
  52   </listitem>
  53   </varlistentry>
  54
  55   <varlistentry>
  56   <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
  57   <listitem>
  58 <para>Default:
  59 <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
  60 Similar to the parameter of the same name in &amconf;, this specifies the username that
  61 &amrecover; should send when connecting to the server.  It should match the username
  62 specified in &amandahosts; on the server.</para>
  63   </listitem>
  64   </varlistentry>
  65
  66   <varlistentry>
  67   <term><emphasis remap='B'>index_server</emphasis> <emphasis remap='I'> string</emphasis></term>
  68   <listitem>
  69 <para>Default:
  70 <emphasis remap='I'>Set by configure</emphasis>.
  71 The amindexd server amrecover will connect to.</para>
  72   </listitem>
  73   </varlistentry>
  74
  75   <varlistentry>
  76   <term><emphasis remap='B'>tape_server</emphasis> <emphasis remap='I'> string</emphasis></term>
  77   <listitem>
  78 <para>Default:
  79 <emphasis remap='I'>Set by configure</emphasis>.
  80 The amidxtaped server amrecover will connect to.</para>
  81   </listitem>
  82   </varlistentry>
  83
  84   <varlistentry>
  85   <term><emphasis remap='B'>tapedev</emphasis> <emphasis remap='I'> string</emphasis></term>
  86   <listitem>
  87 <para>Default:
  88 <emphasis remap='I'>Set by configure</emphasis>.
  89 The tapedev amrecover will use.</para>
  90   </listitem>
  91   </varlistentry>
  92
  93   <varlistentry>
  94   <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
  95   <listitem>
  96 <para>Default:
  97 <emphasis remap='I'>bsd</emphasis>.
  98 Type of authorization to perform between tape server and backup client hosts.</para>
  99 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
 100 connection and one tcp connection by data stream.</para>
 101 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
 102 one tcp connection.</para>
 103 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
 104 tcp connection for all data stream.</para>
 105 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
 106 authorization.</para>
 107 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
 108 authorization.</para>
 109 <para><emphasis remap='B'>local</emphasis>, if the client is the server, it
 110 doesn't require authencation setup.</para>
 111 <para><emphasis remap='B'>rsh</emphasis> to use rsh
 112 authorization.</para>
 113 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
 114 authorization.</para>
 115
 116   </listitem>
 117   </varlistentry>
 118
 119   <varlistentry>
 120   <term><emphasis remap='B'>ssh_keys</emphasis> <emphasis remap='I'> string</emphasis></term>
 121   <listitem>
 122 <para>Default:
 123 <emphasis remap='I'>No default</emphasis>.
 124 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the default ssh key will be used.</para>
 125   </listitem>
 126   </varlistentry>
 127
 128   <varlistentry>
 129   <term><emphasis remap='B'>gnutar_list_dir</emphasis> <emphasis remap='I'> string</emphasis></term>
 130   <listitem>
 131 <para>Default from configure
 132 <emphasis remap='I'>--with-gnutar-listdir=DIR</emphasis>.
 133 The directory where gnutar keep its state file.</para>
 134   </listitem>
 135   </varlistentry>
 136
 137   <varlistentry>
 138   <term><emphasis remap='B'>mailer</emphasis> <emphasis remap='I'> string</emphasis></term>
 139   <listitem>
 140 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user &lt; message_file</emphasis>'.</para>
 141   </listitem>
 142   </varlistentry>
 143
 144   <varlistentry>
 145   <term><emphasis remap='B'>amandates</emphasis> <emphasis remap='I'> string</emphasis></term>
 146   <listitem>
 147 <para>Default:
 148 <emphasis remap='I'>/etc/amandates</emphasis>.
 149 The file where amanda keep the last date of each dumplevel.</para>
 150   </listitem>
 151   </varlistentry>
 152
 153   <varlistentry>
 154   <term><emphasis remap='B'>connect_tries</emphasis> int</term>
 155   <listitem>
 156 <para>Default:
 157 <emphasis remap='I'>3</emphasis>.
 158 How many times the server will try a connection.</para>
 159   </listitem>
 160   </varlistentry>
 161
 162   <varlistentry>
 163   <term><emphasis remap='B'>rep_tries</emphasis> int</term>
 164   <listitem>
 165 <para>Default:
 166 <emphasis remap='I'>5</emphasis>.
 167 How many times amandad will resend a REP packet if it doesn't get the ACK packet.</para>
 168   </listitem>
 169   </varlistentry>
 170
 171   <varlistentry>
 172   <term><emphasis remap='B'>debug_amandad</emphasis> int</term>
 173   <listitem>
 174 <para>Default:
 175 <emphasis remap='I'>0</emphasis>.
 176 Debug level of the amandad process</para>
 177   </listitem>
 178   </varlistentry>
 179
 180   <varlistentry>
 181   <term><emphasis remap='B'>debug_amidxtaped</emphasis> int</term>
 182   <listitem>
 183 <para>Default:
 184 <emphasis remap='I'>0</emphasis>.
 185 Debug level of the amidxtaped process</para>
 186   </listitem>
 187   </varlistentry>
 188
 189   <varlistentry>
 190   <term><emphasis remap='B'>debug_amindexd</emphasis> int</term>
 191   <listitem>
 192 <para>Default:
 193 <emphasis remap='I'>0</emphasis>.
 194 Debug level of the amindexd process</para>
 195   </listitem>
 196   </varlistentry>
 197
 198   <varlistentry>
 199   <term><emphasis remap='B'>debug_amrecover</emphasis> int</term>
 200   <listitem>
 201 <para>Default:
 202 <emphasis remap='I'>0</emphasis>.
 203 Debug level of the amrecover process</para>
 204   </listitem>
 205   </varlistentry>
 206
 207   <varlistentry>
 208   <term><emphasis remap='B'>debug_auth</emphasis> int</term>
 209   <listitem>
 210 <para>Default:
 211 <emphasis remap='I'>0</emphasis>.
 212 Debug level of the auth module</para>
 213   </listitem>
 214   </varlistentry>
 215
 216   <varlistentry>
 217   <term><emphasis remap='B'>debug_event</emphasis> int</term>
 218   <listitem>
 219 <para>Default:
 220 <emphasis remap='I'>0</emphasis>.
 221 Debug level of the event module</para>
 222   </listitem>
 223   </varlistentry>
 224
 225   <varlistentry>
 226   <term><emphasis remap='B'>debug_holding</emphasis> int</term>
 227   <listitem>
 228 <para>Default:
 229 <emphasis remap='I'>0</emphasis>.
 230 Debug level of the holdingdisk module</para>
 231   </listitem>
 232   </varlistentry>
 233
 234   <varlistentry>
 235   <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
 236   <listitem>
 237 <para>Default:
 238 <emphasis remap='I'>0</emphasis>.
 239 Debug level of the protocol module</para>
 240   </listitem>
 241   </varlistentry>
 242
 243   <varlistentry>
 244   <term><emphasis remap='B'>debug_selfcheck</emphasis> int</term>
 245   <listitem>
 246 <para>Default:
 247 <emphasis remap='I'>0</emphasis>.
 248 Debug level of the selfcheck process</para>
 249   </listitem>
 250   </varlistentry>
 251
 252   <varlistentry>
 253   <term><emphasis remap='B'>debug_sendsize</emphasis> int</term>
 254   <listitem>
 255 <para>Default:
 256 <emphasis remap='I'>0</emphasis>.
 257 Debug level of the sendsize process</para>
 258   </listitem>
 259   </varlistentry>
 260
 261   <varlistentry>
 262   <term><emphasis remap='B'>debug_sendbackup</emphasis> int</term>
 263   <listitem>
 264 <para>Default:
 265 <emphasis remap='I'>0</emphasis>.
 266 Debug level of the sendbackup process</para>
 267   </listitem>
 268   </varlistentry>
 269
 270   <varlistentry>
 271   <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
 272   <listitem>
 273 <para>Default: --with-udpportrange or
 274 <emphasis remap='I'>512,1023</emphasis>.
 275 Reserved udp port that will be used (amrecover with bsd or bsdudp)</para>
 276   </listitem>
 277   </varlistentry>
 278
 279   <varlistentry>
 280   <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
 281   <listitem>
 282 <para>Default: --with-low-tcpportrange or
 283 <emphasis remap='I'>512,1023</emphasis>.
 284 Reserved tcp port that will be used (amrecover with bsdtcp)</para>
 285   </listitem>
 286   </varlistentry>
 287
 288   <varlistentry>
 289   <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
 290   <listitem>
 291 <para>Default: --with-tcpportrange or
 292 <emphasis remap='I'>1025,65536</emphasis>.
 293 Unreserved tcp port that will be used (bsd, bsdudp)</para>
 294   </listitem>
 295   </varlistentry>
 296
 297   <varlistentry>
 298   <term><emphasis remap='B'>property</emphasis> "name" "value"</term>
 299   <listitem>
 300 <para>Adds a global property for this client host, useful for e.g., Application API plugins.</para>
 301   </listitem>
 302   </varlistentry>
 303
 304 </variablelist>
 305 </refsect1>
 306
 307 <refsect1><title>APPLICATION SECTION</title>
 308 <para>The
 309 <emphasis remap='B'>amanda.conf</emphasis>
 310 file may define multiple types of application.
 311 The information is entered in a <emphasis remap='B'>application-tool</emphasis>
 312 section, which looks like this:</para>
 313
 314 <programlisting>
 315 define application-tool "<emphasis remap='I'>name</emphasis>" {
 316     <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>appli
 317 cation-value</emphasis>
 318     <literal>...</literal>
 319 }
 320 </programlisting>
 321
 322 <para><emphasis remap='I'>name</emphasis>
 323 is the name of this type of application. It is referenced from the
 324 <emphasis remap='I'>dumptype</emphasis></para>
 325
 326 <para>The application-tool options and values are:</para>
 327 <variablelist remap='TP'>
 328   <varlistentry>
 329   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
 330   <listitem>
 331 <para>Default:
 332 <emphasis remap='I'>none</emphasis>.
 333 A comment string describing this application.</para>
 334   </listitem>
 335   </varlistentry>
 336   <varlistentry>
 337   <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
 338   <listitem>
 339 <para>No default. Must be set to the name of the program. This program must be
 340 in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory
 341 on the client.</para>
 342   </listitem>
 343   </varlistentry>
 344   <varlistentry>
 345   <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
 346   <listitem>
 347 <para>No default. You can set property for the application, each application have a different set of property. Both strings are quoted; the first string contains the name of
 348 the property to set, and the others contains its values.
 349 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
 350 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
 351 </para>
 352   </listitem>
 353   </varlistentry>
 354 </variablelist>
 355 </refsect1>
 356
 357 <refsect1><title>SCRIPT SECTION</title>
 358 <para>The
 359 <emphasis remap='B'>amanda.conf</emphasis>
 360 file may define multiple types of script.
 361 The information is entered in a <emphasis remap='B'>script-tool</emphasis>
 362 section, which looks like this:</para>
 363
 364 <programlisting>
 365 define script-tool "<emphasis remap='I'>name</emphasis>" {
 366     <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
 367     <literal>...</literal>
 368 }
 369 </programlisting>
 370
 371 <para><emphasis remap='I'>name</emphasis>
 372 is the name of this type of script. It is referenced from the
 373 <emphasis remap='I'>dumptype</emphasis></para>
 374
 375 <para>The script-tool options and values are:</para>
 376 <variablelist remap='TP'>
 377   <varlistentry>
 378   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
 379   <listitem>
 380 <para>Default:
 381 <emphasis remap='I'>none</emphasis>.
 382 A comment string describing this script.</para>
 383   </listitem>
 384   </varlistentry>
 385   <varlistentry>
 386   <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
 387   <listitem>
 388 <para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libdir/amanda/application</emphasis> directory on the client and/or server.</para>
 389   </listitem>
 390   </varlistentry>
 391   <varlistentry>
 392   <term><emphasis remap='B'>execute_where</emphasis> [client|server]</term>
 393   <listitem>
 394 <para>Default: <emphasis remap='I'>client</emphasis>. Where the script must be executed, on the client or server. Only <emphasis remap='I'>client</emphasis> is valid.</para>
 395   </listitem>
 396   </varlistentry>
 397   <varlistentry>
 398   <term><emphasis remap='B'>execute_on</emphasis> <emphasis remap='I'>execute_on</emphasis>[,<emphasis remap='I'>execute_on</emphasis>]*</term>
 399   <listitem>
 400 <para>No default. When the script must be executed, you can specify many of them:</para>
 401     <!-- .RS -->
 402     <variablelist remap='TP'>
 403       <varlistentry>
 404       <term><emphasis remap='B'>pre-dle-amcheck</emphasis></term>
 405       <listitem>
 406 <para>Execute before the amcheck command for the dle.</para>
 407       </listitem>
 408       </varlistentry>
 409       <varlistentry>
 410       <term><emphasis remap='B'>pre-host-amcheck</emphasis></term>
 411       <listitem>
 412 <para>Execute before the amcheck command for all dle for the client.</para>
 413       </listitem>
 414       </varlistentry>
 415       <varlistentry>
 416       <term><emphasis remap='B'>post-dle-amcheck</emphasis></term>
 417       <listitem>
 418 <para>Execute after the amcheck command for the dle.</para>
 419       </listitem>
 420       </varlistentry>
 421       <varlistentry>
 422       <term><emphasis remap='B'>post-host-amcheck</emphasis></term>
 423       <listitem>
 424 <para>Execute after the amcheck command for all dle for the client.</para>
 425       </listitem>
 426       </varlistentry>
 427       <varlistentry>
 428       <term><emphasis remap='B'>pre-dle-estimate</emphasis></term>
 429       <listitem>
 430 <para>Execute before the estimate command for the dle.</para>
 431       </listitem>
 432       </varlistentry>
 433       <varlistentry>
 434       <term><emphasis remap='B'>pre-host-estimate</emphasis></term>
 435       <listitem>
 436 <para>Execute before the estimate command for all dle for the client.</para>
 437       </listitem>
 438       </varlistentry>
 439       <varlistentry>
 440       <term><emphasis remap='B'>post-dle-estimate</emphasis></term>
 441       <listitem>
 442 <para>Execute after the estimate command for the dle.</para>
 443       </listitem>
 444       </varlistentry>
 445       <varlistentry>
 446       <term><emphasis remap='B'>post-host-estimate</emphasis></term>
 447       <listitem>
 448 <para>Execute after the estimate command for all dle for the client.</para>
 449       </listitem>
 450       </varlistentry>
 451       <varlistentry>
 452       <term><emphasis remap='B'>pre-dle-backup</emphasis></term>
 453       <listitem>
 454 <para>Execute before the backup command for the dle.</para>
 455       </listitem>
 456       </varlistentry>
 457       <varlistentry>
 458       <term><emphasis remap='B'>pre-host-backup</emphasis></term>
 459       <listitem>
 460 <para>Execute before the backup command for all dle for the client.</para>
 461       </listitem>
 462       </varlistentry>
 463       <varlistentry>
 464       <term><emphasis remap='B'>post-dle-backup</emphasis></term>
 465       <listitem>
 466 <para>Execute after the backup command for the dle.</para>
 467       </listitem>
 468       </varlistentry>
 469       <varlistentry>
 470       <term><emphasis remap='B'>post-host-backup</emphasis></term>
 471       <listitem>
 472 <para>Execute after the backup command for all dle for the client.</para>
 473       </listitem>
 474       </varlistentry>
 475       <varlistentry>
 476       <term><emphasis remap='B'>pre-recover</emphasis></term>
 477       <listitem>
 478 <para>Execute before any level is recovered.</para>
 479       </listitem>
 480       </varlistentry>
 481       <varlistentry>
 482       <term><emphasis remap='B'>post-recover</emphasis></term>
 483       <listitem>
 484 <para>Execute after all levels are recovered.</para>
 485       </listitem>
 486       </varlistentry>
 487       <varlistentry>
 488       <term><emphasis remap='B'>pre-level-recover</emphasis></term>
 489       <listitem>
 490 <para>Execute before each level recovery.</para>
 491       </listitem>
 492       </varlistentry>
 493       <varlistentry>
 494       <term><emphasis remap='B'>post-level-recover</emphasis></term>
 495       <listitem>
 496 <para>Execute after each level recovery.</para>
 497       </listitem>
 498       </varlistentry>
 499       <varlistentry>
 500       <term><emphasis remap='B'>inter-level-recover</emphasis></term>
 501       <listitem>
 502 <para>Execute between two levels of recovery.</para>
 503       </listitem>
 504       </varlistentry>
 505     </variablelist>
 506   </listitem>
 507   </varlistentry>
 508   <varlistentry>
 509   <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
 510   <listitem>
 511 <para>No default. You can set property for the script, each script have a different set of property. Both strings are quoted; the first string contains the name of
 512 the property to set, and the others contains its values.
 513 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
 514 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
 515 </para>
 516   </listitem>
 517   </varlistentry>
 518 </variablelist>
 519 </refsect1>
 520
 521 <refsect1><title>SEE ALSO</title>
 522 <para>
 523 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 524 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 525 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 526 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 527 <ulink url="http://wiki.zmanda.com"/>
 528 </para>
 529 </refsect1>
 530 </refentry>
 531