git.gag.com Git - debian/amanda/blob - man/xml-source/amadmin.8.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 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amadmin.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amadmin</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 </refmeta>
  17 <refnamediv>
  18 <refname>amadmin</refname>
  19 <refpurpose>administrative interface to control &A; backups</refpurpose>
  20 </refnamediv>
  21 <!-- body begins here -->
  22 <refsynopsisdiv>
  23 <cmdsynopsis>
  24   <command>amadmin</command>
  25     <arg choice='plain'><replaceable>config</replaceable></arg>
  26     <arg choice='plain'><replaceable>command</replaceable></arg>
  27     <arg choice='opt' rep='repeat'><replaceable>command_options</replaceable></arg>
  28     <arg choice='plain' rep='repeat'><group><option>-o </option><replaceable>configoption</replaceable></group></arg>
  29 </cmdsynopsis>
  30 </refsynopsisdiv>
  31
  32
  33 <refsect1><title>DESCRIPTION</title>
  34 <para><emphasis remap='B'>Amadmin</emphasis>
  35 performs various administrative tasks on the
  36 <emphasis remap='I'>config</emphasis>
  37 &A; configuration.</para>
  38
  39 <para>See the
  40 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  41 man page for more details about &A;.</para>
  42 </refsect1>
  43
  44 <refsect1><title>COMMANDS</title>
  45 <para>Commands that take a <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]
  46 parameter pair operate on all disks in the <emphasis remap='I'>disklist</emphasis> for that
  47 <emphasis remap='I'>hostname</emphasis> if no disks are specified.  Where
  48 <emphasis remap='I'>hostname</emphasis> is also marked as being optional,
  49 the command operates on all hosts and disks in the <emphasis remap='I'>disklist</emphasis>.
  50 Both <emphasis remap='I'>hostname</emphasis> and <emphasis remap='I'>disks</emphasis>
  51 are special expressions; see the &quot;HOST &amp; DISK EXPRESSION&quot; section
  52 of <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  53 for a description.</para>
  54
  55 <para>Commands that take one or more <emphasis remap='I'>dumpspec</emphasis> parameters operate
  56 on the set of dumps specified by all of the expressions.  See the &quot;DUMP SPECIFICATIONS&quot;
  57 section of
  58 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  59 for a description.</para>
  60
  61 <variablelist remap='TP'>
  62   <varlistentry>
  63   <term><emphasis remap='B'>version</emphasis></term>
  64   <listitem>
  65 <para>Show the current version and some compile time and runtime parameters.
  66 The
  67 <emphasis remap='I'>config</emphasis>
  68 parameter must be present but is ignored.</para>
  69   </listitem>
  70   </varlistentry>
  71   <varlistentry>
  72   <term><emphasis remap='B'>force-bump</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
  73   <listitem>
  74 <para>Force the
  75 <emphasis remap='I'>disks</emphasis>
  76 on
  77 <emphasis remap='I'>hostname</emphasis>
  78 to bump to a new incremental level during the next &A; run.</para>
  79   </listitem>
  80   </varlistentry>
  81   <varlistentry>
  82   <term><emphasis remap='B'>force-no-bump</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
  83   <listitem>
  84 <para>Force the
  85 <emphasis remap='I'>disks</emphasis>
  86 on
  87 <emphasis remap='I'>hostname</emphasis>
  88 to not bump to a new incremental level during the next &A; run.</para>
  89   </listitem>
  90   </varlistentry>
  91   <varlistentry>
  92   <term><emphasis remap='B'>unforce-bump</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
  93   <listitem>
  94 <para>Undo a previous
  95 <emphasis remap='B'>force-bump</emphasis>
  96 or
  97 <emphasis remap='B'>force-no-bump</emphasis>
  98 command.</para>
  99   </listitem>
 100   </varlistentry>
 101   <varlistentry>
 102   <term><emphasis remap='B'>force</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
 103   <listitem>
 104 <para>Force the
 105 <emphasis remap='I'>disks</emphasis>
 106 on
 107 <emphasis remap='I'>hostname</emphasis>
 108 to do a full (level 0) backup during the next &A; run.</para>
 109   </listitem>
 110   </varlistentry>
 111   <varlistentry>
 112   <term><emphasis remap='B'>unforce</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
 113   <listitem>
 114 <para>Undo a previous
 115 <emphasis remap='B'>force</emphasis>
 116 command.</para>
 117   </listitem>
 118   </varlistentry>
 119   <varlistentry>
 120   <term><emphasis remap='B'>reuse</emphasis> <emphasis remap='I'>tapelabel</emphasis> [ ... ]</term>
 121   <listitem>
 122 <para>The tapes listed
 123 will be available for reuse at their point in the tape cycle.</para>
 124   </listitem>
 125   </varlistentry>
 126   <varlistentry>
 127   <term><emphasis remap='B'>no-reuse</emphasis> <emphasis remap='I'>tapelabel</emphasis> [ ... ]</term>
 128   <listitem>
 129 <para>The tapes listed
 130 will not be reused when their turn comes up again in the tape cycle.
 131 Note that if this causes the number of reusable tapes to drop below the
 132 <emphasis remap='B'>amanda.conf</emphasis>
 133 <emphasis remap='I'>tapecycle</emphasis>
 134 value, &A; will request new tapes until the count is satisfied again.</para>
 135 <para>Tape marked <emphasis remap='I'>no-reuse</emphasis> are available
 136 for recovery, marking them <emphasis remap='I'>no-reuse</emphasis> is a
 137 security to be sure amanda will not overwrite them.</para>
 138   </listitem>
 139   </varlistentry>
 140   <varlistentry>
 141   <term><emphasis remap='B'>due</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 142   <listitem>
 143 <para>Show when the next full dump is due.</para>
 144   </listitem>
 145   </varlistentry>
 146   <varlistentry>
 147   <term><emphasis remap='B'>find</emphasis> [ <option>--sort</option> <replaceable>hkdlpb</replaceable> ]<emphasis remap='B'></emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 148   <listitem>
 149 <para>Display all backups currently on tape or in the holding disk.
 150 The tape label or holding disk filename,
 151 file number,
 152 and status are displayed.</para>
 153 <para>The <option>--sort</option> option changes the sort order using the following flags:
 154 <programlisting>
 155 <emphasis>h</emphasis>: host name
 156 <emphasis>k</emphasis>: disk name
 157 <emphasis>d</emphasis>: dump date
 158 <emphasis>l</emphasis>: backup level
 159 <emphasis>p</emphasis>: dump part
 160 <emphasis>b</emphasis>: tape label
 161 </programlisting></para>
 162
 163 <para>An uppercase letter reverses the sort order for that key.
 164 The default sort order is <emphasis remap='B'>hkdlpb</emphasis>.</para>
 165 </listitem>
 166 </varlistentry>
 167
 168   <varlistentry>
 169   <term><emphasis remap='B'>holding delete</emphasis> <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ]</term>
 170   <listitem>
 171
 172     <para>Delete holding files matching the given specification.  At least
 173     a hostname must be provided.</para>
 174
 175   </listitem>
 176   </varlistentry>
 177
 178   <varlistentry>
 179   <term><emphasis remap='B'>holding list</emphasis> [-l] [-d] [ <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ] ]</term>
 180   <listitem>
 181
 182     <para>List holding files matching the given specification, or all holding
 183     files if no specification is provided.  With '-l', additional information
 184     (size, level, and whether the dump is outdated) is provided.  With '-d', only
 185     outdated dumps are shown.</para>
 186
 187     <para>An outdated holding file is one which is not required for a
 188     restore of the <emphasis>most recent</emphasis> dump.  Note that
 189     outdated dumps may still be required for restores at earlier dates.
 190     For example, assume that a DLE had a level 0 on Monday, level
 191     1's Tuesday through Thursday, and a level 2 on Friday.  Then the
 192     files required for a restore of Fridays (the most recent) dump
 193     are those from Monday (level 0), Thursday (level 1), and Friday
 194     (level 2).  Tuesday and Wednesday's files are outdated. </para>
 195
 196   </listitem>
 197   </varlistentry>
 198
 199   <varlistentry>
 200   <term><emphasis remap='B'>delete</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
 201   <listitem>
 202 <para>Delete the specified
 203 <emphasis remap='I'>disks</emphasis>
 204 on
 205 <emphasis remap='I'>hostname</emphasis>
 206 from the &A; database.</para>
 207 <note><para>If you do not also remove the disk from the
 208 <emphasis remap='I'>disklist</emphasis>
 209 file, &A; will treat it as a new disk during the next run.</para>
 210 </note>
 211   </listitem>
 212   </varlistentry>
 213
 214   <varlistentry>
 215   <term><emphasis remap='B'>tape</emphasis></term>
 216   <listitem>
 217 <para>Display the tape(s) &A; expects to write to during the next run.
 218 See also
 219 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 220   </listitem>
 221   </varlistentry>
 222   <varlistentry>
 223   <term><emphasis remap='B'>bumpsize</emphasis></term>
 224   <listitem>
 225 <para>Display the current bump threshold parameters, calculated for all backup
 226 levels.</para>
 227   </listitem>
 228   </varlistentry>
 229   <varlistentry>
 230   <term><emphasis remap='B'>balance</emphasis> [ <option>--days</option> <replaceable>&lt;num&gt;</replaceable> ]<emphasis remap='B'></emphasis> <emphasis remap='I'></emphasis> <emphasis remap='I'></emphasis></term>
 231   <listitem>
 232 <para>Display the distribution of full backups throughout the dump schedule.</para>
 233   </listitem>
 234   </varlistentry>
 235   <varlistentry>
 236   <term><emphasis remap='B'>export</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 237   <listitem>
 238 <para>Convert records from the &A; database
 239 to a text format that may be transmitted to another &A; machine and
 240 <emphasis remap='B'>import</emphasis>ed.</para>
 241   </listitem>
 242   </varlistentry>
 243   <varlistentry>
 244   <term><emphasis remap='B'>import</emphasis></term>
 245   <listitem>
 246 <para>Convert
 247 <emphasis remap='B'>export</emphasis>ed
 248 records read from standard input to a form &A; uses
 249 and insert them into the database on this machine.</para>
 250   </listitem>
 251   </varlistentry>
 252   <varlistentry>
 253   <term><emphasis remap='B'>disklist</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 254   <listitem>
 255 <para>Display the
 256 <emphasis remap='I'>disklist</emphasis>
 257 information for each of the
 258 <emphasis remap='I'>disks</emphasis>
 259 on
 260 <emphasis remap='I'>hostname</emphasis>
 261 (or all hosts).
 262 Mostly used for debugging.</para>
 263   </listitem>
 264   </varlistentry>
 265   <varlistentry>
 266   <term><emphasis remap='B'>info</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 267   <listitem>
 268 <para>Display the
 269 database record for each of the
 270 <emphasis remap='I'>disks</emphasis>
 271 on
 272 <emphasis remap='I'>hostname</emphasis>
 273 (or all hosts).
 274 Mostly used for debugging.</para>
 275   </listitem>
 276   </varlistentry>
 277
 278   <varlistentry>
 279   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
 280   <listitem>
 281 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
 282  section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 283   </listitem>
 284   </varlistentry>
 285
 286 </variablelist>
 287 </refsect1>
 288
 289 <refsect1><title>EXAMPLES</title>
 290 <para>Request three specific file systems on
 291 <emphasis remap='I'>machine-a</emphasis>
 292 get a full level 0 backup during the next &A; run.</para>
 293
 294 <programlisting>
 295 $ amadmin daily force machine-a / /var /usr
 296 amadmin: machine-a:/ is set to a forced level 0 tonight.
 297 amadmin: machine-a:/var is set to a forced level 0 tonight.
 298 amadmin: machine-a:/usr is set to a forced level 0 tonight.
 299 </programlisting>
 300
 301 <para>Request all file systems on
 302 <emphasis remap='I'>machine-b</emphasis>
 303 get a full level 0 backup during the next &A; run.</para>
 304
 305 <programlisting>
 306 $ amadmin daily force machine-b
 307 amadmin: machine-b:/ is set to a forced level 0 tonight.
 308 amadmin: machine-b:/var is set to a forced level 0 tonight.
 309 amadmin: machine-b:/usr is set to a forced level 0 tonight.
 310 amadmin: machine-b:/home is set to a forced level 0 tonight.
 311 </programlisting>
 312
 313 <para>Undo the previous
 314 <emphasis remap='B'>force</emphasis>
 315 request for
 316 <filename>/home</filename>
 317 on
 318 <emphasis remap='I'>machine-b</emphasis>.
 319 The other file systems will still get a full level 0 backup.</para>
 320
 321 <programlisting>
 322 $ amadmin daily unforce machine-b /home
 323 amadmin: force command for machine-b:/home cleared.
 324 </programlisting>
 325
 326 <para>Locate backup images of
 327 <filename>/var</filename>
 328 from
 329 <emphasis remap='I'>machine-c</emphasis>.
 330 The
 331 <emphasis remap='I'>tape or file</emphasis>
 332 column displays either a tape label or a filename depending on whether
 333 the image is on tape or is still in the holding disk.
 334 If the image is on tape, the
 335 <emphasis remap='I'>file</emphasis>
 336 column tells you which file on the tape has the image
 337 (file number zero is a tape label).
 338 This column shows zero and is not meaningful if the image
 339 is still in the holding disk.
 340 The
 341 <emphasis remap='I'>status</emphasis>
 342 column tells you whether the backup was successful or had
 343 some type of error.</para>
 344
 345 <programlisting>
 346 $ amadmin daily find machine-c /var
 347 date        host      disk lv tape or file                 file part  status
 348 2000-11-09  machine-c /var  0 000110                       9   --  OK
 349 2000-11-08  machine-c /var  2 000109                       2   --  OK
 350 2000-11-07  machine-c /var  2 /amanda/20001107/machine-c._var.2  0 OK
 351 2000-11-06  machine-c /var  2 000107                       2   --  OK
 352 2000-11-05  machine-c /var  2 000106                       3   --  OK
 353 2000-11-04  machine-c /var  2 000105                       2   --  OK
 354 2000-11-03  machine-c /var  2 000104                       2   --  OK
 355 2000-11-02  machine-c /var  2 000103                       2   --  OK
 356 2000-11-01  machine-c /var  1 000102                       5   --  OK
 357 2000-10-31  machine-c /var  1 000101                       3   --  OK
 358 </programlisting>
 359
 360 <para>Forget about the
 361 <filename>/workspace</filename>
 362 disk on
 363 <emphasis remap='I'>machine-d</emphasis>.
 364 If you do not also remove the disk from the
 365 <emphasis remap='I'>disklist</emphasis>
 366 file, &A; will treat it as a new disk during the next run.</para>
 367
 368 <programlisting remap='.nf'>
 369 $ amadmin daily delete machine-d /workspace
 370 amadmin: machine-d:/workspace deleted from database.
 371 amadmin: NOTE: you'll have to remove these from the disklist yourself.
 372 </programlisting>
 373
 374 <para>Find the next tape &A; will use (in this case, <literal>123456</literal>).</para>
 375
 376 <programlisting>
 377 $ amadmin daily tape
 378 The next &A; run should go onto tape 123456 or a new tape.
 379 </programlisting>
 380
 381 <para>Show how well full backups are balanced across the dump cycle.
 382 The
 383 <emphasis remap='I'>due-date</emphasis>
 384 column is the day the backups are due for a full backup.
 385 <emphasis remap='I'>#fs</emphasis>
 386 shows the number of filesystems doing full backups that night, and
 387 <emphasis remap='I'>orig KB</emphasis>
 388 and
 389 <emphasis remap='I'>out KB</emphasis>
 390 show the estimated total size of the backups
 391 before and after any compression, respectively.</para>
 392
 393 <para>The
 394 <emphasis remap='I'>balance</emphasis>
 395 column shows how far off that night's backups are from the average size
 396 (shown at the bottom of the balance column).
 397 &A; tries to keep the backups within +/- 5%,
 398 but since the amount of data on each filesystem is always changing,
 399 and &A; will never delay backups just to rebalance the schedule,
 400 it is common for the schedule to fluctuate by larger percentages.
 401 In particular, in the case of a tape or backup failure, a bump will occur the following night,
 402 which will not be smoothed out until the next pass through the schedule.</para>
 403
 404 <para>The last line also shows an estimate of how many &A; runs will be
 405 made between full backups for a file system.
 406 In the example, a file system will probably have a full backup done
 407 every eight times &A; is run (e.g. every eight days).</para>
 408
 409 <programlisting>
 410 $ amadmin daily balance
 411  due-date  #fs   orig KB    out KB  balance
 412 -------------------------------------------
 413 11/10 Mon   21    930389    768753    +5.1%
 414 11/11 Tue   29   1236272    733211    +0.2%
 415 11/12 Wed   31   1552381    735796    +0.6%
 416 11/13 Thu   23   1368447    684552    -6.4%
 417 11/14 Fri   32   1065603    758155    +3.6%
 418 11/15 Sat   14   1300535    738430    +0.9%
 419 11/16 Sun   31   1362696    740365    +1.2%
 420 11/17 Mon   30   1427936    773397    +5.7%
 421 11/18 Tue   11   1059191    721786    -1.3%
 422 11/19 Wed   19   1108737    661867    -9.5%
 423 -------------------------------------------
 424 TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 425 </programlisting>
 426 </refsect1>
 427
 428 <refsect1><title>FILES</title>
 429 <para>/usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/amanda.conf</para>
 430 </refsect1>
 431
 432 <refsect1><title>AUTHOR</title>
 433 <para>James da Silva, &email.jds; : Original text</para>
 434 <para>&maintainer.sgw;: XML-conversion</para>
 435 </refsect1>
 436
 437 <refsect1><title>SEE ALSO</title>
 438 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 439 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 440 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 441 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 442 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 443 <ulink url="http://wiki.zmanda.com"/>
 444 </para>
 445 </refsect1>
 446 </refentry>