doc/man-pages/pod8/voldump.pod

   1 =head1 NAME
   2
   3 voldump - Dump an AFS volume without using the Volume Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<voldump> S<<< B<-part> <I<partition>> >>> S<<< B<-volumeid> <I<volume id>> >>>
  11     S<<< [B<-file> <I<dump file>>] >>> [B<-time> <I<dump from time>>]
  12     [B<-verbose>] [B<-help>]
  13
  14 B<voldump> S<<< B<-p> <I<partition>> >>> S<<< B<-vo> <I<volume id>> >>>
  15     S<<< [B<-f> <I<dump file>>] >>> [B<-time> <I<dump from time>>]
  16     [B<-ve>] [B<-h>]
  17
  18 =for html
  19 </div>
  20
  21 =head1 DESCRIPTION
  22
  23 B<voldump> dumps an AFS volume in the format used by B<vos dump> without
  24 using the Volume Server.  It must be run on the file server machine and
  25 usually must be run as the superuser C<root> to have permissions to read
  26 the file server data.  It's primary use is to recover data from a file
  27 server machine where the Volume Server cannot be started for some reason.
  28
  29 The dump output will go to standard output, or to a file if B<-file> is
  30 specified.  B<vos restore> can be used to load the resulting dump into a
  31 new AFS volume.  B<voldump> always does a full dump.
  32
  33 =head1 CAUTIONS
  34
  35 Normally, use B<vos dump> instead of this command.  B<voldump> is a tool
  36 of last resort to try to extract data from the raw data structures stored
  37 on the file server machine and is not as regularly tested or used as the
  38 normal B<vos dump> implementation.
  39
  40 If the AFS volume being dumped changes while B<voldump> is running, the
  41 results may be inconsistent.  If the File Server and Volume Server are
  42 running, stop them with B<bos shutdown> or a similar method before running
  43 this command.
  44
  45 =head1 OPTIONS
  46
  47 =over 4
  48
  49 =item B<-part> <I<partition>>
  50
  51 Names the partition on which the volume to be dumped is located.
  52 B<voldump> does not take the normal full range of ways of specifying a
  53 partition.  Instead, I<partition> must be either a single letter between
  54 C<a> and C<z>, corresponding to F</vicepa> through F</vicepz>, or the full
  55 path to the file server partition.  C<aa> is not recognized; use
  56 F</vicepaa> instead.
  57
  58 =item B<-volumeid> <I<volume id>>
  59
  60 Specifies the ID of the volume to dump.  The volume must be specified by
  61 numeric ID, not by name.
  62
  63 =item B<-file> <I<dump file>>
  64
  65 Specifies the output file for the dump.  If this option is not given, the
  66 volume will be dumped to standard output.
  67
  68 =item B<-time> <I<dump from time>>
  69
  70 Specifies whether the dump is full or incremental. Omit this argument to create
  71 a full dump, or provide one of the valid values listed in L<vos_dump(1)>.
  72
  73 =item B<-verbose>
  74
  75 Asks for a verbose trace of the dump process.  This trace information will
  76 be sent to standard error.
  77
  78 =item B<-help>
  79
  80 Prints the online help for this command. All other valid options are
  81 ignored.
  82
  83 =back
  84
  85 =head1 EXAMPLES
  86
  87 The following command dumps the volume 1936964939 on the F</vicepb>
  88 partition to the file F</tmp/volume.dump>:
  89
  90     % voldump -part /vicepb -volumeid 1936964939 -file /tmp/volume.dump
  91
  92 =head1 PRIVILEGE REQUIRED
  93
  94 The issuer must have read access to the file server data stored in the
  95 specified partition.  Usually, this means that the issuer must be the
  96 local superuser C<root> on the file server machine.
  97
  98 =head1 SEE ALSO
  99
 100 L<bos_shutdown(8)>,
 101 L<restorevol(1)>,
 102 L<volserver(8)>,
 103 L<vos_dump(1)>,
 104 L<vos_restore(1)>
 105
 106 =head1 COPYRIGHT
 107
 108 Copyright 2005 Russ Allbery <rra@stanford.edu>
 109
 110 This documentation is covered by the IBM Public License Version 1.0.  This
 111 man page was written by Russ Allbery for OpenAFS.