initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf274.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <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> 
17 <P>
18 <H2><A NAME="HDRVOS_RESTORE" HREF="auarf002.htm#ToC_288">vos restore</A></H2>
19 <A NAME="IDX5829"></A>
20 <A NAME="IDX5830"></A>
21 <A NAME="IDX5831"></A>
22 <A NAME="IDX5832"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Converts an ASCII file into proper volume format and writes it to the file
25 system
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>vos restore -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>  
28             <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>>]  
29             [<B>-id</B> &lt;<VAR>volume&nbsp;ID</VAR>>]  [<B>-overwrite</B> &lt;<B>abort</B> | <B>full</B> | <B>incremental</B>>]  
30             [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  
31             [<B>-help</B>]
32    
33 <B>vos res -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>  
34         <B>-na</B> &lt;<VAR>name of volume to be restored</VAR>>  [<B>-f</B> &lt;<VAR>dump&nbsp;file</VAR>>]  
35         [<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>>]  
36         [<B>-no</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
37 </PRE>
38 <P><STRONG>Description</STRONG>
39 <P>The <B>vos restore</B> command converts a volume dump file previously
40 created with the <B>vos dump</B> command from ASCII into the volume format
41 appropriate for the machine type indicated by the <B>-server</B> argument,
42 and restores it as a read/write volume to the partition named by the
43 <B>-partition</B> argument on that machine. The Volume Server
44 assigns the volume name indicated with the <B>-name</B> argument, and
45 resets the volume's creation timestamp to the time at which the restore
46 operation begins (the creation timestamp is stored in the volume header and
47 reported in the <TT>Creation</TT> field in the output from the <B>vos
48 examine</B> and <B>vos listvol</B> commands.)
49 <P>Use the <B>-file</B> argument to name the dump file, or omit the
50 argument to provide the file via the standard input stream, presumably through
51 a pipe. The pipe can be named, which enables interoperation with
52 third-party backup utilities.
53 <P>As described in the following list, the command can create a completely new
54 volume or overwrite an existing volume. In all cases, the full dump of
55 the volume must be restored before any incremental dumps. If there are
56 multiple incremental dump files, they must be restored in the order they were
57 created.
58 <UL>
59 <P><LI>To create a new read/write volume, use the <B>-name</B> argument to
60 specify a volume name that does not already exist in the Volume Location
61 Database (VLDB), and the <B>-server</B> and <B>-partition</B>
62 arguments to specify the new volume's site. It is best to omit the
63 <B>-id</B> argument so that the Volume Location (VL) Server allocates a
64 volume ID automatically. Do not include the <B>-overwrite</B>
65 argument, because there is no existing volume to overwrite.
66 <P><LI>To overwrite an existing volume at its current site, specify its name and
67 site with the <B>-name</B>, <B>-server</B>, and <B>-partition</B>
68 arguments. The volume retains its current volume ID number unless the
69 <B>-id</B> argument is provided. Specify the value <B>f</B> or
70 <B>i</B> for the <B>-overwrite</B> argument to indicate whether the
71 dump file is full or incremental, respectively.
72 <P><LI>To overwrite an existing volume and move it to a new site, specify its
73 name and the new site with the <B>-name</B>, <B>-server</B>, and
74 <B>-partition</B> arguments. The volume retains its current volume
75 ID number unless the <B>-id</B> argument is provided. The volume is
76 removed from its original site. Specify the value <B>f</B> for the
77 <B>-overwrite</B> argument to indicate that the dump file is a full dump
78 (it is not possible to restore an incremental dump and move the volume at the
79 same time).
80 </UL>
81 <P>If the volume named by the <B>-name</B> argument already exists and the
82 <B>-overwrite</B> argument is omitted, the command interpreter produces
83 the following prompt:
84 <P>
85 <PRE>   Do you want to do a full/incremental restore or abort? [fia](a):
86    
87 </PRE>
88 <P>Respond by entering one of the following values:
89 <UL>
90 <P><LI><B>f</B> if restoring a full dump file
91 <P><LI><B>i</B> if restoring an incremental dump file
92 <P><LI><B>a</B> or &lt;<B>Return</B>> to cancel the restore operation
93 </UL>
94 <P><STRONG>Cautions</STRONG>
95 <P>If the <B>-file</B> argument is omitted, the issuer must provide all
96 other necessary arguments, because the standard input stream is unavailable
97 for responding to the command interpreter's prompts for missing
98 information. In particular, the issuer must provide the
99 <B>-overwrite</B> argument if overwriting an existing volume.
100 <P><STRONG>Options</STRONG>
101 <DL>
102 <P><DT><B>-server
103 </B><DD>Identifies the file server machine onto which to restore the
104 volume. Provide the machine's IP address or its host name (either
105 fully qualified or using an unambiguous abbreviation). For details, see
106 the introductory reference page for the <B>vos</B> command suite.
107 <P><DT><B>-partition
108 </B><DD>Identifies the partition (on the file server machine specified by the
109 <B>-server</B> argument) onto which to restore the volume. Provide
110 the partition's complete name with preceding slash (for example,
111 <B>/vicepa</B>) or use one of the three acceptable abbreviated
112 forms. For details, see the introductory reference page for the
113 <B>vos</B> command suite.
114 <P><DT><B>-name
115 </B><DD>Specifies the name under which to restore the volume. It can be up
116 to 22 characters long, but cannot end with a <B>.readonly</B> or
117 <B>.backup</B> extension. If the volume already exists, it
118 is overwritten subject to the value of the <B>-overwrite</B>
119 argument.
120 <P><DT><B>-file
121 </B><DD>Names the dump file to restore. Incomplete pathnames are
122 interpreted relative to the current working directory. Omit this
123 argument to provide the dump file via the standard input stream.
124 <P><DT><B>-id
125 </B><DD>Specifies the volume ID number to assign to the restored volume.
126 <P><DT><B>-overwrite
127 </B><DD>Specifies which type of dump file is being restored when overwriting an
128 existing volume. Provide one of the following values:
129 <UL>
130 <P><LI><B>a</B> to terminate the restore operation.
131 <P><LI><B>f</B> if restoring a full dump file.
132 <P><LI><B>i</B> if restoring an incremental dump file. This value is
133 not acceptable if the <B>-server</B> and <B>-partition</B> arguments
134 do not indicate the volume's current site.
135 </UL>
136 <P>
137 <P>This argument is mandatory if the <B>-file</B> argument is not
138 provided.
139 <P><DT><B>-cell
140 </B><DD>Names the cell in which to run the command. Do not combine this
141 argument with the <B>-localauth</B> flag. For more details, see the
142 introductory <B>vos</B> reference page.
143 <P><DT><B>-noauth
144 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
145 issuer. Do not combine this flag with the <B>-localauth</B>
146 flag. For more details, see the introductory <B>vos</B> reference
147 page.
148 <P><DT><B>-localauth
149 </B><DD>Constructs a server ticket using a key from the local
150 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
151 interpreter presents it to the Volume Server and Volume Location Server during
152 mutual authentication. Do not combine this flag with the
153 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
154 see the introductory <B>vos</B> reference page.
155 <P><DT><B>-verbose
156 </B><DD>Produces on the standard output stream a detailed trace of the
157 command's execution. If this argument is omitted, only warnings
158 and error messages appear.
159 <P><DT><B>-help
160 </B><DD>Prints the online help for this command. All other valid options
161 are ignored.
162 </DL>
163 <P><STRONG>Examples</STRONG>
164 <P>The following command restores the contents of the dump file
165 <B>/afs/abc.com/common/dumps/terry.dump</B> to the
166 <B>/vicepc</B> partition on the file server machine
167 <B>fs3.abc.com</B>. The restored volume is named
168 <B>user.terry</B>.
169 <PRE>   % <B>cd /afs/abc.com/common/dumps</B>
170    
171    % <B>vos restore -file terry.dump -server fs3.abc.com -partition c</B>  \
172                  <B>-name user.terry</B>
173    
174 </PRE>
175 <P><STRONG>Privilege Required</STRONG>
176 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
177 the machine specified with the <B>-server</B> argument and on each
178 database server machine. If the <B>-localauth</B> flag is included,
179 the issuer must instead be logged on to a server machine as the local
180 superuser <B>root</B>.
181 <P><STRONG>Related Information</STRONG>
182 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
183 <P><A HREF="auarf260.htm#HDRVOS_DUMP">vos dump</A>
184 <P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
185 <P><A HREF="auarf266.htm#HDRVOS_LISTVOL">vos listvol</A>
186 <P>
187 <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> 
188 <!-- Begin Footer Records  ========================================== -->
189 <P><HR><B> 
190 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
191 </B> 
192 <!-- End Footer Records  ============================================ -->
193 <A NAME="Bot_Of_Page"></A>
194 </BODY></HTML>