Initial IBM OpenAFS 1.0 tree
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf280.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="auarf279.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="auarf281.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_ZAP" HREF="auarf002.htm#ToC_294">vos zap</A></H2>
19 <A NAME="IDX5863"></A>
20 <A NAME="IDX5864"></A>
21 <A NAME="IDX5865"></A>
22 <A NAME="IDX5866"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Removes a volume from its site without writing to the VLDB
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>vos zap -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>> 
27         <B>-id</B> &lt;<VAR>volume ID</VAR>>  [<B>-force</B>]  [<B>-backup</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
28         [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
29     
30 <B>vos z -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>  <B>-i</B> &lt;<VAR>volume&nbsp;ID</VAR>>
31       [<B>-f</B>]  [<B>-b</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
32 </PRE>
33 <P><STRONG>Description</STRONG>
34 <P>The <B>vos zap</B> command removes the volume with the specified
35 <VAR>volume ID</VAR> from the site defined by the <B>-server</B> and
36 <B>-partition</B> arguments, without attempting to change the
37 corresponding Volume Location Database (VLDB) entry. If removing the
38 volume can possibly result in incorrect data in the VLDB, a warning message is
39 displayed.
40 <P>The <B>-force</B> flag removes a volume even if it cannot be "attached"
41 (brought online), which can happen either because the volume is extremely
42 damaged or because the Salvager functioned abnormally. Without this
43 flag, this command cannot remove volumes that are not attachable. See
44 also the <B>Cautions</B> section.
45 <P>To remove the specified read/write volume&#39;s backup version at the same
46 time, include the <B>-backup</B> flag.
47 <P><STRONG>Cautions</STRONG>
48 <P>Do not use this command as the standard way to remove a volume, as it is
49 likely to put the VLDB out of sync with the volumes on servers. Use the
50 <B>vos remove</B> command instead.
51 <P>This command is useful in situations where it is important to delete the
52 volume, but for some reason the VLDB is unreachable--for example, because
53 s the Volume Location Server is unavailable. The issuer can remove the
54 VLDB entry later with the <B>vos remove</B> or <B>vos delentry</B>
55 command, or it is removed automatically when the <B>vos syncserv</B> and
56 <B>vos syncvldb</B> commands run.
57 <P>To remove a read-only site defined in the VLDB by mistake, before a copy
58 actually exists at the site, use the <B>vos remsite</B> command. To
59 remove an entire VLDB entry without affecting volumes at their sites, use the
60 <B>vos delentry</B> command.
61 <P>Do not use the <B>-force</B> flag if the volume is online, but only
62 when attempts to remove the volume with the <B>vos remove</B> or the
63 <B>vos zap</B> command have failed, or the volume definitely cannot be
64 attached. After using the <B>-force</B> flag, make sure that the
65 volume&#39;s VLDB entry is also removed (issue the <B>vos delentry</B>
66 command if necessary).
67 <P>Adding the <B>-force</B> flag makes the command take considerably
68 longer--about as long as a salvage of the relevant partition--since
69 the Volume Server examines all inodes on the partition for traces of the
70 volume.
71 <P><STRONG>Options</STRONG>
72 <DL>
73 <P><DT><B>-server
74 </B><DD>Identifies the file server machine from which to remove the volume.
75 Provide the machine&#39;s IP address or its host name (either fully qualified
76 or using an unambiguous abbreviation). For details, see the
77 introductory reference page for the <B>vos</B> command suite.
78 <P><DT><B>-partition
79 </B><DD>Identifies the partition (on the file server machine specified by the
80 <B>-server</B> argument) from which to remove the volume. Provide
81 the partition&#39;s complete name with preceding slash (for example,
82 <B>/vicepa</B>) or use one of the three acceptable abbreviated
83 forms. For details, see the introductory reference page for the
84 <B>vos</B> command suite.
85 <P><DT><B>-id
86 </B><DD>Specifies the volume ID number of the volume to remove, which can be of
87 any of the three types. The volume name is not acceptable.
88 <P><DT><B>-force
89 </B><DD>Removes the volume even though it cannot be attached (brought
90 online). Use only after the failure of previous attempts to remove the
91 volume by using the <B>vos remove</B> command or the <B>vos</B>
92 command without this flag.
93 <P><DT><B>-backup
94 </B><DD>Removes the backup version of the read/write volume specified by the
95 <B>-id</B> argument. Do not use this flag if the <B>-id</B>
96 argument identifies a read-only or backup volume.
97 <P><DT><B>-cell
98 </B><DD>Names the cell in which to run the command. Do not combine this
99 argument with the <B>-localauth</B> flag. For more details, see the
100 introductory <B>vos</B> reference page.
101 <P><DT><B>-noauth
102 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
103 issuer. Do not combine this flag with the <B>-localauth</B>
104 flag. For more details, see the introductory <B>vos</B> reference
105 page.
106 <P><DT><B>-localauth
107 </B><DD>Constructs a server ticket using a key from the local
108 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
109 interpreter presents it to the Volume Server and Volume Location Server during
110 mutual authentication. Do not combine this flag with the
111 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
112 see the introductory <B>vos</B> reference page.
113 <P><DT><B>-verbose
114 </B><DD>Produces on the standard output stream a detailed trace of the
115 command&#39;s execution. If this argument is omitted, only warnings
116 and error messages appear.
117 <P><DT><B>-help
118 </B><DD>Prints the online help for this command. All other valid options
119 are ignored.
120 </DL>
121 <P><STRONG>Examples</STRONG>
122 <P>The following example removes the volume with volume ID 536870988 from the
123 <B>/vicepf</B> partition of the file server machine
124 <B>fs6.abc.com</B>, without noting the change in the
125 VLDB.
126 <PRE>   % <B>vos zap -server fs6.abc.com -partition f -id 536870988</B>
127    
128 </PRE>
129 <P><STRONG>Privilege Required</STRONG>
130 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
131 the machine specified with the <B>-server</B> argument and on each
132 database server machine. If the <B>-localauth</B> flag is included,
133 the issuer must instead be logged on to a server machine as the local
134 superuser <B>root</B>.
135 <P><STRONG>Related Information</STRONG>
136 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
137 <P><A HREF="auarf259.htm#HDRVOS_DELENTRY">vos delentry</A>
138 <P><A HREF="auarf271.htm#HDRVOS_REMOVE">vos remove</A>
139 <P><A HREF="auarf272.htm#HDRVOS_REMSITE">vos remsite</A>
140 <P>
141 <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="auarf279.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="auarf281.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> 
142 <!-- Begin Footer Records  ========================================== -->
143 <P><HR><B> 
144 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
145 </B> 
146 <!-- End Footer Records  ============================================ -->
147 <A NAME="Bot_Of_Page"></A>
148 </BODY></HTML>