.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VOS_RESTORE 1" .TH VOS_RESTORE 1 "2021-01-14" "OpenAFS" "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" vos_restore \- Converts an ASCII dump file into an AFS volume .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBvos restore\fR \fB\-server\fR\ <\fImachine\ name\fR> \fB\-partition\fR\ <\fIpartition\ name\fR> \fB\-name\fR\ <\fIname\ of\ volume\ to\ be\ restored\fR> [\fB\-file\fR\ <\fIdump\ file\fR>] [\fB\-id\fR\ <\fIvolume\ \s-1ID\s0\fR>] [\fB\-overwrite\fR\ (abort\ |\ full\ |\ incremental)] [\fB\-offline\fR] [\fB\-readonly\fR] [\fB\-creation\fR\ (dump\ |\ keep\ |\ new)] [\fB\-lastupdate\fR\ (dump\ |\ keep\ |\ new)] [\fB\-nodelete\fR] [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\-verbose] [\fB\-encrypt\fR] [\fB\-noresolve\fR] [\fB\-config\fR\ <\fIconfig\ directory\fR>] [\fB\-help\fR] .PP \&\fBvos res\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-p\fR\ <\fIpartition\ name\fR> \fB\-na\fR\ <\fIname\ of\ volume\ to\ be\ restored\fR> [\fB\-f\fR\ <\fIdump\ file\fR>] [\fB\-i\fR\ <\fIvolume\ \s-1ID\s0\fR>] [\fB\-ov\fR\ (a\ |\ f\ |\ i)] [\fB\-of\fR] [\fB\-r\fR] [\fB\-cr\fR\ (d\ |\ k\ |\ n)] [\fB\-la\fR\ (d\ |\ k\ |\ n)] [\fB\-nod\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-noa\fR] [\fB\-lo\fR] [\fB\-v\fR] [\fB\-e\fR] [\fB\-nor\fR] [\fB\-co\fR\ <\fIconfig\ directory\fR>] [\fB\-h\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBvos restore\fR command converts a volume dump file previously created with the \fBvos dump\fR command from \s-1ASCII\s0 into the volume format appropriate for the machine type indicated by the \fB\-server\fR argument, and restores it as a read/write volume to the partition named by the \fB\-partition\fR argument on that machine. The Volume Server assigns the volume name indicated with the \fB\-name\fR argument, and resets the volume's creation timestamp to the time at which the restore operation begins (the creation timestamp is stored in the volume header and reported in the \f(CW\*(C`Creation\*(C'\fR field in the output from the \fBvos examine\fR and \fBvos listvol\fR commands.) .PP Use the \fB\-file\fR argument to name the dump file, or omit the argument to provide the file via the standard input stream, presumably through a pipe. The pipe can be named, which enables interoperation with third-party backup utilities. .PP As described in the following list, the command can create a completely new volume or overwrite an existing volume. In all cases, the full dump of the volume must be restored before any incremental dumps. If there are multiple incremental dump files, they must be restored in the order they were created. .IP "\(bu" 4 To create a new read/write volume, use the \fB\-name\fR argument to specify a volume name that does not already exist in the Volume Location Database (\s-1VLDB\s0), and the \fB\-server\fR and \fB\-partition\fR arguments to specify the new volume's site. It is best to omit the \fB\-id\fR argument so that the Volume Location (\s-1VL\s0) Server allocates a volume \s-1ID\s0 automatically. Do not include the \fB\-overwrite\fR argument, because there is no existing volume to overwrite. .IP "\(bu" 4 To overwrite an existing volume at its current site, specify its name and site with the \fB\-name\fR, \fB\-server\fR, and \fB\-partition\fR arguments. The volume retains its current volume \s-1ID\s0 number unless the \fB\-id\fR argument is provided. Specify the value \f(CW\*(C`f\*(C'\fR or \f(CW\*(C`i\*(C'\fR for the \fB\-overwrite\fR argument to indicate whether the dump file is full or incremental, respectively. .IP "\(bu" 4 To overwrite an existing volume and move it to a new site, specify its name and the new site with the \fB\-name\fR, \fB\-server\fR, and \fB\-partition\fR arguments. The volume retains its current volume \s-1ID\s0 number unless the \&\fB\-id\fR argument is provided. The volume is removed from its original site. Specify the value \f(CW\*(C`f\*(C'\fR for the \fB\-overwrite\fR argument to indicate that the dump file is a full dump (it is not possible to restore an incremental dump and move the volume at the same time). .PP If the volume named by the \fB\-name\fR argument already exists and the \&\fB\-overwrite\fR argument is omitted, the command interpreter produces the following prompt: .PP .Vb 1 \& Do you want to do a full/incremental restore or abort? [fia](a): .Ve .PP Respond by entering one of the following values: .IP "\(bu" 4 \&\f(CW\*(C`f\*(C'\fR if restoring a full dump file .IP "\(bu" 4 \&\f(CW\*(C`i\*(C'\fR if restoring an incremental dump file .IP "\(bu" 4 \&\f(CW\*(C`a\*(C'\fR or Return to cancel the restore operation .SH "CAUTIONS" .IX Header "CAUTIONS" If the \fB\-file\fR argument is omitted, the issuer must provide all other necessary arguments, because the standard input stream is unavailable for responding to the command interpreter's prompts for missing information. In particular, the issuer must provide the \fB\-overwrite\fR argument if overwriting an existing volume. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-server\fR <\fIserver name\fR>" 4 .IX Item "-server " Identifies the file server machine onto which to restore the volume. Provide the machine's \s-1IP\s0 address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see \&\fBvos\fR\|(1). .IP "\fB\-partition\fR <\fIpartition name\fR>" 4 .IX Item "-partition " Identifies the partition (on the file server machine specified by the \&\fB\-server\fR argument) onto which to restore the volume. Provide the partition's complete name with preceding slash (for example, \fI/vicepa\fR) or use one of the three acceptable abbreviated forms. For details, see \&\fBvos\fR\|(1). .IP "\fB\-name\fR <\fIname of volume\fR>" 4 .IX Item "-name " Specifies the name under which to restore the volume. It can be up to 22 characters long, but cannot end with a \f(CW\*(C`.readonly\*(C'\fR or \f(CW\*(C`.backup\*(C'\fR extension. If the volume already exists, it is overwritten subject to the value of the \fB\-overwrite\fR argument. .IP "\fB\-file\fR <\fIdump file\fR>" 4 .IX Item "-file " Names the dump file to restore. Incomplete pathnames are interpreted relative to the current working directory. Omit this argument to provide the dump file via the standard input stream. .IP "\fB\-id\fR <\fIvolume \s-1ID\s0\fR>" 4 .IX Item "-id " Specifies the volume \s-1ID\s0 number to assign to the restored volume. .IP "\fB\-overwrite\fR (a | f | i)" 4 .IX Item "-overwrite (a | f | i)" Specifies which type of dump file is being restored when overwriting an existing volume. Provide one of the following values: .RS 4 .IP "\(bu" 4 \&\f(CW\*(C`a\*(C'\fR to terminate the restore operation. .IP "\(bu" 4 \&\f(CW\*(C`f\*(C'\fR if restoring a full dump file. .IP "\(bu" 4 \&\f(CW\*(C`i\*(C'\fR if restoring an incremental dump file. This value is not acceptable if the \fB\-server\fR and \fB\-partition\fR arguments do not indicate the volume's current site. .RE .RS 4 .Sp This argument is mandatory if the \fB\-file\fR argument is not provided. .RE .IP "\fB\-offline\fR" 4 .IX Item "-offline" Leaves the new volume flagged as off-line in the volume database. .IP "\fB\-readonly\fR" 4 .IX Item "-readonly" Flags the new volume as read-only in the volume database. .IP "\fB\-creation\fR <\fIdump | keep | new\fR>" 4 .IX Item "-creation " Set the creation date of the new volume to the timestamp from the dumped volume (dump), from the target volume, if there is one (keep), or generate a new one using the current time (new). .IP "\fB\-lastupdate\fR <\fIdump | keep | new\fR>" 4 .IX Item "-lastupdate " Set the last updated date of the new volume to the timestamp from the dumped volume (dump), from the target volume, if there is one (keep), or generate a new one using the current time (new). .IP "\fB\-nodelete\fR" 4 .IX Item "-nodelete" This option is available in OpenAFS clients 1.4.7 or later and 1.5.31 or later. This option can be used with OpenAFS server versions 1.4.1 or later and 1.5.0 or later. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. Do not combine this argument with the \fB\-localauth\fR flag. For more details, see \fBvos\fR\|(1). .IP "\fB\-noauth\fR" 4 .IX Item "-noauth" Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not combine this flag with the \fB\-localauth\fR flag. For more details, see \&\fBvos\fR\|(1). .IP "\fB\-localauth\fR" 4 .IX Item "-localauth" Constructs a server ticket using a key from the local \&\fI/etc/openafs/server/KeyFile\fR file. The \fBvos\fR command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. Do not combine this flag with the \fB\-cell\fR argument or \&\fB\-noauth\fR flag. For more details, see \fBvos\fR\|(1). .IP "\fB\-verbose\fR" 4 .IX Item "-verbose" Produces on the standard output stream a detailed trace of the command's execution. If this argument is omitted, only warnings and error messages appear. .IP "\fB\-encrypt\fR" 4 .IX Item "-encrypt" Encrypts the command so that the operation's results are not transmitted across the network in clear text. This option is available in OpenAFS versions 1.4.11 or later and 1.5.60 or later. .IP "\fB\-noresolve\fR" 4 .IX Item "-noresolve" Shows all servers as \s-1IP\s0 addresses instead of the \s-1DNS\s0 name. This is very useful when the server address is registered as 127.0.0.1 or when dealing with multi-homed servers. This option is available in OpenAFS versions 1.4.8 or later and 1.5.35 or later. .IP "\fB\-config\fR <\fIconfiguration directory\fR>" 4 .IX Item "-config " Set the location of the configuration directory to be used. This defaults to \&\fI/etc/openafs\fR, except if \fB\-localauth\fR is specified, in which case the default is \fI/etc/openafs/server\fR. This option allows the use of alternative configuration locations for testing purposes. .IP "\fB\-help\fR" 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH "EXAMPLES" .IX Header "EXAMPLES" The following command restores the contents of the dump file \&\fI/afs/example.com/common/dumps/terry.dump\fR to the \fI/vicepc\fR partition on the file server machine \f(CW\*(C`fs3.example.com\*(C'\fR. The restored volume is named \&\f(CW\*(C`user.terry\*(C'\fR. .PP .Vb 3 \& % cd /afs/example.com/common/dumps \& % vos restore \-file terry.dump \-server fs3.example.com \-partition c \e \& \-name user.terry .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the machine specified with the \fB\-server\fR argument and on each database server machine. If the \fB\-localauth\fR flag is included, the issuer must instead be logged on to a server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBrestorevol\fR\|(1), \&\fBvos\fR\|(1), \&\fBvos_dump\fR\|(1), \&\fBvos_examine\fR\|(1), \&\fBvos_listvol\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.