kaauxdb-fix-silly-comment-substitution-20010711
[openafs.git] / doc / html / AdminReference / auarf249.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="auarf248.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="auarf250.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="HDRVLSERVER" HREF="auarf002.htm#ToC_263">vlserver</A></H2>
19 <A NAME="IDX5560"></A>
20 <A NAME="IDX5561"></A>
21 <A NAME="IDX5562"></A>
22 <A NAME="IDX5563"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Initializes the Volume Location Server
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>vlserver</B> [<B>-p</B> &lt;<VAR>lwp&nbsp;processes</VAR>>]  [<B>-nojumbo</B>]  
27          [<B>-enable_peer_stats</B>]  [<B>-enable_process_stats</B>]  [<B>-help</B>]
28 </PRE>
29 <P>This command does not use the syntax conventions of the AFS command
30 suites. Provide the command name and all option names in full.
31 <P><STRONG>Description</STRONG>
32 <P>The <B>vlserver</B> command initializes the Volume Location (VL)
33 Server, which runs on every database server machine. In the
34 conventional configuration, its binary file is located in the
35 <B>/usr/afs/bin</B> directory on a file server machine.
36 <P>The <B>vlserver</B> command is not normally issued at the command shell
37 prompt but rather placed into a file server machine's
38 <B>/usr/afs/local/BosConfig</B> file with the <B>bos create</B>
39 command. If it is ever issued at the command shell prompt, the issuer
40 must be logged onto a database server machine as the local superuser
41 <B>root</B>.
42 <P>As it initializes, the VL Server process creates the two files that
43 constitute the Volume Location Database (VLDB), <B>vldb.DB0</B> and
44 <B>vldb.DBSYS1</B>, in the <B>/usr/afs/db</B> directory if they
45 do not already exist. Use the commands in the <B>vos</B> suite to
46 administer the database.
47 <P>The VL Server maintains the record of volume locations in the Volume
48 Location Database (VLDB). When the Cache Manager fills a file request
49 from an application program, it first contacts the VL Server to learn which
50 file server machine currently houses the volume that contains the file.
51 The Cache Manager then requests the file from the File Server process running
52 on that file server machine.
53 <P>The VL Server records a trace of its activity in the
54 <B>/usr/afs/logs/VLLog</B> file. Use the <B>bos getlog</B>
55 command to display the contents of the file. By default, it records on
56 a minimal number of messages. For instructions on increasing the amount
57 of logging, see the <B>VLLog</B> reference page.
58 <P>By default, the VL Server runs nine lightweight processes (LWPs). To
59 change the number, use the <B>-p</B> argument.
60 <P><STRONG>Options</STRONG>
61 <DL>
62 <P><DT><B>-p
63 </B><DD>Sets the number of server lightweight processes (LWPs) to run.
64 Provide an integer between <B>4</B> and <B>16</B>. The default
65 is 9.
66 <P><DT><B>-nojumbo
67 </B><DD>Prohibits the server from sending or receiving jumbograms. A
68 jumbogram is a large-size packet composed of 2 to 4 normal Rx data packets
69 that share the same header. The VL Server uses jumbograms by default,
70 but some routers are not capable of properly breaking the jumbogram into
71 smaller packets and reassembling them.
72 <P><DT><B>-enable_peer_stats
73 </B><DD>Activates the collection of Rx statistics and allocates memory for their
74 storage. For each connection with a specific UDP port on another
75 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
76 and so on) sent or received. To display or otherwise access the
77 records, use the Rx Monitoring API.
78 <P><DT><B>-enable_process_stats
79 </B><DD>Activates the collection of Rx statistics and allocates memory for their
80 storage. A separate record is kept for each type of RPC (FetchFile,
81 GetStatus, and so on) sent or received, aggregated over all connections to
82 other machines. To display or otherwise access the records, use the Rx
83 Monitoring API.
84 <P><DT><B>-help
85 </B><DD>Prints the online help for this command. All other valid options
86 are ignored.
87 </DL>
88 <P><STRONG>Examples</STRONG>
89 <P>The following <B>bos create</B> command creates a <B>vlserver</B>
90 process on the machine <B>fs2.abc.com</B> that uses six
91 lightweight processes. Type the command on a single line:
92 <PRE>   % <B>bos create -server fs2.abc.com -instance vlserver -type simple</B>  \
93                 <B>-cmd "/usr/afs/bin/vlserver -p 6"</B>
94 </PRE>
95 <P><STRONG>Privilege Required</STRONG>
96 <P>The issuer must be logged in as the superuser <B>root</B> on a file
97 server machine to issue the command at a command shell prompt. It is
98 conventional instead to create and start the process by issuing the <B>bos
99 create</B> command.
100 <P><STRONG>Related Information</STRONG>
101 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
102 <P><A HREF="auarf038.htm#HDRVLLOG">VLLog</A>
103 <P><A HREF="auarf051.htm#HDRVLDBDB">vldb.DB0 and vldb.DBSYS1</A>
104 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
105 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
106 <P>
107 <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="auarf248.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="auarf250.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> 
108 <!-- Begin Footer Records  ========================================== -->
109 <P><HR><B> 
110 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
111 </B> 
112 <!-- End Footer Records  ============================================ -->
113 <A NAME="Bot_Of_Page"></A>
114 </BODY></HTML>