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