darwin-build-updates-20010910
[openafs.git] / doc / html / AdminReference / auarf259.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="auarf258.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="auarf260.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_DELENTRY" HREF="auarf002.htm#ToC_273">vos delentry</A></H2>
19 <A NAME="IDX5638"></A>
20 <A NAME="IDX5639"></A>
21 <A NAME="IDX5640"></A>
22 <A NAME="IDX5641"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Removes a volume entry from the VLDB.
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>vos delentry</B> [<B>-id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>><SUP>+</SUP>]
27              [<B>-prefix</B> &lt;<VAR>prefix&nbsp;of&nbsp;volume&nbsp;whose&nbsp;VLDB&nbsp;entry&nbsp;is&nbsp;to&nbsp;be&nbsp;deleted</VAR>>] 
28              [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]  
29              [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
30      
31 <B>vos de</B> [<B>-i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>><SUP>+</SUP>]
32        [<B>-pr</B> &lt;<VAR>prefix&nbsp;of&nbsp;volume&nbsp;whose&nbsp;VLDB&nbsp;entry&nbsp;is&nbsp;to&nbsp;be&nbsp;deleted</VAR>>]  
33        [<B>-s</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-pa</B> &lt;<VAR>partition&nbsp;name</VAR>>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>] 
34        [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
35 </PRE>
36 <P><STRONG>Description</STRONG>
37 <P>The <B>vos delentry</B> command removes the Volume Location Database
38 (VLDB) entry for each specified volume. A specified volume can be any
39 of the three types (read/write, read-only, or backup), but the entire entry is
40 removed no matter which type is provided. The command has no effect on
41 the actual volumes on file server machines, if they exist.
42 <P>This command is useful if a volume removal operation did not update the
43 VLDB (perhaps because the <B>vos zap</B> command was used), but the system
44 administrator does not feel it is necessary to use the <B>vos syncserv</B>
45 and <B>vos syncvldb</B> commands to synchronize an entire file server
46 machine.
47 <P>To remove the VLDB entry for a single volume, use the <B> -id</B>
48 argument. To remove groups of volumes, combine the <B> -prefix</B>,
49 <B>-server</B>, and <B>-partition</B> arguments. The following
50 list describes how to remove the VLDB entry for the indicated group of
51 volumes:
52 <UL>
53 <P><LI>For every volume whose name begins with a certain character string (for
54 example, <B>sys.</B> or <B>user.</B>): use the
55 <B>-prefix</B> argument.
56 <P><LI>Every volume for which the VLDB lists a site on a certain file server
57 machine: specify the file server name with the <B>-server</B>
58 argument.
59 <P><LI>Every volume for which the VLDB lists a site on a partition of the same
60 name (for instance, on the <B>/vicepa</B> partition on any file server
61 machine): specify the partition name with the <B> -partition</B>
62 argument.
63 <P><LI>Every volume for which the VLDB lists a site one a specific partition of a
64 file server machine: specify both the <B>-server</B> and
65 <B>-partition</B> arguments.
66 <P><LI>Every volume whose name begins with a certain prefix and for which the
67 VLDB lists a site on a file server machine: combine the
68 <B>-prefix</B> and <B>-server</B> arguments. Combine the
69 <B>-prefix</B> argument with the <B>-partition</B> argument, or both
70 the <B>-server</B> and <B>-partition</B> arguments, to remove a more
71 specific group of volumes.
72 </UL>
73 <P><STRONG>Cautions</STRONG>
74 <P>Do not use this command to remove a volume in normal circumstances; it
75 does not remove a volume from the file server machine, and so is likely to
76 make the VLDB inconsistent with state of the volumes on server
77 machines. Use the <B>vos remove</B> command to remove both the
78 volume and its VLDB entry.
79 <P><STRONG>Options</STRONG>
80 <DL>
81 <P><DT><B>-id
82 </B><DD>Specifies the complete name or the volume ID number of each volume for
83 which to remove the VLDB entry. The entire entry is removed, regardless
84 of whether the read/write, read-only, or backup version is indicated.
85 Provide this argument or some combination of the <B>-prefix</B>,
86 <B>-server</B>, and <B>-partition</B> arguments.
87 <P><DT><B>-prefix
88 </B><DD>Specifies a character string of any length; the VLDB entry for a
89 volume whose name begins with the string is removed. Include field
90 separators (such as periods) if appropriate. Combine this argument with
91 the <B>-server</B> argument, <B>-partition</B> argument, or
92 both.
93 <P><DT><B>-server
94 </B><DD>Identifies a file server machine; if a volume's VLDB entry lists
95 a site on the machine, the entry is removed. Provide the machine's
96 IP address or its host name (either fully qualified or using an unambiguous
97 abbreviation). For details, see the introductory reference page for the
98 <B>vos</B> command suite. 
99 <P>Combine this argument with the <B>-prefix</B> argument, the
100 <B>-partition</B> argument, or both.
101 <P><DT><B>-partition
102 </B><DD>Identifies a partition; if a volume's VLDB entry lists a site on
103 the partition, the entry is removed. Provide the partition's
104 complete name with preceding slash (for example, <B>/vicepa</B>) or use
105 one of the three acceptable abbreviated forms. For details, see the
106 introductory reference page for the <B>vos</B> command suite. 
107 <P>Combine this argument with the <B>-prefix</B> argument, the
108 <B>-server</B> argument, or both.
109 <P><DT><B>-cell
110 </B><DD>Names the cell in which to run the command. Do not combine this
111 argument with the <B>-localauth</B> flag. For more details, see the
112 introductory <B>vos</B> reference page.
113 <P><DT><B>-noauth
114 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
115 issuer. Do not combine this flag with the <B>-localauth</B>
116 flag. For more details, see the introductory <B>vos</B> reference
117 page.
118 <P><DT><B>-localauth
119 </B><DD>Constructs a server ticket using a key from the local
120 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
121 interpreter presents it to the Volume Server and Volume Location Server during
122 mutual authentication. Do not combine this flag with the
123 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
124 see the introductory <B>vos</B> reference page.
125 <P><DT><B>-verbose
126 </B><DD>Produces on the standard output stream a detailed trace of the
127 command's execution. If this argument is omitted, only warnings
128 and error messages appear.
129 <P><DT><B>-help
130 </B><DD>Prints the online help for this command. All other valid options
131 are ignored.
132 </DL>
133 <P><STRONG>Output</STRONG>
134 <P>The following message confirms the success of the command by indicating how
135 many VLDB entries were removed.
136 <PRE>   Deleted <VAR>number</VAR> VLDB entries
137    
138 </PRE>
139 <P><STRONG>Examples</STRONG>
140 <P>The following command removes the VLDB entry for the volume
141 <B>user.temp</B>.
142 <PRE>   % <B>vos delentry user.temp</B>
143    
144 </PRE>
145 <P>The following command removes the VLDB entry for every volume whose name
146 begins with the string <B>test</B> and for which the VLDB lists a site on
147 the file server machine <B>fs3.abc.com</B>.
148 <PRE>   % <B>vos delentry -prefix test -server fs3.abc.com</B>
149    
150 </PRE>
151 <P><STRONG>Privilege Required</STRONG>
152 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
153 the machine specified with the <B>-server</B> argument and on each
154 database server machine. If the <B>-localauth</B> flag is included,
155 the issuer must instead be logged on to a server machine as the local
156 superuser <B>root</B>.
157 <P><STRONG>Related Information</STRONG>
158 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
159 <P><A HREF="auarf271.htm#HDRVOS_REMOVE">vos remove</A>
160 <P><A HREF="auarf276.htm#HDRVOS_SYNCSERV">vos syncserv</A>
161 <P><A HREF="auarf277.htm#HDRVOS_SYNCVLDB">vos syncvldb</A>
162 <P><A HREF="auarf280.htm#HDRVOS_ZAP">vos zap</A>
163 <P>
164 <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="auarf258.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="auarf260.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> 
165 <!-- Begin Footer Records  ========================================== -->
166 <P><HR><B> 
167 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
168 </B> 
169 <!-- End Footer Records  ============================================ -->
170 <A NAME="Bot_Of_Page"></A>
171 </BODY></HTML>