windows-install-notes-20040624
[openafs.git] / doc / html / AdminReference / auarf265.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="auarf264.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="auarf266.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_LISTVLDB" HREF="auarf002.htm#ToC_279">vos listvldb</A></H2>
19 <A NAME="IDX5708"></A>
20 <A NAME="IDX5709"></A>
21 <A NAME="IDX5710"></A>
22 <A NAME="IDX5711"></A>
23 <A NAME="IDX5712"></A>
24 <A NAME="IDX5713"></A>
25 <A NAME="IDX5714"></A>
26 <A NAME="IDX5715"></A>
27 <A NAME="IDX5716"></A>
28 <A NAME="IDX5717"></A>
29 <A NAME="IDX5718"></A>
30 <P><STRONG>Purpose</STRONG>
31 <P>Displays a volume's VLDB entry
32 <P><STRONG>Synopsis</STRONG>
33 <PRE><B>vos listvldb</B> [<B>-name</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>]  [<B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>]  
34              [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]  [<B>-locked</B>]  [<B>-quiet</B>]  [<B>-nosort</B>]  
35              [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
36     
37 <B>vos listvl</B> [<B>-na</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>]  [<B>-s</B> &lt;<VAR>machine&nbsp;name</VAR>>]
38            [<B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>]  [<B>-lock</B>]  [<B>-q</B>]  [<B>-nos</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
39            [<B>-noa</B>]  [<B>-loca</B>]  [<B>-v</B>]  [<B>-h</B>]
40 </PRE>
41 <P><STRONG>Description</STRONG>
42 <P>The <B>vos listvldb</B> command formats and displays information from
43 the Volume Location Database (VLDB) entry for each volume specified.
44 The output depends on the combination of options supplied on the command
45 line. Combine options as indicated to display the desired type of VLDB
46 entries:
47 <UL>
48 <P><LI>Every entry in the VLDB: provide no options
49 <P><LI>Every VLDB entry that mentions a certain file server machine as the site
50 for a volume: specify the machine's name as the <B>-server</B>
51 argument
52 <P><LI>Every VLDB entry that mentions a certain partition on any file server
53 machine as the site for a volume: specify the partition name as the
54 <B>-partition</B> argument
55 <P><LI>Every VLDB entry that mentions a certain partition on a certain file
56 server machine as the site for a volume: combine the <B>-server</B>
57 and <B>-partition</B> arguments
58 <P><LI>A single VLDB entry: specify a volume name or ID number with the
59 <B>-name</B> argument
60 <P><LI>The VLDB entry only for the volumes with locked VLDB entries found at a
61 certain site: combine the <B>-locked</B> flag with any of arguments
62 that define sites
63 </UL>
64 <P><STRONG>Options</STRONG>
65 <DL>
66 <P><DT><B>-name
67 </B><DD>Specifies either the complete name or volume ID number of a volume of any
68 of the three types.
69 <P><DT><B>-server
70 </B><DD>Identifies the file server machine listed as a site in each VLDB entry to
71 display. Provide the machine's IP address or its host name (either
72 fully qualified or using an unambiguous abbreviation). For details, see
73 the introductory reference page for the <B>vos</B> command suite. 
74 <P>This argument can be combined with the <B>-partition</B> argument, the
75 <B>-locked</B> flag, or both.
76 <P><DT><B>-partition
77 </B><DD>Identifies the partition (on the file server machine specified by the
78 <B>-server</B> argument) listed as a site in each VLDB entry to
79 display. Provide the partition's complete name with preceding
80 slash (for example, <B>/vicepa</B>) or use one of the three acceptable
81 abbreviated forms. For details, see the introductory reference page for
82 the <B>vos</B> command suite. 
83 <P>This argument can be combined with the <B>-server</B> argument, the
84 <B>-locked</B> flag, or both.
85 <P><DT><B>-locked
86 </B><DD>Displays only locked VLDB entries. This flag can be combined with
87 the <B>-server</B> argument, the <B>-partition</B> argument, or
88 both.
89 <P><DT><B>-quiet
90 </B><DD>Suppresses the lines that summarize the number of volumes listed and their
91 status, which otherwise appear at the beginning and end of the output when the
92 output includes more than one volume.
93 <P><DT><B>-nosort
94 </B><DD>Suppresses the default sorting of volume entries alphabetically by volume
95 name.
96 <P><DT><B>-cell
97 </B><DD>Names the cell in which to run the command. Do not combine this
98 argument with the <B>-localauth</B> flag. For more details, see the
99 introductory <B>vos</B> reference page.
100 <P><DT><B>-noauth
101 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
102 issuer. Do not combine this flag with the <B>-localauth</B>
103 flag. For more details, see the introductory <B>vos</B> reference
104 page.
105 <P><DT><B>-localauth
106 </B><DD>Constructs a server ticket using a key from the local
107 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
108 interpreter presents it to the Volume Server and Volume Location Server during
109 mutual authentication. Do not combine this flag with the
110 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
111 see the introductory <B>vos</B> reference page.
112 <P><DT><B>-verbose
113 </B><DD>Produces on the standard output stream a detailed trace of the
114 command's execution. If this argument is omitted, only warnings
115 and error messages appear.
116 <P><DT><B>-help
117 </B><DD>Prints the online help for this command. All other valid options
118 are ignored.
119 </DL>
120 <P><STRONG>Output</STRONG>
121 <P>If the output includes more than one VLDB entry, by default the first line
122 reports which file server machine, partition, or both, houses the
123 volumes. The final line of output reports the total number of entries
124 displayed. Including the <B>-quiet</B> flag suppresses these
125 lines.
126 <P>By default, volumes are sorted alphabetically by volume name.
127 Including the <B>-nosort</B> flag skips the sorting step, which can speed
128 up the production of output if there are a large number of entries.
129 <P>The VLDB entry for each volume includes the following information:
130 <UL>
131 <P><LI>The base (read/write) volume name. The read-only and backup
132 versions have the same name with a <B>.readonly</B> and
133 <B>.backup</B> extension, respectively.
134 <P><LI>The volume ID numbers allocated to the versions of the volume that
135 actually exist, in fields labeled <TT>RWrite</TT> for the read/write,
136 <TT>ROnly</TT> for the read-only, <TT>Backup</TT> for the backup, and
137 <TT>RClone</TT> for the ReleaseClone. (If a field does not appear,
138 the corresponding version of the volume does not exist.) The appearance
139 of the <TT>RClone</TT> field normally indicates that a release operation did
140 not complete successfully; the <TT>Old release</TT> and <TT>New
141 release</TT> flags often also appear on one or more of the site definition
142 lines described just following.
143 <A NAME="IDX5719"></A>
144 <A NAME="IDX5720"></A>
145 <P><LI>The number of sites that house a read/write or read-only copy of the
146 volume, following the string <TT>number of sites -></TT>.
147 <A NAME="IDX5721"></A>
148 <A NAME="IDX5722"></A>
149 <A NAME="IDX5723"></A>
150 <A NAME="IDX5724"></A>
151 <A NAME="IDX5725"></A>
152 <P><LI>A line for each site that houses a read/write or read-only copy of the
153 volume, specifying the file server machine, partition, and type of volume
154 (<TT>RW</TT> for read/write or <TT>RO</TT> for read-only). If a
155 backup version exists, it is understood to share the read/write site.
156 Several flags can appear with a site definition: 
157 <DL>
158 <A NAME="IDX5726"></A>
159 <P><DT><B><TT>Not released</TT>
160 </B><DD>Indicates that the <B>vos release</B> command has not been issued
161 since the <B>vos addsite</B> command was used to define the read-only
162 site.
163 <A NAME="IDX5727"></A>
164 <P><DT><B><TT>Old release</TT>
165 </B><DD>Indicates that a <B>vos release</B> command did not complete
166 successfully, leaving the previous, obsolete version of the volume at this
167 site.
168 <A NAME="IDX5728"></A>
169 <P><DT><B><TT>New release</TT>
170 </B><DD>Indicates that a <B>vos release</B> command did not complete
171 successfully, but that this site did receive the correct new version of the
172 volume.
173 </DL>
174 <P><LI>If the VLDB entry is locked, the string <TT>Volume is currently
175 LOCKED</TT>.
176 </UL>
177 <P>For further discussion of the <TT>New release</TT> and <TT>Old
178 release</TT> flags, see the reference page for the <B>vos release</B>
179 command.
180 <P><STRONG>Examples</STRONG>
181 <P>The following command displays VLDB information for the ABC Corporation
182 volume called <B>usr</B>, which has two read-only replication sites:
183 <PRE>   % <B>vos listvldb -name usr</B>
184    usr 
185     RWrite: 5360870981   ROnly: 536870982   Backup: 536870983
186     number of sites -> 3
187        server fs1.abc.com partition /vicepa RO Site 
188        server fs3.abc.com partition /vicepa RO Site 
189        server fs2.abc.com partition /vicepb RW Site 
190    
191 </PRE>
192 <P>The following example shows entries for two of the volumes that reside on
193 the file server machine <B>fs4.abc.com</B>. The first
194 VLDB entry is currently locked. There are 508 entries that mention the
195 machine as a volume site.
196 <PRE>   % <B>vos listvldb -server fs4.abc.com</B>
197    VLDB entries for server fs4.abc.com
198        .       .           .        .
199        .       .           .        .
200    user.smith 
201     RWrite: 278541326   ROnly: 278541327   Backup: 278542328
202     number of sites -> 1
203       server fs4.abc.com partition /vicepg RW Site 
204     Volume is currently LOCKED
205       user.terry
206     RWrite 354287190   ROnly 354287191   Backup 354287192
207     number of sites -> 1
208       server fs4.abc.com partition /vicepc RW Site 
209       .       .           .        .
210       .       .           .        .
211    Total entries: 508
212    
213 </PRE>
214 <P><STRONG>Privilege Required</STRONG>
215 <P>None
216 <P><STRONG>Related Information</STRONG>
217 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
218 <P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
219 <P><A HREF="auarf266.htm#HDRVOS_LISTVOL">vos listvol</A>
220 <P><A HREF="auarf267.htm#HDRVOS_LOCK">vos lock</A>
221 <P><A HREF="auarf278.htm#HDRVOS_UNLOCK">vos unlock</A>
222 <P><A HREF="auarf279.htm#HDRVOS_UNLOCKVLDB">vos unlockvldb</A>
223 <P>
224 <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="auarf264.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="auarf266.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> 
225 <!-- Begin Footer Records  ========================================== -->
226 <P><HR><B> 
227 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
228 </B> 
229 <!-- End Footer Records  ============================================ -->
230 <A NAME="Bot_Of_Page"></A>
231 </BODY></HTML>