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     <group><replaceable><arg choice='plain'>command</arg><arg choice='plain'>options</arg></replaceable></group>
  28     <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
  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:</para>
 159
 160 <para><emphasis remap='B'>h</emphasis>  host name
 161 <emphasis remap='B'>k</emphasis>        disk name
 162 <emphasis remap='B'>d</emphasis>        dump date
 163 <emphasis remap='B'>l</emphasis>        backup level
 164 <emphasis remap='B'>p</emphasis>        dump part
 165 <emphasis remap='B'>b</emphasis>        tape label</para>
 166
 167 <para>An uppercase letter reverses the sort order for that key.
 168 The default sort order is <emphasis remap='B'>hkdlpb</emphasis>.</para>
 169 </listitem>
 170 </varlistentry>
 171
 172   <varlistentry>
 173   <term><emphasis remap='B'>delete</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
 174   <listitem>
 175 <para>Delete the specified
 176 <emphasis remap='I'>disks</emphasis>
 177 on
 178 <emphasis remap='I'>hostname</emphasis>
 179 from the &A; database.</para>
 180 <note>If you do not also remove the disk from the
 181 <emphasis remap='I'>disklist</emphasis>
 182 file, &A; will treat it as a new disk during the next run.</note>
 183   </listitem>
 184   </varlistentry>
 185
 186   <varlistentry>
 187   <term><emphasis remap='B'>tape</emphasis></term>
 188   <listitem>
 189 <para>Display the tape(s) &A; expects to write to during the next run.
 190 See also
 191 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 192   </listitem>
 193   </varlistentry>
 194   <varlistentry>
 195   <term><emphasis remap='B'>bumpsize</emphasis></term>
 196   <listitem>
 197 <para>Display the current bump threshold parameters, calculated for all backup
 198 levels.</para>
 199   </listitem>
 200   </varlistentry>
 201   <varlistentry>
 202   <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>
 203   <listitem>
 204 <para>Display the distribution of full backups throughout the dump schedule.</para>
 205   </listitem>
 206   </varlistentry>
 207   <varlistentry>
 208   <term><emphasis remap='B'>export</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 209   <listitem>
 210 <para>Convert records from the &A; database
 211 to a text format that may be transmitted to another &A; machine and
 212 <emphasis remap='B'>import</emphasis>ed.</para>
 213   </listitem>
 214   </varlistentry>
 215   <varlistentry>
 216   <term><emphasis remap='B'>import</emphasis></term>
 217   <listitem>
 218 <para>Convert
 219 <emphasis remap='B'>export</emphasis>ed
 220 records read from standard input to a form &A; uses
 221 and insert them into the database on this machine.</para>
 222   </listitem>
 223   </varlistentry>
 224   <varlistentry>
 225   <term><emphasis remap='B'>disklist</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 226   <listitem>
 227 <para>Display the
 228 <emphasis remap='I'>disklist</emphasis>
 229 information for each of the
 230 <emphasis remap='I'>disks</emphasis>
 231 on
 232 <emphasis remap='I'>hostname</emphasis>
 233 (or all hosts).
 234 Mostly used for debugging.</para>
 235   </listitem>
 236   </varlistentry>
 237   <varlistentry>
 238   <term><emphasis remap='B'>info</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
 239   <listitem>
 240 <para>Display the
 241 database record for each of the
 242 <emphasis remap='I'>disks</emphasis>
 243 on
 244 <emphasis remap='I'>hostname</emphasis>
 245 (or all hosts).
 246 Mostly used for debugging.</para>
 247   </listitem>
 248   </varlistentry>
 249
 250   <varlistentry>
 251   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
 252   <listitem>
 253 <para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>"
 254  section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 255   </listitem>
 256   </varlistentry>
 257
 258 </variablelist>
 259 </refsect1>
 260
 261 <refsect1><title>EXAMPLES</title>
 262 <para>Request three specific file systems on
 263 <emphasis remap='I'>machine-a</emphasis>
 264 get a full level 0 backup during the next &A; run.</para>
 265
 266 <programlisting>
 267 $ amadmin daily force machine-a / /var /usr
 268 amadmin: machine-a:/ is set to a forced level 0 tonight.
 269 amadmin: machine-a:/var is set to a forced level 0 tonight.
 270 amadmin: machine-a:/usr is set to a forced level 0 tonight.
 271 </programlisting>
 272
 273 <para>Request all file systems on
 274 <emphasis remap='I'>machine-b</emphasis>
 275 get a full level 0 backup during the next &A; run.</para>
 276
 277 <programlisting>
 278 $ amadmin daily force machine-b
 279 amadmin: machine-b:/ is set to a forced level 0 tonight.
 280 amadmin: machine-b:/var is set to a forced level 0 tonight.
 281 amadmin: machine-b:/usr is set to a forced level 0 tonight.
 282 amadmin: machine-b:/home is set to a forced level 0 tonight.
 283 </programlisting>
 284
 285 <para>Undo the previous
 286 <emphasis remap='B'>force</emphasis>
 287 request for
 288 <filename>/home</filename>
 289 on
 290 <emphasis remap='I'>machine-b</emphasis>.
 291 The other file systems will still get a full level 0 backup.</para>
 292
 293 <programlisting>
 294 $ amadmin daily unforce machine-b /home
 295 amadmin: force command for machine-b:/home cleared.
 296 </programlisting>
 297
 298 <para>Locate backup images of
 299 <filename>/var</filename>
 300 from
 301 <emphasis remap='I'>machine-c</emphasis>.
 302 The
 303 <emphasis remap='I'>tape or file</emphasis>
 304 column displays either a tape label or a filename depending on whether
 305 the image is on tape or is still in the holding disk.
 306 If the image is on tape, the
 307 <emphasis remap='I'>file</emphasis>
 308 column tells you which file on the tape has the image
 309 (file number zero is a tape label).
 310 This column shows zero and is not meaningful if the image
 311 is still in the holding disk.
 312 The
 313 <emphasis remap='I'>status</emphasis>
 314 column tells you whether the backup was successful or had
 315 some type of error.</para>
 316
 317 <programlisting>
 318 $ amadmin daily find machine-c /var
 319 date        host      disk lv tape or file                 file part  status
 320 2000\-11\-09  machine\-c /var  0 000110                       9   --  OK
 321 2000\-11\-08  machine\-c /var  2 000109                       2   --  OK
 322 2000\-11\-07  machine\-c /var  2 /amanda/20001107/machine-c._var.2  0 OK
 323 2000\-11\-06  machine\-c /var  2 000107                       2   --  OK
 324 2000\-11\-05  machine\-c /var  2 000106                       3   --  OK
 325 2000\-11\-04  machine\-c /var  2 000105                       2   --  OK
 326 2000\-11\-03  machine\-c /var  2 000104                       2   --  OK
 327 2000\-11\-02  machine\-c /var  2 000103                       2   --  OK
 328 2000\-11\-01  machine\-c /var  1 000102                       5   --  OK
 329 2000\-10\-31  machine\-c /var  1 000101                       3   --  OK
 330 </programlisting>
 331
 332 <para>Forget about the
 333 <filename>/workspace</filename>
 334 disk on
 335 <emphasis remap='I'>machine-d</emphasis>.
 336 If you do not also remove the disk from the
 337 <emphasis remap='I'>disklist</emphasis>
 338 file, &A; will treat it as a new disk during the next run.</para>
 339
 340 <programlisting remap='.nf'>
 341 $ amadmin daily delete machine-d /workspace
 342 amadmin: machine-d:/workspace deleted from database.
 343 amadmin: NOTE: you'll have to remove these from the disklist yourself.
 344 </programlisting>
 345
 346 <para>Find the next tape &A; will use (in this case, <literal>123456</literal>).</para>
 347
 348 <programlisting>
 349 $ amadmin daily tape
 350 The next &A; run should go onto tape 123456 or a new tape.
 351 </programlisting>
 352
 353 <para>Show how well full backups are balanced across the dump cycle.
 354 The
 355 <emphasis remap='I'>due-date</emphasis>
 356 column is the day the backups are due for a full backup.
 357 <emphasis remap='I'>#fs</emphasis>
 358 shows the number of filesystems doing full backups that night, and
 359 <emphasis remap='I'>orig KB</emphasis>
 360 and
 361 <emphasis remap='I'>out KB</emphasis>
 362 show the estimated total size of the backups
 363 before and after any compression, respectively.</para>
 364
 365 <para>The
 366 <emphasis remap='I'>balance</emphasis>
 367 column shows how far off that night's backups are from the average size
 368 (shown at the bottom of the balance column).
 369 &A; tries to keep the backups within +/- 5%,
 370 but since the amount of data on each filesystem is always changing,
 371 and &A; will never delay backups just to rebalance the schedule,
 372 it is common for the schedule to fluctuate by larger percentages.
 373 In particular, in the case of a tape or backup failure, a bump will occur the following night,
 374 which will not be smoothed out until the next pass through the schedule.</para>
 375
 376 <para>The last line also shows an estimate of how many &A; runs will be
 377 made between full backups for a file system.
 378 In the example, a file system will probably have a full backup done
 379 every eight times &A; is run (e.g. every eight days).</para>
 380
 381 <programlisting>
 382 $ amadmin daily balance
 383  due-date  #fs   orig KB    out KB  balance
 384 -------------------------------------------
 385 11/10 Mon   21    930389    768753    +5.1%
 386 11/11 Tue   29   1236272    733211    +0.2%
 387 11/12 Wed   31   1552381    735796    +0.6%
 388 11/13 Thu   23   1368447    684552    -6.4%
 389 11/14 Fri   32   1065603    758155    +3.6%
 390 11/15 Sat   14   1300535    738430    +0.9%
 391 11/16 Sun   31   1362696    740365    +1.2%
 392 11/17 Mon   30   1427936    773397    +5.7%
 393 11/18 Tue   11   1059191    721786    -1.3%
 394 11/19 Wed   19   1108737    661867    -9.5%
 395 -------------------------------------------
 396 TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 397 </programlisting>
 398 </refsect1>
 399
 400 <refsect1><title>FILES</title>
 401 <para>/usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/amanda.conf</para>
 402 </refsect1>
 403
 404 <refsect1><title>AUTHOR</title>
 405 <para>James da Silva, &email.jds; : Original text</para>
 406 <para>&maintainer.sgw;: XML-conversion</para>
 407 </refsect1>
 408
 409 <refsect1><title>SEE ALSO</title>
 410 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 411 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 412 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 413 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 414 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
 415 </refsect1>
 416 </refentry>