fsbnode-rename-unused-to-dummy-20090604
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf256.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf255.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="auarf257.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_BACKUPSYS" HREF="auarf002.htm#ToC_270">vos backupsys</A></H2>
19 <A NAME="IDX5605"></A>
20 <A NAME="IDX5606"></A>
21 <A NAME="IDX5607"></A>
22 <A NAME="IDX5608"></A>
23 <A NAME="IDX5609"></A>
24 <A NAME="IDX5610"></A>
25 <A NAME="IDX5611"></A>
26 <P><STRONG>Purpose</STRONG>
27 <P>Creates a backup volume for several read/write volumes
28 <P><STRONG>Synopsis</STRONG>
29 <PRE><B>vos backupsys</B> [<B>-prefix</B> &lt;<VAR>common&nbsp;prefix&nbsp;on&nbsp;volume(s)</VAR>><SUP>+</SUP>]  
30               [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]  
31               [<B>-exclude</B>]  [<B>-xprefix</B> &lt;<VAR>negative&nbsp;prefix&nbsp;on&nbsp;volume(s)</VAR>><SUP>+</SUP>] 
32               [<B>-dryrun</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]
33               [<B>-verbose</B>]  [<B>-help</B>] 
34     
35 <B>vos backups</B> [<B>-pr</B> &lt;<VAR>common&nbsp;prefix&nbsp;on&nbsp;volume(s)</VAR>><SUP>+</SUP>]  [<B>-s</B> &lt;<VAR>machine&nbsp;name</VAR>>] 
36             [<B>-pa</B> &lt;<VAR>partition&nbsp;name</VAR>>]  [<B>-e</B>]  [<B>-x</B> &lt;<VAR>negative&nbsp;prefix&nbsp;on&nbsp;volume(s)</VAR>><SUP>+</SUP>]  
37             [<B>-d</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
38 </PRE>
39 <P><STRONG>Description</STRONG>
40 <P>The <B>vos backupsys</B> command clones each indicated read/write
41 volume to create a backup version, placing each clone at the same site as its
42 read/write source version. It assigns each clone the same name as the
43 read/write source, adding a <B>.backup</B> extension. It
44 assigns the volume ID number already allocated for the backup version in the
45 Volume Location Database (VLDB). If a backup version already exists for
46 a given volume, the new clone replaces it.
47 <P>To clone every read/write volume listed in the VLDB, omit all of the
48 command&#39;s options. Otherwise, combine the command&#39;s options
49 to clone various groups of volumes. The options use one of two basic
50 criteria to select volumes&#58; location (the <B>-server</B> and
51 <B>-partition</B> arguments) or presence in the volume name of one of a
52 set of specified character strings (the <B>-prefix</B>,
53 <B>-exclude</B>, and <B>-xprefix</B> options).
54 <P>To clone only volumes that reside on one file server machine, include the
55 <B>-server</B> argument. To clone only volumes that reside on one
56 partition, combine the <B>-server</B> and <B>-partition</B>
57 arguments. The <B>-partition</B> argument can also be used alone to
58 clone volumes that reside on the indicated partition on every file server
59 machine. These arguments can be combined with those that select volumes
60 based on their names.
61 <P>Combine the <B>-prefix</B>, <B>-exclude</B>, and
62 <B>-xprefix</B> options (with or without the <B>-server</B> and
63 <B>-partition</B> arguments) in the indicated ways to select volumes based
64 on character strings contained in their names&#58;
65 <UL>
66 <P><LI>To clone every read/write volume at the specified location whose name
67 includes one of a set of specified character strings (for example, begins with
68 <B>user.</B> or includes the string <B>afs</B>), use the
69 <B>-prefix</B> argument or combine the <B>-xprefix</B> and
70 <B>-exclude</B> options.
71 <P><LI>To clone every read/write volume at the specified location except those
72 whose name includes one of a set of specified character strings, use the
73 <B>-xprefix</B> argument or combine the <B>-prefix</B> and
74 <B>-exclude</B> options.
75 <P><LI>To clone every read/write volume at the specified location whose name
76 includes one of one of a set of specified character strings, except those
77 whose names include one of a different set of specified character strings,
78 combine the <B>-prefix</B> and <B>-xprefix</B> arguments. The
79 command creates a list of all volumes that match the <B>-prefix</B>
80 argument and then removes from the list the volumes that match the
81 <B>-xprefix</B> argument. For effective results, the strings
82 specified by the <B>-xprefix</B> argument must designate a subset of the
83 volumes specified by the <B>-prefix</B> argument.
84 <P>If the <B>-exclude</B> flag is combined with the <B>-prefix</B> and
85 <B>-xprefix</B> arguments, the command creates a list of all volumes that
86 do not match the <B>-prefix</B> argument and then adds to the list any
87 volumes that match the <B>-xprefix</B> argument. As when the
88 <B>-exclude</B> flag is not used, the result is effective only if the
89 strings specified by the <B>-xprefix</B> argument designate a subset of
90 the volumes specified by the <B>-prefix</B> argument.
91 </UL>
92 <P>The <B>-prefix</B> and <B>-xprefix</B> arguments both accept
93 multiple values, which can be used to define disjoint groups of
94 volumes. Each value can be one of two types&#58;
95 <OL TYPE=1>
96 <P><LI>A simple character string, which matches volumes whose name begin with the
97 string. All characters are interpreted literally (that is, characters
98 that potentially have special meaning to the command shell, such as the
99 period, have only their literal meaning).
100 <P><LI>A regular expression, which matches volumes whose names contain the
101 expressions. Place a caret (&nbsp;<B>^</B>&nbsp;) at the
102 beginning of the expression, and enclose the entire string in single quotes
103 (<B>&#39;</B>&nbsp;<B>&#39;</B>). Explaining regular
104 expressions is outside the scope of this reference page; see the UNIX
105 manual page for <B>regexp(5)</B> or (for a brief introduction) the
106 <B>backup addvolentry</B> reference page in this document. As an
107 example, the following expression matches volumes that have the string
108 <B>aix</B> anywhere in their names&#58;
109 <PRE>   <B>-prefix  &#39;^.*aix&#39;</B>
110 </PRE>
111 </OL>
112 <P>To display a list of the volumes to be cloned, without actually cloning
113 them, include the <B>-dryrun</B> flag. To display a statement that
114 summarizes the criteria being used to select volume, include the
115 <B>-verbose</B> flag.
116 <P>This command can be used to clone a single read/write volume; specify
117 its complete name as the <B>-prefix</B> argument. However, it is
118 more efficient to use the <B>vos backup</B> command, which employs a more
119 streamlined technique for finding a single volume.
120 <P><STRONG>Options</STRONG>
121 <DL>
122 <P><DT><B>-prefix
123 </B><DD>Specifies one or more simple character strings or regular expressions of
124 any length; a volume whose name includes the string is placed on the set
125 of volumes to be cloned. Include field separators (such as periods) if
126 appropriate. This argument can be combined with any combination of the
127 <B>-server</B>, <B>-partition</B>, <B>-exclude</B>, and
128 <B>-xprefix</B> options.
129 <P><DT><B>-server
130 </B><DD>Identifies the file server machine where each read/write source volume
131 resides. Provide the machine&#39;s IP address or its host name (either
132 fully qualified or using an unambiguous abbreviation). For details, see
133 the introductory reference page for the <B>vos</B> command suite. 
134 <P>This argument can be combined with any combination of the
135 <B>-prefix</B>, <B>-partition</B>, <B>-exclude</B>, and
136 <B>-xprefix</B> options.
137 <P><DT><B><B>-partition</B>
138 </B><DD>Identifies the partition where each read/write source volume
139 resides. Provide the partition&#39;s complete name with preceding
140 slash (for example, <B>/vicepa</B>) or use one of the three acceptable
141 abbreviated forms. For details, see the introductory reference page for
142 the <B>vos</B> command suite. 
143 <P>This argument can be combined with any combination of the
144 <B>-prefix</B>, <B>-server</B>, <B>-exclude</B>, and
145 <B>-xprefix</B> options.
146 <P><DT><B>-exclude
147 </B><DD>Reverses the meaning of the <B>-prefix</B> or <B>-xprefix</B>
148 argument. This flag can be combined with any combination of the
149 <B>-prefix</B>, <B>-server</B>, <B>-partition</B>, and
150 <B>-xprefix</B> options.
151 <P><DT><B>-xprefix
152 </B><DD>Specifies a simple character string or regular expression of any
153 length; a volume whose name includes the string is removed from the set
154 of volumes to be cloned. Include field separators (such as periods) if
155 appropriate. This argument can be combined with any combination of the
156 <B>-prefix</B>, <B>-server</B>, <B>-partition</B>, and
157 <B>-exclude</B> options.
158 <P><DT><B>-dryrun
159 </B><DD>Displays on the standard output stream a list of the volumes to be cloned,
160 without actually cloning them.
161 <P><DT><B>-cell
162 </B><DD>Names the cell in which to run the command. Do not combine this
163 argument with the <B>-localauth</B> flag. For more details, see the
164 introductory <B>vos</B> reference page.
165 <P><DT><B>-noauth
166 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
167 issuer. Do not combine this flag with the <B>-localauth</B>
168 flag. For more details, see the introductory <B>vos</B> reference
169 page.
170 <P><DT><B>-localauth
171 </B><DD>Constructs a server ticket using a key from the local
172 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
173 interpreter presents it to the Volume Server and Volume Location Server during
174 mutual authentication. Do not combine this flag with the
175 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
176 see the introductory <B>vos</B> reference page.
177 <P><DT><B>-verbose
178 </B><DD>Produces on the standard output stream a detailed trace of the
179 command&#39;s execution. If this argument is omitted, only warnings
180 and error messages appear.
181 <P><DT><B>-help
182 </B><DD>Prints the online help for this command. All other valid options
183 are ignored.
184 </DL>
185 <P><STRONG>Output</STRONG>
186 <P>The command generates the following messages on the standard output stream
187 to confirm that the operation was successful&#58;
188 <PRE>   done
189    Total volumes backed up&#58; <VAR>number_cloned</VAR>; failed to backup&#58; <VAR>failures</VAR>
190 </PRE>
191 <P>If the <B>-dryrun</B> flag is included, a list of the volumes to be
192 backed up precedes the standard confirmation messages.
193 <P>If the <B>-verbose</B> flag is included but not the <B>-dryrun</B>
194 flag, the following messages appear for each volume. The output
195 concludes with the standard confirmation messages.
196 <PRE>   Creating backup volume for <VAR>volume_name</VAR> on <VAR>date/time</VAR>
197    {Recloning backup volume | Creating a new backup clone} <VAR>backup_volumeID</VAR> . . .done
198 </PRE>
199 <P>If both the <B>-dryrun</B> and <B>-verbose</B> flags are included,
200 the output begins with a statement summarizing the criteria being used to
201 select the volumes, followed by a list of the volumes and the standard
202 confirmation messages. The format of the criteria summary statement
203 depends on which other options are provided&#58;
204 <UL>
205 <P><LI>If only the <B>-prefix</B> argument is provided, or the
206 <B>-xprefix</B> and <B>-exclude</B> options are combined&#58;
207 <PRE>   Would have backed up volumes which are prefixed with <VAR>string</VAR> [or<VAR>string</VAR>] . .
208 </PRE>
209 <P><LI>If only the <B>-xprefix</B> argument is provided, or the
210 <B>-prefix</B> and <B>-exclude</B> options are combined&#58;
211 <PRE>   Would have backed up volumes which are not prefixed with <VAR>string</VAR> [nor<VAR>string</VAR>] . .
212 </PRE>
213 <P><LI>If the <B>-prefix</B> and <B>-xprefix</B> arguments are
214 combined&#58;
215 <PRE>   Would have backed up volumes which are prefixed with <VAR>string</VAR> [or<VAR>string</VAR>]  \
216       removing those which are prefixed with  <VAR>x_string</VAR> [or<VAR>x_string</VAR>] . .
217 </PRE>
218 <P><LI>If the <B>-prefix</B>, <B>-xprefix</B>, and <B>-exclude</B>
219 options are provided&#58;
220 <PRE>   Would have backed up volumes which are not prefixed with <VAR>string</VAR> [nor<VAR>string</VAR>]  \
221       adding those which are prefixed with  <VAR>x_string</VAR> [or<VAR>x_string</VAR>] . .
222 </PRE>
223 </UL>
224 <P><STRONG>Examples</STRONG>
225 <P>The following example creates a backup version of every read/write volume
226 listed in the cell&#39;s VLDB whose name begins with the string
227 <B>user</B>.
228 <PRE>   % <B>vos backupsys -prefix user</B>
229    
230 </PRE>
231 <P>The following example, appropriate in the ABC Corporation cell, creates a
232 backup version of every read/write volume on the file server machine
233 <B>fs3.abc.com</B>.
234 <PRE>   % <B>vos backupsys -server fs3.abc.com</B>
235    
236 </PRE>
237 <P>The following example, appropriate in the State University cell, creates a
238 backup version of every read/write volume on the file server machine
239 <B>db1.stateu.edu</B> except those whose name includes the
240 string <B>temp</B>.
241 <PRE>   % <B>vos backupsys  -server db1.stateu.edu -prefix &#39;^.*temp&#39;</B>
242    
243 </PRE>
244 <P>The following example creates a backup version of every volume listed in
245 the cell&#39;s VLDB, excluding those whose names contain the string
246 <B>source</B>, but including those whose names contain the string
247 <B>source.current</B>.
248 <PRE>   % <B>vos backupsys  -prefix &#39;^.*source&#39; -exclude -xprefix &#39;^.*source\.current&#39;</B>
249    
250 </PRE>
251 <P><STRONG>Privilege Required</STRONG>
252 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
253 the machine specified with the <B>-server</B> argument and on each
254 database server machine. If the <B>-localauth</B> flag is included,
255 the issuer must instead be logged on to a server machine as the local
256 superuser <B>root</B>.
257 <P><STRONG>Related Information</STRONG>
258 <P><A HREF="auarf063.htm#HDRBK_ADDVOLENTRY">backup addvolentry</A>
259 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
260 <P><A HREF="auarf255.htm#HDRVOS_BACKUP">vos backup</A>
261 <P>UNIX manual page for <B>regexp(5)</B>
262 <P>
263 <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="auarf255.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="auarf257.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> 
264 <!-- Begin Footer Records  ========================================== -->
265 <P><HR><B> 
266 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
267 </B> 
268 <!-- End Footer Records  ============================================ -->
269 <A NAME="Bot_Of_Page"></A>
270 </BODY></HTML>