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