openafs/doc/html/AdminReference/auarf274.htm
Derrick Brashear d7da1acc31 initial-html-documentation-20010606
pull in all documentation from IBM
2001-06-06 19:09:07 +00:00

195 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
<HTML><HEAD>
<TITLE>Administration Reference</TITLE>
<!-- Begin Header Records ========================================== -->
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
</HEAD><BODY>
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
<BODY bgcolor="ffffff">
<!-- End Header Records ============================================ -->
<A NAME="Top_Of_Page"></A>
<H1>Administration Reference</H1>
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf273.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf275.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
<P>
<H2><A NAME="HDRVOS_RESTORE" HREF="auarf002.htm#ToC_288">vos restore</A></H2>
<A NAME="IDX5829"></A>
<A NAME="IDX5830"></A>
<A NAME="IDX5831"></A>
<A NAME="IDX5832"></A>
<P><STRONG>Purpose</STRONG>
<P>Converts an ASCII file into proper volume format and writes it to the file
system
<P><STRONG>Synopsis</STRONG>
<PRE><B>vos restore -server</B> &lt;<VAR>machine&nbsp;name</VAR>> <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>
<B>-name</B> &lt;<VAR>name&nbsp;of&nbsp;volume&nbsp;to&nbsp;be&nbsp;restored</VAR>> [<B>-file</B> &lt;<VAR>dump&nbsp;file</VAR>>]
[<B>-id</B> &lt;<VAR>volume&nbsp;ID</VAR>>] [<B>-overwrite</B> &lt;<B>abort</B> | <B>full</B> | <B>incremental</B>>]
[<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>] [<B>-noauth</B>] [<B>-localauth</B>] [<B>-verbose</B>]
[<B>-help</B>]
<B>vos res -s</B> &lt;<VAR>machine&nbsp;name</VAR>> <B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>
<B>-na</B> &lt;<VAR>name of volume to be restored</VAR>> [<B>-f</B> &lt;<VAR>dump&nbsp;file</VAR>>]
[<B>-i</B> &lt;<VAR>volume&nbsp;ID</VAR>>] [<B>-o</B> &lt;<B>a</B> | <B>f</B> | <B>inc</B>>] [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]
[<B>-no</B>] [<B>-l</B>] [<B>-v</B>] [<B>-h</B>]
</PRE>
<P><STRONG>Description</STRONG>
<P>The <B>vos restore</B> command converts a volume dump file previously
created with the <B>vos dump</B> command from ASCII into the volume format
appropriate for the machine type indicated by the <B>-server</B> argument,
and restores it as a read/write volume to the partition named by the
<B>-partition</B> argument on that machine. The Volume Server
assigns the volume name indicated with the <B>-name</B> 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 <TT>Creation</TT> field in the output from the <B>vos
examine</B> and <B>vos listvol</B> commands.)
<P>Use the <B>-file</B> 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.
<P>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.
<UL>
<P><LI>To create a new read/write volume, use the <B>-name</B> argument to
specify a volume name that does not already exist in the Volume Location
Database (VLDB), and the <B>-server</B> and <B>-partition</B>
arguments to specify the new volume's site. It is best to omit the
<B>-id</B> argument so that the Volume Location (VL) Server allocates a
volume ID automatically. Do not include the <B>-overwrite</B>
argument, because there is no existing volume to overwrite.
<P><LI>To overwrite an existing volume at its current site, specify its name and
site with the <B>-name</B>, <B>-server</B>, and <B>-partition</B>
arguments. The volume retains its current volume ID number unless the
<B>-id</B> argument is provided. Specify the value <B>f</B> or
<B>i</B> for the <B>-overwrite</B> argument to indicate whether the
dump file is full or incremental, respectively.
<P><LI>To overwrite an existing volume and move it to a new site, specify its
name and the new site with the <B>-name</B>, <B>-server</B>, and
<B>-partition</B> arguments. The volume retains its current volume
ID number unless the <B>-id</B> argument is provided. The volume is
removed from its original site. Specify the value <B>f</B> for the
<B>-overwrite</B> 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).
</UL>
<P>If the volume named by the <B>-name</B> argument already exists and the
<B>-overwrite</B> argument is omitted, the command interpreter produces
the following prompt:
<P>
<PRE> Do you want to do a full/incremental restore or abort? [fia](a):
</PRE>
<P>Respond by entering one of the following values:
<UL>
<P><LI><B>f</B> if restoring a full dump file
<P><LI><B>i</B> if restoring an incremental dump file
<P><LI><B>a</B> or &lt;<B>Return</B>> to cancel the restore operation
</UL>
<P><STRONG>Cautions</STRONG>
<P>If the <B>-file</B> 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
<B>-overwrite</B> argument if overwriting an existing volume.
<P><STRONG>Options</STRONG>
<DL>
<P><DT><B>-server
</B><DD>Identifies the file server machine onto which to restore the
volume. Provide the machine's IP address or its host name (either
fully qualified or using an unambiguous abbreviation). For details, see
the introductory reference page for the <B>vos</B> command suite.
<P><DT><B>-partition
</B><DD>Identifies the partition (on the file server machine specified by the
<B>-server</B> argument) onto which to restore the volume. Provide
the partition's complete name with preceding slash (for example,
<B>/vicepa</B>) or use one of the three acceptable abbreviated
forms. For details, see the introductory reference page for the
<B>vos</B> command suite.
<P><DT><B>-name
</B><DD>Specifies the name under which to restore the volume. It can be up
to 22 characters long, but cannot end with a <B>.readonly</B> or
<B>.backup</B> extension. If the volume already exists, it
is overwritten subject to the value of the <B>-overwrite</B>
argument.
<P><DT><B>-file
</B><DD>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.
<P><DT><B>-id
</B><DD>Specifies the volume ID number to assign to the restored volume.
<P><DT><B>-overwrite
</B><DD>Specifies which type of dump file is being restored when overwriting an
existing volume. Provide one of the following values:
<UL>
<P><LI><B>a</B> to terminate the restore operation.
<P><LI><B>f</B> if restoring a full dump file.
<P><LI><B>i</B> if restoring an incremental dump file. This value is
not acceptable if the <B>-server</B> and <B>-partition</B> arguments
do not indicate the volume's current site.
</UL>
<P>
<P>This argument is mandatory if the <B>-file</B> argument is not
provided.
<P><DT><B>-cell
</B><DD>Names the cell in which to run the command. Do not combine this
argument with the <B>-localauth</B> flag. For more details, see the
introductory <B>vos</B> reference page.
<P><DT><B>-noauth
</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
issuer. Do not combine this flag with the <B>-localauth</B>
flag. For more details, see the introductory <B>vos</B> reference
page.
<P><DT><B>-localauth
</B><DD>Constructs a server ticket using a key from the local
<B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
interpreter presents it to the Volume Server and Volume Location Server during
mutual authentication. Do not combine this flag with the
<B>-cell</B> argument or <B>-noauth</B> flag. For more details,
see the introductory <B>vos</B> reference page.
<P><DT><B>-verbose
</B><DD>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.
<P><DT><B>-help
</B><DD>Prints the online help for this command. All other valid options
are ignored.
</DL>
<P><STRONG>Examples</STRONG>
<P>The following command restores the contents of the dump file
<B>/afs/abc.com/common/dumps/terry.dump</B> to the
<B>/vicepc</B> partition on the file server machine
<B>fs3.abc.com</B>. The restored volume is named
<B>user.terry</B>.
<PRE> % <B>cd /afs/abc.com/common/dumps</B>
% <B>vos restore -file terry.dump -server fs3.abc.com -partition c</B> \
<B>-name user.terry</B>
</PRE>
<P><STRONG>Privilege Required</STRONG>
<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
the machine specified with the <B>-server</B> argument and on each
database server machine. If the <B>-localauth</B> flag is included,
the issuer must instead be logged on to a server machine as the local
superuser <B>root</B>.
<P><STRONG>Related Information</STRONG>
<P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
<P><A HREF="auarf260.htm#HDRVOS_DUMP">vos dump</A>
<P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
<P><A HREF="auarf266.htm#HDRVOS_LISTVOL">vos listvol</A>
<P>
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf273.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf275.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
<!-- Begin Footer Records ========================================== -->
<P><HR><B>
<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
</B>
<!-- End Footer Records ============================================ -->
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>