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 '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 Amanda, 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 Amanda. 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 <manref name="amanda.conf" vol="5"/>.
  39
  40 </refsect1>
  41
  42 <refsect1>
  43 <title>GLOBAL PARAMETERS</title>
  44
  45 <variablelist remap='TP'>
  46   <varlistentry>
  47   <term><amkeyword>conf</amkeyword> <amtype>string</amtype></term>
  48   <listitem>
  49 <para>Default:
  50 <amdefault>Set by configure</amdefault>.
  51 The conf use by amrecover.</para>
  52   </listitem>
  53   </varlistentry>
  54
  55   <varlistentry>
  56   <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
  57   <listitem>
  58 <para>Default:
  59 <amdefault>CLIENT_LOGIN</amdefault>.
  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><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
  68   <listitem>
  69 <para>Default:
  70 <amdefault>"amanda"</amdefault>.
  71 Similar to the parameter of the same name in &amconf;, this specifies the port to connect on the server. It can be a service name or a numeric port number.</para>
  72   </listitem>
  73   </varlistentry>
  74
  75   <varlistentry>
  76   <term><amkeyword>index-server</amkeyword> <amtype>string</amtype></term>
  77   <listitem>
  78 <para>Default:
  79 <amdefault>Set by configure</amdefault>.
  80 The amindexd server amrecover will connect to.</para>
  81   </listitem>
  82   </varlistentry>
  83
  84   <varlistentry>
  85   <term><amkeyword>tape-server</amkeyword> <amtype>string</amtype></term>
  86   <listitem>
  87 <para>Default:
  88 <amdefault>Set by configure</amdefault>.
  89 The amidxtaped server amrecover will connect to.</para>
  90   </listitem>
  91   </varlistentry>
  92
  93   <varlistentry>
  94   <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
  95   <listitem>
  96 <para>Default:
  97 <amdefault>Set by configure</amdefault>.
  98 The tapedev amrecover will use.</para>
  99   </listitem>
 100   </varlistentry>
 101
 102   <varlistentry>
 103   <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
 104   <listitem>
 105 <para>Default:
 106 <amkeyword>"bsdtcp"</amkeyword>.
 107 Type of authorization to perform between tape server and backup client hosts.</para>
 108 <para><amkeyword>"bsd"</amkeyword>, bsd authorization with udp initial
 109 connection and one tcp connection by data stream.</para>
 110 <para><amkeyword>"bsdtcp"</amkeyword>, bsd authorization but use only
 111 one tcp connection.</para>
 112 <para><amkeyword>"bsdudp"</amkeyword>, like bsd, but will use only one
 113 tcp connection for all data stream.</para>
 114 <para><amkeyword>"krb5"</amkeyword> to use Kerberos-V
 115 authorization.</para>
 116 <para><amkeyword>"local"</amkeyword>, if the client is the server, it
 117 doesn't require authencation setup.</para>
 118 <para><amkeyword>"rsh"</amkeyword> to use rsh
 119 authorization.</para>
 120 <para><amkeyword>"ssh"</amkeyword> to use OpenSSH
 121 authorization.</para>
 122
 123   </listitem>
 124   </varlistentry>
 125
 126   <varlistentry>
 127   <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
 128   <listitem>
 129 <para>Default:
 130 <amdefault>No default</amdefault>.
 131 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>
 132   </listitem>
 133   </varlistentry>
 134
 135   <varlistentry>
 136   <term><amkeyword>gnutar-list-dir</amkeyword> <amtype>string</amtype></term>
 137   <listitem>
 138 <para>Default from configure
 139 <amdefault>--with-gnutar-listdir=DIR</amdefault>.
 140 The directory where gnutar keep its state file.</para>
 141   </listitem>
 142   </varlistentry>
 143
 144   <varlistentry>
 145   <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
 146   <listitem>
 147 <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>
 148   </listitem>
 149   </varlistentry>
 150
 151   <varlistentry>
 152   <term><amkeyword>amandates</amkeyword> <amtype>string</amtype></term>
 153   <listitem>
 154 <para>Default:
 155 <amdefault>/etc/amandates</amdefault>.
 156 The file where amanda keep the last date of each dumplevel.</para>
 157   </listitem>
 158   </varlistentry>
 159
 160   <varlistentry>
 161   <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
 162   <listitem>
 163 <para>Default:
 164 <amdefault>3</amdefault>.
 165 How many times the server will try a connection.</para>
 166   </listitem>
 167   </varlistentry>
 168
 169   <varlistentry>
 170   <term><amkeyword>rep-tries</amkeyword> <amtype>int</amtype></term>
 171   <listitem>
 172 <para>Default:
 173 <amdefault>5</amdefault>.
 174 How many times amandad will resend a REP packet if it doesn't get the ACK packet.</para>
 175   </listitem>
 176   </varlistentry>
 177
 178   <varlistentry>
 179   <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
 180   <listitem>
 181 <para>Default:
 182 <amdefault>3</amdefault>.
 183 The number of days the debug files are kept.</para>
 184   </listitem>
 185   </varlistentry>
 186
 187   <varlistentry>
 188   <term><amkeyword>debug-amandad</amkeyword> <amtype>int</amtype></term>
 189   <listitem>
 190 <para>Default:
 191 <emphasis remap='I'>0</emphasis>.
 192 Debug level of the amandad process</para>
 193   </listitem>
 194   </varlistentry>
 195
 196   <varlistentry>
 197   <term><amkeyword>debug-amidxtaped</amkeyword> <amtype>int</amtype></term>
 198   <listitem>
 199 <para>Default:
 200 <amdefault>0</amdefault>.
 201 Debug level of the amidxtaped process</para>
 202   </listitem>
 203   </varlistentry>
 204
 205   <varlistentry>
 206   <term><amkeyword>debug-amindexd</amkeyword> <amtype>int</amtype></term>
 207   <listitem>
 208 <para>Default:
 209 <amdefault>0</amdefault>.
 210 Debug level of the amindexd process</para>
 211   </listitem>
 212   </varlistentry>
 213
 214   <varlistentry>
 215   <term><amkeyword>debug-amrecover</amkeyword> <amtype>int</amtype></term>
 216   <listitem>
 217 <para>Default:
 218 <amdefault>0</amdefault>.
 219 Debug level of the amrecover process</para>
 220   </listitem>
 221   </varlistentry>
 222
 223   <varlistentry>
 224   <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
 225   <listitem>
 226 <para>Default:
 227 <amdefault>0</amdefault>.
 228 Debug level of the auth module</para>
 229   </listitem>
 230   </varlistentry>
 231
 232   <varlistentry>
 233   <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
 234   <listitem>
 235 <para>Default:
 236 <amdefault>0</amdefault>.
 237 Debug level of the event module</para>
 238   </listitem>
 239   </varlistentry>
 240
 241   <varlistentry>
 242   <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
 243   <listitem>
 244 <para>Default:
 245 <amdefault>0</amdefault>.
 246 Debug level of the holdingdisk module</para>
 247   </listitem>
 248   </varlistentry>
 249
 250   <varlistentry>
 251   <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
 252   <listitem>
 253 <para>Default:
 254 <amdefault>0</amdefault>.
 255 Debug level of the protocol module</para>
 256   </listitem>
 257   </varlistentry>
 258
 259   <varlistentry>
 260   <term><amkeyword>debug-selfcheck</amkeyword> <amtype>int</amtype></term>
 261   <listitem>
 262 <para>Default:
 263 <amdefault>0</amdefault>.
 264 Debug level of the selfcheck process</para>
 265   </listitem>
 266   </varlistentry>
 267
 268   <varlistentry>
 269   <term><amkeyword>debug-sendsize</amkeyword> <amtype>int</amtype></term>
 270   <listitem>
 271 <para>Default:
 272 <amdefault>0</amdefault>.
 273 Debug level of the sendsize process</para>
 274   </listitem>
 275   </varlistentry>
 276
 277   <varlistentry>
 278   <term><amkeyword>debug-sendbackup</amkeyword> <amtype>int</amtype></term>
 279   <listitem>
 280 <para>Default:
 281 <amdefault>0</amdefault>.
 282 Debug level of the sendbackup process</para>
 283   </listitem>
 284   </varlistentry>
 285
 286   <varlistentry>
 287   <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
 288   <listitem>
 289 <para>Default: --with-udpportrange or
 290 <amdefault>512,1023</amdefault>.
 291 Reserved udp port that will be used (amrecover with bsd or bsdudp)</para>
 292   </listitem>
 293   </varlistentry>
 294
 295   <varlistentry>
 296   <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
 297   <listitem>
 298 <para>Default: --with-low-tcpportrange or
 299 <amdefault>512,1023</amdefault>.
 300 Reserved tcp port that will be used (amrecover with bsdtcp)</para>
 301   </listitem>
 302   </varlistentry>
 303
 304   <varlistentry>
 305   <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
 306   <listitem>
 307 <para>Default: --with-tcpportrange or
 308 <amdefault>1025,65536</amdefault>.
 309 Unreserved tcp port that will be used (bsd, bsdudp)</para>
 310   </listitem>
 311   </varlistentry>
 312
 313   <varlistentry>
 314   <term><amkeyword>property</amkeyword> <amtype>string</amtype> <amtype>string</amtype>+</term>
 315   <listitem>
 316 <para>Adds a global property for this client host, useful for e.g., Application API plugins. The first string is the property name, the following strings are the property values</para>
 317   </listitem>
 318   </varlistentry>
 319
 320 </variablelist>
 321 </refsect1>
 322
 323 <refsect1><title>APPLICATION SECTION</title>
 324 <para>The
 325 <emphasis remap='B'>amanda-client.conf</emphasis>
 326 file may define multiple types of application.
 327 The information is entered in a <amkeyword>application</amkeyword>
 328 section, which looks like this:</para>
 329
 330 <programlisting>
 331 define application "<amtype>name</amtype>" {
 332     <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
 333     <literal>...</literal>
 334 }
 335 </programlisting>
 336
 337 <para><amtype>name</amtype>
 338 is the name of this type of application.</para>
 339 <para>
 340 The setting from an application is merged with the dle setting
 341   if the <amtype>name</amtype> is the same as the <amkeyword>client-application-name</amkeyword> from the dle
 342   or if the <amkeyword>client-application-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
 343
 344 <para>The application options and values are:</para>
 345 <variablelist remap='TP'>
 346   <varlistentry>
 347   <term><amkeyword>client-application-name</amkeyword> <amtype>string</amtype></term>
 348   <listitem>
 349 <para>Default:
 350 <amdefault>none</amdefault>.
 351 Not use on the client.</para>
 352   </listitem>
 353   </varlistentry>
 354   <varlistentry>
 355   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
 356   <listitem>
 357 <para>Default:
 358 <amdefault>none</amdefault>.
 359 A comment string describing this application.</para>
 360   </listitem>
 361   </varlistentry>
 362   <varlistentry>
 363   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
 364   <listitem>
 365 <para>No default. Must be set to the name of the program. This program must be
 366 in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory
 367 on the client. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
 368   </listitem>
 369   </varlistentry>
 370   <varlistentry>
 371   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
 372   <listitem>
 373 <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
 374 the property to set, and the others contains its values.
 375 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
 376 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the server.
 377 </para>
 378   </listitem>
 379   </varlistentry>
 380 </variablelist>
 381 </refsect1>
 382
 383 <refsect1><title>SCRIPT SECTION</title>
 384 <para>The
 385 <emphasis remap='B'>amanda-client.conf</emphasis>
 386 file may define multiple types of script.
 387 The information is entered in a <emphasis remap='B'>script</emphasis>
 388 section, which looks like this:</para>
 389
 390 <programlisting>
 391 define script "<amtype>name</amtype>" {
 392     <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
 393     <literal>...</literal>
 394 }
 395 </programlisting>
 396
 397 <para><amtype>name</amtype>
 398 is the name of this type of script.</para>
 399 <para>
 400 The setting from a script is merged with the dle setting
 401   if the <amtype>name</amtype> is the same as the <amkeyword>client-script-name</amkeyword> from the dle
 402   or if the <amkeyword>client-script-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
 403
 404 <para>The script options and values are:</para>
 405 <variablelist remap='TP'>
 406   <varlistentry>
 407   <term><amkeyword>client-script-name</amkeyword> <amtype>string</amtype></term>
 408   <listitem>
 409 <para>Default:
 410 <amdefault>none</amdefault>.
 411 Not used on the client.</para>
 412   </listitem>
 413   </varlistentry>
 414   <varlistentry>
 415   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
 416   <listitem>
 417 <para>Default:
 418 <amdefault>none</amdefault>.
 419 A comment string describing this script.</para>
 420   </listitem>
 421   </varlistentry>
 422   <varlistentry>
 423   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
 424   <listitem>
 425 <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. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
 426   </listitem>
 427   </varlistentry>
 428   <varlistentry>
 429   <term><amkeyword>execute-where</amkeyword> <amkeyword>client</amkeyword></term>
 430   <listitem>
 431 <para>Default: <amkeyword>client</amkeyword>.
 432 Value can't be changed.</para>
 433   </listitem>
 434   </varlistentry>
 435   <varlistentry>
 436   <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype>[,<amtype>execute_on</amtype>]*</term>
 437   <listitem>
 438 <para>No default. When the script must be executed, you can specify many of them:</para>
 439     <!-- .RS -->
 440     <variablelist remap='TP'>
 441       <varlistentry>
 442       <term><amkeyword>pre-dle-amcheck</amkeyword></term>
 443       <listitem>
 444 <para>Execute before the amcheck command for the dle.</para>
 445       </listitem>
 446       </varlistentry>
 447       <varlistentry>
 448       <term><amkeyword>pre-host-amcheck</amkeyword></term>
 449       <listitem>
 450 <para>Execute before the amcheck command for all dle for the client.</para>
 451       </listitem>
 452       </varlistentry>
 453       <varlistentry>
 454       <term><amkeyword>post-dle-amcheck</amkeyword></term>
 455       <listitem>
 456 <para>Execute after the amcheck command for the dle.</para>
 457       </listitem>
 458       </varlistentry>
 459       <varlistentry>
 460       <term><amkeyword>post-host-amcheck</amkeyword></term>
 461       <listitem>
 462 <para>Execute after the amcheck command for all dle for the client.</para>
 463       </listitem>
 464       </varlistentry>
 465       <varlistentry>
 466       <term><amkeyword>pre-dle-estimate</amkeyword></term>
 467       <listitem>
 468 <para>Execute before the estimate command for the dle.</para>
 469       </listitem>
 470       </varlistentry>
 471       <varlistentry>
 472       <term><amkeyword>pre-host-estimate</amkeyword></term>
 473       <listitem>
 474 <para>Execute before the estimate command for all dle for the client.</para>
 475       </listitem>
 476       </varlistentry>
 477       <varlistentry>
 478       <term><amkeyword>post-dle-estimate</amkeyword></term>
 479       <listitem>
 480 <para>Execute after the estimate command for the dle.</para>
 481       </listitem>
 482       </varlistentry>
 483       <varlistentry>
 484       <term><amkeyword>post-host-estimate</amkeyword></term>
 485       <listitem>
 486 <para>Execute after the estimate command for all dle for the client.</para>
 487       </listitem>
 488       </varlistentry>
 489       <varlistentry>
 490       <term><amkeyword>pre-dle-backup</amkeyword></term>
 491       <listitem>
 492 <para>Execute before the backup command for the dle.</para>
 493       </listitem>
 494       </varlistentry>
 495       <varlistentry>
 496       <term><amkeyword>post-dle-backup</amkeyword></term>
 497       <listitem>
 498 <para>Execute after the backup command for the dle.</para>
 499       </listitem>
 500       </varlistentry>
 501       <varlistentry>
 502       <term><amkeyword>pre-recover</amkeyword></term>
 503       <listitem>
 504 <para>Execute before any level is recovered.</para>
 505       </listitem>
 506       </varlistentry>
 507       <varlistentry>
 508       <term><amkeyword>post-recover</amkeyword></term>
 509       <listitem>
 510 <para>Execute after all levels are recovered.</para>
 511       </listitem>
 512       </varlistentry>
 513       <varlistentry>
 514       <term><amkeyword>pre-level-recover</amkeyword></term>
 515       <listitem>
 516 <para>Execute before each level recovery.</para>
 517       </listitem>
 518       </varlistentry>
 519       <varlistentry>
 520       <term><amkeyword>post-level-recover</amkeyword></term>
 521       <listitem>
 522 <para>Execute after each level recovery.</para>
 523       </listitem>
 524       </varlistentry>
 525       <varlistentry>
 526       <term><amkeyword>inter-level-recover</amkeyword></term>
 527       <listitem>
 528 <para>Execute between two levels of recovery.</para>
 529       </listitem>
 530       </varlistentry>
 531     </variablelist>
 532   </listitem>
 533   </varlistentry>
 534   <varlistentry>
 535   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
 536   <listitem>
 537 <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
 538 the property to set, and the others contains its values.
 539 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
 540 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the server.
 541 </para>
 542   </listitem>
 543   </varlistentry>
 544 </variablelist>
 545 </refsect1>
 546
 547 <seealso>
 548 <manref name="amanda.conf" vol="5"/>,
 549 <manref name="amcrypt" vol="8"/>,
 550 <manref name="aespipe" vol="1"/>,
 551 </seealso>
 552
 553 </refentry>
 554