initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf260.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="auarf259.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="auarf261.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_DUMP" HREF="auarf002.htm#ToC_274">vos dump</A></H2>
19 <A NAME="IDX5642"></A>
20 <A NAME="IDX5643"></A>
21 <A NAME="IDX5644"></A>
22 <A NAME="IDX5645"></A>
23 <A NAME="IDX5646"></A>
24 <A NAME="IDX5647"></A>
25 <A NAME="IDX5648"></A>
26 <A NAME="IDX5649"></A>
27 <A NAME="IDX5650"></A>
28 <A NAME="IDX5651"></A>
29 <A NAME="IDX5652"></A>
30 <P><STRONG>Purpose</STRONG>
31 <P>Converts a volume into ASCII format and writes it to a file
32 <P><STRONG>Synopsis</STRONG>
33 <PRE><B>vos dump -id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-time</B> &lt;<VAR>dump&nbsp;from&nbsp;time</VAR>>]  [<B>-file</B> &lt;<VAR>dump&nbsp;file</VAR>>]  
34          [<B>-server</B> &lt;<VAR>server</VAR>>]  [<B>-partition</B> &lt;<VAR>partition</VAR>>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
35          [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
36     
37 <B>vos du -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-t</B> &lt;<VAR>dump&nbsp;from&nbsp;time</VAR>>]  [<B>-f</B> &lt;<VAR>dump&nbsp;file</VAR>>]  
38        [<B>-s</B> &lt;<VAR>server</VAR>>]  [<B>-p</B> &lt;<VAR>partition</VAR>>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
39        [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
40 </PRE>
41 <P><STRONG>Description</STRONG>
42 <P>The <B>vos dump</B> command converts the contents of the indicated
43 volume, which can be read/write, read-only or backup, into ASCII
44 format. The Volume Server writes the converted contents to the file
45 named by the <B>-file</B> argument, or to the standard output
46 stream. In the latter case, the output can be directed to a named pipe,
47 which enables interoperation with third-party backup utilities.
48 <P>To dump the complete contents of a volume (create a <I>full dump</I>),
49 omit the <B>-time</B> argument or specify the value <B>0</B> (zero)
50 for it. To create an <I>incremental dump</I>, which includes only
51 the files and directories in the volume that have modification timestamps
52 later than a certain time, specify a date and time as the value for the
53 <B>-time</B> argument.
54 <P>By default, the <B>vos</B> command interpreter consults the Volume
55 Location Database (VLDB) to learn the volume's location, so the
56 <B>-server</B> and <B>-partition</B> arguments are not
57 required. If the <B>-id</B> argument identifies a read-only volume
58 that resides at multiple sites, the command dumps the version from just one of
59 them (normally, the one listed first in the volume's VLDB entry as
60 reported by the <B>vos examine</B> or <B>vos listvldb</B>
61 command). To dump the read-only volume from a particular site, use the
62 <B>-server</B> and <B>-partition</B> arguments to specify the
63 site. To bypass the VLDB lookup entirely, provide a volume ID number
64 (rather than a volume name) as the value for the <B>-id</B> argument,
65 together with the <B>-server</B> and <B>-partition</B>
66 arguments. This makes it possible to dump a volume for which there is
67 no VLDB entry.
68 <P>During the dump operation, the volume is inaccessible both to Cache
69 Managers and to other volume operations. Dumping a volume does not
70 otherwise affect its status on the partition or its VLDB entry.
71 <P>To restore a dumped volume back into AFS, use the <B>vos restore</B>
72 command.
73 <P><STRONG>Cautions</STRONG>
74 <P>Support for incremental dumps is provided to facilitate interoperation with
75 third-party backup utilities. The <B>vos dump</B> command does not
76 provide any of the administrative facilities of an actual backup system, so
77 the administrator must keep manual records of dump times and the relationship
78 between full and incremental dumps of a volume. For a volume's
79 contents to be consistent after restoration of incremental dumps, there must
80 be no gap between the time at which a prior dump of the volume was created and
81 the value of the <B>-time</B> argument to the <B>vos dump</B> command
82 that creates the incremental dump. More specifically, for a read/write
83 volume, the <B>-time</B> argument must specify the time that the prior
84 dump was performed, and for a read-only or backup volume it must specify the
85 time that the volume was last released (using the <B>vos release</B>
86 command) or cloned (using the <B>vos backup</B> or <B>vos
87 backupsys</B> command) prior to dumping it. The parent dump can be
88 either a full dump or another incremental dump.
89 <P><STRONG>Options</STRONG>
90 <DL>
91 <P><DT><B>-id
92 </B><DD>Specifies either the complete name or volume ID number of the read/write,
93 read-only, or backup volume to dump.
94 <P><DT><B>-time
95 </B><DD>Specifies whether the dump is full or incremental. Omit this
96 argument to create a full dump, or provide one of three acceptable
97 values: 
98 <UL>
99 <P><LI>The value <B>0</B> (zero) to create a full dump.
100 <P><LI>A date in the format
101 <VAR>mm</VAR><B>/</B><VAR>dd</VAR><B>/</B><VAR>yyyy</VAR> (month, day and
102 year) to create an incremental dump that includes only files and directories
103 with modification timestamps later than midnight (12:00
104 a.m.) on the indicated date. Valid values for the year
105 range from <B>1970</B> to <B>2037</B>; higher values are not
106 valid because the latest possible date in the standard UNIX representation is
107 in 2038. The command interpreter automatically reduces later dates to
108 the maximum value. An example is <B>01/13/1999</B>.
109 <P><LI>A date and time in the format
110 <B>"</B><VAR>mm</VAR><B>/</B><VAR>dd</VAR><B>/</B><VAR>yyyy</VAR>
111 <VAR>hh</VAR><B>:</B><VAR>MM</VAR><B>"</B> to create an incremental
112 dump that includes only files and directories with modification timestamps
113 later than the specified date and time. The date format is the same as
114 for a date alone. Express the time as hours and minutes
115 (<VAR>hh</VAR>:<VAR>MM</VAR>) in 24-hour format (for example,
116 <B>20:30</B> is 8:30 p.m.). Surround the
117 entire expression with double quotes (" ") because it contains a space.
118 An example is <B>"01/13/1999 22:30"</B>.
119 </UL>
120 <P><DT><B>-file
121 </B><DD>Specifies the pathname of the file to which to write the dump. The
122 file can be in AFS, but not in the volume being dumped. A partial
123 pathname is interpreted relative to the current working directory. If
124 this argument is omitted, the dump is directed to the standard output
125 stream.
126 <P><DT><B>-server
127 </B><DD>Specifies the file server machine on which the volume resides.
128 Provide the <B>-partition</B> argument along with this one.
129 <P><DT><B>-partition
130 </B><DD>Specifies the partition on which the volume resides. Provide the
131 <B>-server</B> argument along with this one.
132 <P><DT><B>-cell
133 </B><DD>Names the cell in which to run the command. Do not combine this
134 argument with the <B>-localauth</B> flag. For more details, see the
135 introductory <B>vos</B> reference page.
136 <P><DT><B>-noauth
137 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
138 issuer. Do not combine this flag with the <B>-localauth</B>
139 flag. For more details, see the introductory <B>vos</B> reference
140 page.
141 <P><DT><B>-localauth
142 </B><DD>Constructs a server ticket using a key from the local
143 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
144 interpreter presents it to the Volume Server and Volume Location Server during
145 mutual authentication. Do not combine this flag with the
146 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
147 see the introductory <B>vos</B> reference page.
148 <P><DT><B>-verbose
149 </B><DD>Produces on the standard output stream a detailed trace of the
150 command's execution. If this argument is omitted, only warnings
151 and error messages appear.
152 <P><DT><B>-help
153 </B><DD>Prints the online help for this command. All other valid options
154 are ignored.
155 </DL>
156 <P><STRONG>Examples</STRONG>
157 <P>The following command writes a full dump of the volume
158 <B>user.terry</B> to the file
159 <B>/afs/abc.com/common/dumps/terry.dump</B>.
160 <PRE>   % <B>vos dump -id user.terry -time 0 -file /afs/abc.com/common/dumps/terry.dump</B>
161    
162 </PRE>
163 <P>The following command writes an incremental dump of the volume
164 <B>user.smith</B> to the file
165 <B>smith.990131.dump</B> in the current working
166 directory. Only those files in the volume with modification time stamps
167 later than 6:00 p.m. on 31 January 1999 are included in
168 the dump.
169 <PRE>   % <B>vos dump -id user.smith -time "01/31/1999 18:00" -file smith.990131.dump</B>
170    
171 </PRE>
172 <P><STRONG>Privilege Required</STRONG>
173 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
174 the machine specified with the <B>-server</B> argument and on each
175 database server machine. If the <B>-localauth</B> flag is included,
176 the issuer must instead be logged on to a server machine as the local
177 superuser <B>root</B>.
178 <P>If the <B>-file</B> argument is included, the issuer must also have
179 permission to insert and write in the directory that houses the file.
180 <P><STRONG>Related Information</STRONG>
181 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
182 <P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
183 <P><A HREF="auarf265.htm#HDRVOS_LISTVLDB">vos listvldb</A>
184 <P><A HREF="auarf274.htm#HDRVOS_RESTORE">vos restore</A>
185 <P>
186 <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="auarf259.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="auarf261.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> 
187 <!-- Begin Footer Records  ========================================== -->
188 <P><HR><B> 
189 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
190 </B> 
191 <!-- End Footer Records  ============================================ -->
192 <A NAME="Bot_Of_Page"></A>
193 </BODY></HTML>