afsmonitor-update-stat-descriptions-20040729
[openafs.git] / doc / html / AdminReference / auarf271.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="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> 
17 <P>
18 <H2><A NAME="HDRVOS_REMOVE" HREF="auarf002.htm#ToC_285">vos remove</A></H2>
19 <A NAME="IDX5805"></A>
20 <A NAME="IDX5806"></A>
21 <A NAME="IDX5807"></A>
22 <A NAME="IDX5808"></A>
23 <A NAME="IDX5809"></A>
24 <A NAME="IDX5810"></A>
25 <A NAME="IDX5811"></A>
26 <A NAME="IDX5812"></A>
27 <P><STRONG>Purpose</STRONG>
28 <P>Removes a volume from a site
29 <P><STRONG>Synopsis</STRONG>
30 <PRE><B>vos remove</B> [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]
31            <B>-id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
32            [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
33     
34 <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>> 
35          [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
36 </PRE>
37 <P><STRONG>Description</STRONG>
38 <P>The <B>vos remove</B> command removes the indicated volume from the
39 partition on which it resides. The Volume Location Database (VLDB)
40 record is altered appropriately, as described in the following
41 paragraphs. Use this command to remove any of the three types of
42 volumes; the effect depends on the type.
43 <UL>
44 <P><LI>If the <B>-id</B> argument names the read/write volume (that is,
45 specifies the volume's base name), both it and the associated backup
46 volume are removed from the partition that houses them. The
47 <B>-server</B> and <B>-partition</B> arguments are optional, because
48 there can be only one read/write site. When the volume is removed, the
49 site information is also removed from the VLDB entry. The read/write
50 and backup volume ID numbers no longer appear in the output from the <B>vos
51 listvldb</B> or <B>vos examine</B> commands, but they are preserved
52 internally. Read-only sites, if any, are not affected, but cannot be
53 changed unless a read/write site is again defined. The site count
54 reported by the <B>vos examine</B> and <B>vos listvldb</B> commands as
55 <TT>number of sites</TT> decrements by one. The entire VLDB entry is
56 removed if there are no read-only sites.
57 <P><LI>If the <B>-id</B> argument names a read-only volume, it is removed
58 from the partition that houses it, and the corresponding site information is
59 removed from the VLDB entry. The site count reported by the <B>vos
60 examine</B> and <B>vos listvldb</B> commands as <TT>number of
61 sites</TT> decrements by one for each volume you remove. If there is
62 more than one read-only site, the <B>-server</B> argument (and optionally
63 <B>-partition</B> argument) must be used to specify the site from which to
64 remove the volume. If there is only one read-only site, the
65 <B>-id</B> argument is sufficient; if there is also no read/write
66 volume in this case, the entire VLDB entry is removed.
67 <P><LI>If the <B>-id</B> argument names a backup volume, it is removed from
68 the partition that houses it. The <B>-server</B> and
69 <B>-partition</B> arguments are optional, because there can be only one
70 backup site. The backup volume ID number no longer appears in the
71 output from the <B>vos listvldb</B> command or in the corresponding
72 portion of the output from the <B>vos examine</B> command, but is
73 preserved internally.
74 </UL>
75 <P>This command is the most appropriate one for removing volumes in almost all
76 cases. Other commands that remove only volumes or only VLDB entries
77 (such as the <B>vos delentry</B>, <B>vos remsite</B> and <B>vos
78 zap</B> commands) by definition can put the volumes and VLDB out of
79 sync. Use them only in the special circumstances mentioned on their
80 reference pages. Like the <B>vos delentry</B> command, this command
81 can remove a VLDB entry when no corresponding volumes exist on the file server
82 machine. Like the <B>vos zap</B> command, this command can remove a
83 volume that does not have a VLDB entry, as long as the volume is online,
84 <B>-server</B> and <B>-partition</B> arguments are provided, and the
85 <B>-id</B> argument specifies the volume's ID number.
86 <P><STRONG>Options</STRONG>
87 <DL>
88 <P><DT><B>-server
89 </B><DD>Identifies the file server machine that houses the volume to
90 remove. It is necessary only when the <B>-id</B> argument names a
91 read-only volume that exists at multiple sites. Provide the
92 machine's IP address or its host name (either fully qualified or using an
93 unambiguous abbreviation). For details, see the introductory reference
94 page for the <B>vos</B> command suite.
95 <P><DT><B>-partition
96 </B><DD>Identifies the partition (on the file server machine specified by the
97 <B>-server</B> argument) that houses the volume to remove. Provide
98 the partition's complete name with preceding slash (for example,
99 <B>/vicepa</B>) or use one of the three acceptable abbreviated
100 forms. For details, see the introductory reference page for the
101 <B>vos</B> command suite. 
102 <P>Including this argument is necessary only when the <B>-id</B> argument
103 names a read-only volume that exists at multiple sites. Provide the
104 <B>-server</B> argument along with this one.
105 <P><DT><B>-id
106 </B><DD>Identifies the volume to remove, either by its complete name or volume ID
107 number. If identifying a read-only or backup volume by name, include
108 the appropriate extension (<B>.readonly</B> or
109 <B>.backup</B>).
110 <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,
111 the <B>-id</B> switch must be provided.
112 </TD></TR></TABLE>
113 <P><DT><B>-cell
114 </B><DD>Names the cell in which to run the command. Do not combine this
115 argument with the <B>-localauth</B> flag. For more details, see the
116 introductory <B>vos</B> reference page.
117 <P><DT><B>-noauth
118 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
119 issuer. Do not combine this flag with the <B>-localauth</B>
120 flag. For more details, see the introductory <B>vos</B> reference
121 page.
122 <P><DT><B>-localauth
123 </B><DD>Constructs a server ticket using a key from the local
124 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
125 interpreter presents it to the Volume Server and Volume Location Server during
126 mutual authentication. Do not combine this flag with the
127 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
128 see the introductory <B>vos</B> reference page.
129 <P><DT><B>-verbose
130 </B><DD>Produces on the standard output stream a detailed trace of the
131 command's execution. If this argument is omitted, only warnings
132 and error messages appear.
133 <P><DT><B>-help
134 </B><DD>Prints the online help for this command. All other valid options
135 are ignored.
136 </DL>
137 <P><STRONG>Examples</STRONG>
138 <P>The following example removes the read/write volume
139 <B>user.terry</B> and its backup version, if any.
140 <PRE>   % <B>vos remove  -id user.terry</B>
141    
142 </PRE>
143 <P>The following example removes the read-only volume
144 <B>root.afs.readonly</B> from one of its sites, the
145 <B>/vicepa</B> partition on the file server machine
146 <B>fs1.abc.com</B>.
147 <PRE>   % <B>vos remove fs1.abc.com  a  root.afs.readonly</B>
148    
149 </PRE>
150 <P><STRONG>Privilege Required</STRONG>
151 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
152 the machine specified with the <B>-server</B> argument and on each
153 database server machine. If the <B>-localauth</B> flag is included,
154 the issuer must instead be logged on to a server machine as the local
155 superuser <B>root</B>.
156 <P><STRONG>Related Information</STRONG>
157 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
158 <P><A HREF="auarf259.htm#HDRVOS_DELENTRY">vos delentry</A>
159 <P><A HREF="auarf272.htm#HDRVOS_REMSITE">vos remsite</A>
160 <P><A HREF="auarf280.htm#HDRVOS_ZAP">vos zap</A>
161 <P>
162 <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> 
163 <!-- Begin Footer Records  ========================================== -->
164 <P><HR><B> 
165 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
166 </B> 
167 <!-- End Footer Records  ============================================ -->
168 <A NAME="Bot_Of_Page"></A>
169 </BODY></HTML>