3 vos_restore - Converts an ASCII dump file into an AFS volume
10 B<vos restore> S<<< B<-server> <I<machine name>> >>>
11 S<<< B<-partition> <I<partition name>> >>>
12 S<<< B<-name> <I<name of volume to be restored>> >>>
13 S<<< [B<-file> <I<dump file>>] >>>
14 S<<< [B<-id> <I<volume ID>>] >>>
15 S<<< [B<-overwrite> (abort | full | incremental)] >>>
16 [B<-offline>] [B<-readonly>]
17 S<<< [B<-creation> (dump | keep | new)] >>>
18 S<<< [B<-lastupdate> (dump | keep | new)] >>>
19 [B<-nodelete>] S<<< [B<-cell> <I<cell name>>] >>>
20 [B<-noauth>] [B<-localauth>]
21 [-verbose] [B<-encrypt>] [B<-noresolve>] [B<-help>]
23 B<vos res> S<<< B<-s> <I<machine name>> >>>
24 S<<< B<-p> <I<partition name>> >>>
25 S<<< B<-na> <I<name of volume to be restored>> >>>
26 S<<< [B<-f> <I<dump file>>] >>>
27 S<<< [B<-i> <I<volume ID>>] >>>
28 S<<< [B<-ov> (a | f | i)] >>>
30 S<<< [B<-cr> (d | k | n)] >>>
31 S<<< [B<-la> (d | k | n)] >>>
32 [B<-nod>] S<<< [B<-c> <I<cell name>>] >>>
33 [B<-noa>] [B<-lo>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
40 The B<vos restore> command converts a volume dump file previously created
41 with the B<vos dump> command from ASCII into the volume format appropriate
42 for the machine type indicated by the B<-server> argument, and restores it
43 as a read/write volume to the partition named by the B<-partition>
44 argument on that machine. The Volume Server assigns the volume name
45 indicated with the B<-name> argument, and resets the volume's creation
46 timestamp to the time at which the restore operation begins (the creation
47 timestamp is stored in the volume header and reported in the C<Creation>
48 field in the output from the B<vos examine> and B<vos listvol> commands.)
50 Use the B<-file> argument to name the dump file, or omit the argument to
51 provide the file via the standard input stream, presumably through a
52 pipe. The pipe can be named, which enables interoperation with third-party
55 As described in the following list, the command can create a completely
56 new volume or overwrite an existing volume. In all cases, the full dump of
57 the volume must be restored before any incremental dumps. If there are
58 multiple incremental dump files, they must be restored in the order they
65 To create a new read/write volume, use the B<-name> argument to specify a
66 volume name that does not already exist in the Volume Location Database
67 (VLDB), and the B<-server> and B<-partition> arguments to specify the new
68 volume's site. It is best to omit the B<-id> argument so that the Volume
69 Location (VL) Server allocates a volume ID automatically. Do not include
70 the B<-overwrite> argument, because there is no existing volume to
75 To overwrite an existing volume at its current site, specify its name and
76 site with the B<-name>, B<-server>, and B<-partition> arguments. The
77 volume retains its current volume ID number unless the B<-id> argument is
78 provided. Specify the value C<f> or C<i> for the B<-overwrite> argument to
79 indicate whether the dump file is full or incremental, respectively.
83 To overwrite an existing volume and move it to a new site, specify its
84 name and the new site with the B<-name>, B<-server>, and B<-partition>
85 arguments. The volume retains its current volume ID number unless the
86 B<-id> argument is provided. The volume is removed from its original
87 site. Specify the value C<f> for the B<-overwrite> argument to indicate
88 that the dump file is a full dump (it is not possible to restore an
89 incremental dump and move the volume at the same time).
93 If the volume named by the B<-name> argument already exists and the
94 B<-overwrite> argument is omitted, the command interpreter produces the
97 Do you want to do a full/incremental restore or abort? [fia](a):
99 Respond by entering one of the following values:
105 C<f> if restoring a full dump file
109 C<i> if restoring an incremental dump file
113 C<a> or Return to cancel the restore operation
119 If the B<-file> argument is omitted, the issuer must provide all other
120 necessary arguments, because the standard input stream is unavailable for
121 responding to the command interpreter's prompts for missing
122 information. In particular, the issuer must provide the B<-overwrite>
123 argument if overwriting an existing volume.
129 =item B<-server> <I<server name>>
131 Identifies the file server machine onto which to restore the
132 volume. Provide the machine's IP address or its host name (either fully
133 qualified or using an unambiguous abbreviation). For details, see
136 =item B<-partition> <I<partition name>>
138 Identifies the partition (on the file server machine specified by the
139 B<-server> argument) onto which to restore the volume. Provide the
140 partition's complete name with preceding slash (for example, F</vicepa>)
141 or use one of the three acceptable abbreviated forms. For details, see
144 =item B<-name> <I<name of volume>>
146 Specifies the name under which to restore the volume. It can be up to 22
147 characters long, but cannot end with a C<.readonly> or C<.backup>
148 extension. If the volume already exists, it is overwritten subject to the
149 value of the B<-overwrite> argument.
151 =item B<-file> <I<dump file>>
153 Names the dump file to restore. Incomplete pathnames are interpreted
154 relative to the current working directory. Omit this argument to provide
155 the dump file via the standard input stream.
157 =item B<-id> <I<volume ID>>
159 Specifies the volume ID number to assign to the restored volume.
161 =item B<-overwrite> (a | f | i)
163 Specifies which type of dump file is being restored when overwriting an
164 existing volume. Provide one of the following values:
170 C<a> to terminate the restore operation.
174 C<f> if restoring a full dump file.
178 C<i> if restoring an incremental dump file. This value is not acceptable
179 if the B<-server> and B<-partition> arguments do not indicate the volume's
184 This argument is mandatory if the B<-file> argument is not provided.
188 Leaves the new volume flagged as off-line in the volume database.
192 Flags the new volume as read-only in the volume database.
194 =item B<-creation> <I<dump | keep | new>>
196 Set the creation date of the new volume to the timestamp from the
197 dumped volume (dump), from the target volume, if there is one (keep),
198 or generate a new one using the current time (new).
200 =item B<-lastupdate> <I<dump | keep | new>>
202 Set the last updated date of the new volume to the timestamp from the
203 dumped volume (dump), from the target volume, if there is one (keep),
204 or generate a new one using the current time (new).
208 This option is available in OpenAFS clients 1.4.7 or
209 later and 1.5.31 or later. This option can be used with OpenAFS server
210 versions 1.4.1 or later and 1.5.0 or later.
212 =item B<-cell> <I<cell name>>
214 Names the cell in which to run the command. Do not combine this argument
215 with the B<-localauth> flag. For more details, see L<vos(1)>.
219 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
220 combine this flag with the B<-localauth> flag. For more details, see
225 Constructs a server ticket using a key from the local
226 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
227 to the Volume Server and Volume Location Server during mutual
228 authentication. Do not combine this flag with the B<-cell> argument or
229 B<-noauth> flag. For more details, see L<vos(1)>.
233 Produces on the standard output stream a detailed trace of the command's
234 execution. If this argument is omitted, only warnings and error messages
239 Encrypts the command so that the operation's results are not transmitted
240 across the network in clear text. This option is available in OpenAFS
241 versions 1.4.11 or later and 1.5.60 or later.
245 Shows all servers as IP addresses instead of the DNS name. This is very
246 useful when the server address is registered as 127.0.0.1 or when dealing
247 with multi-homed servers. This option is available in OpenAFS
248 versions 1.4.8 or later and 1.5.35 or later.
252 Prints the online help for this command. All other valid options are
259 The following command restores the contents of the dump file
260 F</afs/example.com/common/dumps/terry.dump> to the F</vicepc> partition on the
261 file server machine C<fs3.example.com>. The restored volume is named
264 % cd /afs/example.com/common/dumps
265 % vos restore -file terry.dump -server fs3.example.com -partition c \
268 =head1 PRIVILEGE REQUIRED
270 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
271 machine specified with the B<-server> argument and on each database server
272 machine. If the B<-localauth> flag is included, the issuer must instead be
273 logged on to a server machine as the local superuser C<root>.
285 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
287 This documentation is covered by the IBM Public License Version 1.0. It was
288 converted from HTML to POD by software written by Chas Williams and Russ
289 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.