initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf259.htm
diff --git a/doc/html/AdminReference/auarf259.htm b/doc/html/AdminReference/auarf259.htm
new file mode 100644 (file)
index 0000000..e287f22
--- /dev/null
@@ -0,0 +1,171 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<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> 
+<P>
+<H2><A NAME="HDRVOS_DELENTRY" HREF="auarf002.htm#ToC_273">vos delentry</A></H2>
+<A NAME="IDX5638"></A>
+<A NAME="IDX5639"></A>
+<A NAME="IDX5640"></A>
+<A NAME="IDX5641"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Removes a volume entry from the VLDB.
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>vos delentry</B> [<B>-id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>><SUP>+</SUP>]
+             [<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>>] 
+             [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]  
+             [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
+     
+<B>vos de</B> [<B>-i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>><SUP>+</SUP>]
+       [<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>>]  
+       [<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>>] 
+       [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>vos delentry</B> command removes the Volume Location Database
+(VLDB) entry for each specified volume. A specified volume can be any
+of the three types (read/write, read-only, or backup), but the entire entry is
+removed no matter which type is provided. The command has no effect on
+the actual volumes on file server machines, if they exist.
+<P>This command is useful if a volume removal operation did not update the
+VLDB (perhaps because the <B>vos zap</B> command was used), but the system
+administrator does not feel it is necessary to use the <B>vos syncserv</B>
+and <B>vos syncvldb</B> commands to synchronize an entire file server
+machine.
+<P>To remove the VLDB entry for a single volume, use the <B> -id</B>
+argument. To remove groups of volumes, combine the <B> -prefix</B>,
+<B>-server</B>, and <B>-partition</B> arguments. The following
+list describes how to remove the VLDB entry for the indicated group of
+volumes:
+<UL>
+<P><LI>For every volume whose name begins with a certain character string (for
+example, <B>sys.</B> or <B>user.</B>): use the
+<B>-prefix</B> argument.
+<P><LI>Every volume for which the VLDB lists a site on a certain file server
+machine: specify the file server name with the <B>-server</B>
+argument.
+<P><LI>Every volume for which the VLDB lists a site on a partition of the same
+name (for instance, on the <B>/vicepa</B> partition on any file server
+machine): specify the partition name with the <B> -partition</B>
+argument.
+<P><LI>Every volume for which the VLDB lists a site one a specific partition of a
+file server machine: specify both the <B>-server</B> and
+<B>-partition</B> arguments.
+<P><LI>Every volume whose name begins with a certain prefix and for which the
+VLDB lists a site on a file server machine: combine the
+<B>-prefix</B> and <B>-server</B> arguments. Combine the
+<B>-prefix</B> argument with the <B>-partition</B> argument, or both
+the <B>-server</B> and <B>-partition</B> arguments, to remove a more
+specific group of volumes.
+</UL>
+<P><STRONG>Cautions</STRONG>
+<P>Do not use this command to remove a volume in normal circumstances; it
+does not remove a volume from the file server machine, and so is likely to
+make the VLDB inconsistent with state of the volumes on server
+machines. Use the <B>vos remove</B> command to remove both the
+volume and its VLDB entry.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>-id
+</B><DD>Specifies the complete name or the volume ID number of each volume for
+which to remove the VLDB entry. The entire entry is removed, regardless
+of whether the read/write, read-only, or backup version is indicated.
+Provide this argument or some combination of the <B>-prefix</B>,
+<B>-server</B>, and <B>-partition</B> arguments.
+<P><DT><B>-prefix
+</B><DD>Specifies a character string of any length; the VLDB entry for a
+volume whose name begins with the string is removed. Include field
+separators (such as periods) if appropriate. Combine this argument with
+the <B>-server</B> argument, <B>-partition</B> argument, or
+both.
+<P><DT><B>-server
+</B><DD>Identifies a file server machine; if a volume's VLDB entry lists
+a site on the machine, the entry is removed. Provide the machine's
+IP address or its host name (either fully qualified or using an unambiguous
+abbreviation). For details, see the introductory reference page for the
+<B>vos</B> command suite. 
+<P>Combine this argument with the <B>-prefix</B> argument, the
+<B>-partition</B> argument, or both.
+<P><DT><B>-partition
+</B><DD>Identifies a partition; if a volume's VLDB entry lists a site on
+the partition, the entry is removed. Provide the partition's
+complete name with preceding slash (for example, <B>/vicepa</B>) or use
+one of the three acceptable abbreviated forms. For details, see the
+introductory reference page for the <B>vos</B> command suite. 
+<P>Combine this argument with the <B>-prefix</B> argument, the
+<B>-server</B> argument, or both.
+<P><DT><B>-cell
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>vos</B> reference page.
+<P><DT><B>-noauth
+</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
+issuer. Do not combine this flag with the <B>-localauth</B>
+flag. For more details, see the introductory <B>vos</B> reference
+page.
+<P><DT><B>-localauth
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
+interpreter presents it to the Volume Server and Volume Location Server during
+mutual authentication. Do not combine this flag with the
+<B>-cell</B> argument or <B>-noauth</B> flag. For more details,
+see the introductory <B>vos</B> reference page.
+<P><DT><B>-verbose
+</B><DD>Produces on the standard output stream a detailed trace of the
+command's execution. If this argument is omitted, only warnings
+and error messages appear.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Output</STRONG>
+<P>The following message confirms the success of the command by indicating how
+many VLDB entries were removed.
+<PRE>   Deleted <VAR>number</VAR> VLDB entries
+   
+</PRE>
+<P><STRONG>Examples</STRONG>
+<P>The following command removes the VLDB entry for the volume
+<B>user.temp</B>.
+<PRE>   % <B>vos delentry user.temp</B>
+   
+</PRE>
+<P>The following command removes the VLDB entry for every volume whose name
+begins with the string <B>test</B> and for which the VLDB lists a site on
+the file server machine <B>fs3.abc.com</B>.
+<PRE>   % <B>vos delentry -prefix test -server fs3.abc.com</B>
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+the machine specified with the <B>-server</B> argument and on each
+database server machine. If the <B>-localauth</B> flag is included,
+the issuer must instead be logged on to a server machine as the local
+superuser <B>root</B>.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
+<P><A HREF="auarf271.htm#HDRVOS_REMOVE">vos remove</A>
+<P><A HREF="auarf276.htm#HDRVOS_SYNCSERV">vos syncserv</A>
+<P><A HREF="auarf277.htm#HDRVOS_SYNCVLDB">vos syncvldb</A>
+<P><A HREF="auarf280.htm#HDRVOS_ZAP">vos zap</A>
+<P>
+<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> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>