doc/man-pages/pod1/vos_dump.pod

   1 =head1 NAME
   2
   3 vos_dump - Converts a volume into ASCII format and writes it to a file
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos dump> S<<< B<-id> <I<volume name or ID>> >>> S<<< [B<-time> <I<dump from time>>] >>>
  11     S<<< [B<-file> <I<dump file>>] >>> S<<< [B<-server> <I<server>>] >>>
  12     S<<< [B<-partition> <I<partition>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
  13     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
  14
  15 B<vos du> S<<< B<-i> <I<volume name or ID>> >>> S<<< [B<-t> <I<dump from time>>] >>>
  16     S<<< [B<-f> <I<dump file>>] >>> S<<< [B<-s> <I<server>>] >>> S<<< [B<-p> <I<partition>>] >>>
  17     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos dump> command converts the contents of the indicated volume,
  25 which can be read/write, read-only or backup, into ASCII format. The
  26 Volume Server writes the converted contents to the file named by the
  27 B<-file> argument, or to the standard output stream. In the latter case,
  28 the output can be directed to a named pipe, which enables interoperation
  29 with third-party backup utilities.
  30
  31 To dump the complete contents of a volume (create a I<full dump>), omit
  32 the B<-time> argument or specify the value C<0> (zero) for it. To create
  33 an I<incremental dump>, which includes only the files and directories in
  34 the volume that have modification timestamps later than a certain time,
  35 specify a date and time as the value for the B<-time> argument.
  36
  37 By default, the vos command interpreter consults the Volume Location
  38 Database (VLDB) to learn the volume's location, so the B<-server> and
  39 B<-partition> arguments are not required. If the B<-id> argument
  40 identifies a read-only volume that resides at multiple sites, the command
  41 dumps the version from just one of them (normally, the one listed first in
  42 the volume's VLDB entry as reported by the B<vos examine> or B<vos
  43 listvldb> command). To dump the read-only volume from a particular site,
  44 use the B<-server> and B<-partition> arguments to specify the site. To
  45 bypass the VLDB lookup entirely, provide a volume ID number (rather than a
  46 volume name) as the value for the B<-id> argument, together with the
  47 B<-server> and B<-partition> arguments. This makes it possible to dump a
  48 volume for which there is no VLDB entry.
  49
  50 During the dump operation, the volume is inaccessible both to Cache
  51 Managers and to other volume operations. Dumping a volume does not
  52 otherwise affect its status on the partition or its VLDB entry.
  53
  54 To restore a dumped volume back into AFS, use the B<vos restore> command.
  55
  56 =head1 CAUTIONS
  57
  58 Support for incremental dumps is provided to facilitate interoperation
  59 with third-party backup utilities. The B<vos dump> command does not
  60 provide any of the administrative facilities of an actual backup system,
  61 so the administrator must keep manual records of dump times and the
  62 relationship between full and incremental dumps of a volume. For a
  63 volume's contents to be consistent after restoration of incremental dumps,
  64 there must be no gap between the time at which a prior dump of the volume
  65 was created and the value of the B<-time> argument to the B<vos dump>
  66 command that creates the incremental dump. More specifically, for a
  67 read/write volume, the B<-time> argument must specify the time that the
  68 prior dump was performed, and for a read-only or backup volume it must
  69 specify the time that the volume was last released (using the B<vos
  70 release> command) or cloned (using the B<vos backup> or B<vos backupsys>
  71 command) prior to dumping it. The parent dump can be either a full dump or
  72 another incremental dump.
  73
  74 =head1 OPTIONS
  75
  76 =over 4
  77
  78 =item B<-id> <I<volume name or ID>>
  79
  80 Specifies either the complete name or volume ID number of the read/write,
  81 read-only, or backup volume to dump.
  82
  83 =item B<-time> <I<dump from time>>
  84
  85 Specifies whether the dump is full or incremental. Omit this argument to
  86 create a full dump, or provide one of three acceptable values:
  87
  88 =over 4
  89
  90 =item *
  91
  92 The value C<0> (zero) to create a full dump.
  93
  94 =item *
  95
  96 A date in the format I<mm>B</>I<dd>B</>I<yyyy> (month, day and year) to
  97 create an incremental dump that includes only files and directories with
  98 modification timestamps later than midnight (12:00 a.m.) on the indicated
  99 date. Valid values for the year range from C<1970> to C<2037>; higher
 100 values are not valid because the latest possible date in the standard UNIX
 101 representation is in 2038. The command interpreter automatically reduces
 102 later dates to the maximum value. An example is C<01/13/1999>.
 103
 104 =item *
 105
 106 A date and time in the format B<">I<mm>B</>I<dd>B</>I<yyyy>
 107 I<hh>B<:>I<MM>B<"> to create an incremental dump that includes only files
 108 and directories with modification timestamps later than the specified date
 109 and time. The date format is the same as for a date alone. Express the
 110 time as hours and minutes (I<hh>:I<MM>) in 24-hour format (for example,
 111 B<20:30> is 8:30 p.m.). Surround the entire expression with double quotes
 112 (C<"">) because it contains a space.  An example is C<"01/13/1999 22:30">.
 113
 114 =back
 115
 116 =item B<-file> <I<dump file>>
 117
 118 Specifies the pathname of the file to which to write the dump. The file
 119 can be in AFS, but not in the volume being dumped. A partial pathname is
 120 interpreted relative to the current working directory. If this argument is
 121 omitted, the dump is directed to the standard output stream.
 122
 123 =item B<-server> <I<server name>>
 124
 125 Specifies the file server machine on which the volume resides.  Provide
 126 the B<-partition> argument along with this one.
 127
 128 =item B<-partition> <I<partition name>>
 129
 130 Specifies the partition on which the volume resides. Provide the
 131 B<-server> argument along with this one.
 132
 133 =item B<-cell> <I<cell name>
 134
 135 Names the cell in which to run the command. Do not combine this argument
 136 with the B<-localauth> flag. For more details, see L<vos(1)>.
 137
 138 =item B<-noauth>
 139
 140 Assigns the unprivileged identity anonymous to the issuer. Do not combine
 141 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
 142
 143 =item B<-localauth>
 144
 145 Constructs a server ticket using a key from the local
 146 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 147 to the Volume Server and Volume Location Server during mutual
 148 authentication. Do not combine this flag with the B<-cell> argument or
 149 B<-noauth> flag. For more details, see L<vos(1)>.
 150
 151 =item B<-verbose>
 152
 153 Produces on the standard output stream a detailed trace of the command's
 154 execution. If this argument is omitted, only warnings and error messages
 155 appear.
 156
 157 =item B<-help>
 158
 159 Prints the online help for this command. All other valid options are
 160 ignored.
 161
 162 =back
 163
 164 =head1 EXAMPLES
 165
 166 The following command writes a full dump of the volume C<user.terry> to
 167 the file F</afs/abc.com/common/dumps/terry.dump>.
 168
 169    % vos dump -id user.terry -time 0 -file /afs/abc.com/common/dumps/terry.dump
 170
 171 The following command writes an incremental dump of the volume
 172 C<user.smith> to the file C<smith.990131.dump> in the current working
 173 directory. Only those files in the volume with modification time stamps
 174 later than 6:00 p.m. on 31 January 1999 are included in the dump.
 175
 176    % vos dump -id user.smith -time "01/31/1999 18:00" -file smith.990131.dump
 177
 178 =head1 PRIVILEGE REQUIRED
 179
 180 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 181 machine specified with the B<-server> argument and on each database server
 182 machine. If the B<-localauth> flag is included, the issuer must instead be
 183 logged on to a server machine as the local superuser C<root>.
 184
 185 If the B<-file> argument is included, the issuer must also have permission
 186 to insert and write in the directory that houses the file.
 187
 188 =head1 SEE ALSO
 189
 190 L<vos(1)>,
 191 L<vos_examine(1)>,
 192 L<vos_listvldb(1)>,
 193 L<vos_restore(1)>
 194
 195 =head1 COPYRIGHT
 196
 197 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 198
 199 This documentation is covered by the IBM Public License Version 1.0.  It was
 200 converted from HTML to POD by software written by Chas Williams and Russ
 201 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.