remove-administration-reference-20080627
[openafs.git] / doc / html / AdminReference / auarf271.htm
diff --git a/doc/html/AdminReference/auarf271.htm b/doc/html/AdminReference/auarf271.htm
deleted file mode 100644 (file)
index e5915dc..0000000
+++ /dev/null
@@ -1,169 +0,0 @@
-<!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="auarf270.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="auarf272.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_REMOVE" HREF="auarf002.htm#ToC_285">vos remove</A></H2>
-<A NAME="IDX5805"></A>
-<A NAME="IDX5806"></A>
-<A NAME="IDX5807"></A>
-<A NAME="IDX5808"></A>
-<A NAME="IDX5809"></A>
-<A NAME="IDX5810"></A>
-<A NAME="IDX5811"></A>
-<A NAME="IDX5812"></A>
-<P><STRONG>Purpose</STRONG>
-<P>Removes a volume from a site
-<P><STRONG>Synopsis</STRONG>
-<PRE><B>vos remove</B> [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]
-           <B>-id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
-           [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
-    
-<B>vos remo</B> [<B>-s</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>]  <B>-i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</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 remove</B> command removes the indicated volume from the
-partition on which it resides. The Volume Location Database (VLDB)
-record is altered appropriately, as described in the following
-paragraphs. Use this command to remove any of the three types of
-volumes; the effect depends on the type.
-<UL>
-<P><LI>If the <B>-id</B> argument names the read/write volume (that is,
-specifies the volume's base name), both it and the associated backup
-volume are removed from the partition that houses them. The
-<B>-server</B> and <B>-partition</B> arguments are optional, because
-there can be only one read/write site. When the volume is removed, the
-site information is also removed from the VLDB entry. The read/write
-and backup volume ID numbers no longer appear in the output from the <B>vos
-listvldb</B> or <B>vos examine</B> commands, but they are preserved
-internally. Read-only sites, if any, are not affected, but cannot be
-changed unless a read/write site is again defined. The site count
-reported by the <B>vos examine</B> and <B>vos listvldb</B> commands as
-<TT>number of sites</TT> decrements by one. The entire VLDB entry is
-removed if there are no read-only sites.
-<P><LI>If the <B>-id</B> argument names a read-only volume, it is removed
-from the partition that houses it, and the corresponding site information is
-removed from the VLDB entry. The site count reported by the <B>vos
-examine</B> and <B>vos listvldb</B> commands as <TT>number of
-sites</TT> decrements by one for each volume you remove. If there is
-more than one read-only site, the <B>-server</B> argument (and optionally
-<B>-partition</B> argument) must be used to specify the site from which to
-remove the volume. If there is only one read-only site, the
-<B>-id</B> argument is sufficient; if there is also no read/write
-volume in this case, the entire VLDB entry is removed.
-<P><LI>If the <B>-id</B> argument names a backup volume, it is removed from
-the partition that houses it. The <B>-server</B> and
-<B>-partition</B> arguments are optional, because there can be only one
-backup site. The backup volume ID number no longer appears in the
-output from the <B>vos listvldb</B> command or in the corresponding
-portion of the output from the <B>vos examine</B> command, but is
-preserved internally.
-</UL>
-<P>This command is the most appropriate one for removing volumes in almost all
-cases. Other commands that remove only volumes or only VLDB entries
-(such as the <B>vos delentry</B>, <B>vos remsite</B> and <B>vos
-zap</B> commands) by definition can put the volumes and VLDB out of
-sync. Use them only in the special circumstances mentioned on their
-reference pages. Like the <B>vos delentry</B> command, this command
-can remove a VLDB entry when no corresponding volumes exist on the file server
-machine. Like the <B>vos zap</B> command, this command can remove a
-volume that does not have a VLDB entry, as long as the volume is online,
-<B>-server</B> and <B>-partition</B> arguments are provided, and the
-<B>-id</B> argument specifies the volume's ID number.
-<P><STRONG>Options</STRONG>
-<DL>
-<P><DT><B>-server
-</B><DD>Identifies the file server machine that houses the volume to
-remove. It is necessary only when the <B>-id</B> argument names a
-read-only volume that exists at multiple sites. 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><DT><B>-partition
-</B><DD>Identifies the partition (on the file server machine specified by the
-<B>-server</B> argument) that houses the volume to remove. 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>Including this argument is necessary only when the <B>-id</B> argument
-names a read-only volume that exists at multiple sites. Provide the
-<B>-server</B> argument along with this one.
-<P><DT><B>-id
-</B><DD>Identifies the volume to remove, either by its complete name or volume ID
-number. If identifying a read-only or backup volume by name, include
-the appropriate extension (<B>.readonly</B> or
-<B>.backup</B>).
-<TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT" VALIGN="TOP">If the <B>-server</B> and <B>-partition</B> arguments are omitted,
-the <B>-id</B> switch must be provided.
-</TD></TR></TABLE>
-<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>Examples</STRONG>
-<P>The following example removes the read/write volume
-<B>user.terry</B> and its backup version, if any.
-<PRE>   % <B>vos remove  -id user.terry</B>
-   
-</PRE>
-<P>The following example removes the read-only volume
-<B>root.afs.readonly</B> from one of its sites, the
-<B>/vicepa</B> partition on the file server machine
-<B>fs1.abc.com</B>.
-<PRE>   % <B>vos remove fs1.abc.com  a  root.afs.readonly</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="auarf259.htm#HDRVOS_DELENTRY">vos delentry</A>
-<P><A HREF="auarf272.htm#HDRVOS_REMSITE">vos remsite</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="auarf270.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="auarf272.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>