DEVEL15-man-pages-allow-dots-consistent-20090505
[openafs.git] / doc / man-pages / pod8 / vlserver.pod
1 =head1 NAME
2
3 vlserver - Initializes the Volume Location Server
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vlserver> S<<< [B<-p> <I<number of threads>>] >>> [B<-nojumbo>] [B<-jumbo>] [B<-rxbind>] S<<< [B<-d> <I<debug level>>] >>>
11     [B<-allow-dotted-principals>] [B<-enable_peer_stats>] [B<-enable_process_stats>] 
12     [B<-help>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<vlserver> command initializes the Volume Location (VL) Server, which
20 runs on every database server machine. In the conventional configuration,
21 its binary file is located in the F</usr/afs/bin> directory on a file
22 server machine.
23
24 The B<vlserver> command is not normally issued at the command shell prompt
25 but rather placed into a file server machine's F</usr/afs/local/BosConfig>
26 file with the B<bos create> command. If it is ever issued at the command
27 shell prompt, the issuer must be logged onto a database server machine as
28 the local superuser C<root>.
29
30 As it initializes, the VL Server process creates the two files that
31 constitute the Volume Location Database (VLDB), F<vldb.DB0> and
32 F<vldb.DBSYS1>, in the F</usr/afs/db> directory if they do not already
33 exist. Use the commands in the B<vos> suite to administer the database.
34
35 The VL Server maintains the record of volume locations in the Volume
36 Location Database (VLDB). When the Cache Manager fills a file request from
37 an application program, it first contacts the VL Server to learn which
38 file server machine currently houses the volume that contains the file.
39 The Cache Manager then requests the file from the File Server process
40 running on that file server machine.
41
42 The VL Server records a trace of its activity in the
43 F</usr/afs/logs/VLLog> file. Use the B<bos getlog> command to display the
44 contents of the file. By default, it records on a minimal number of
45 messages. For instructions on increasing the amount of logging, see
46 L<VLLog(5)>.
47
48 By default, the VL Server runs nine lightweight processes (LWPs). To
49 change the number, use the B<-p> argument.
50
51 This command does not use the syntax conventions of the AFS command
52 suites. Provide the command name and all option names in full.
53
54 =head1 OPTIONS
55
56 =over 4
57
58 =item B<-d> <I<debug level>>
59
60 Sets the detail level for the debugging trace written to the
61 F</usr/afs/logs/VLLog> file. Provide one of the following values, each
62 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
63 and C<125>. 
64
65 =item B<-p> <I<number of threads>>
66
67 Sets the number of server lightweight processes (LWPs or pthreads) to run.
68 Provide an integer between C<3> and C<16>. The default is C<9>.
69
70 =item B<-jumbo>
71
72 Allows the server to send and receive jumbograms. A jumbogram is
73 a large-size packet composed of 2 to 4 normal Rx data packets that share
74 the same header. The VL Server does not use jumbograms by default, as some
75 routers are not capable of properly breaking the jumbogram into smaller
76 packets and reassembling them.
77
78 =item B<-nojumbo>
79
80 Deprecated; Jumbograms are disabled by default. 
81
82 =item B<-enable_peer_stats>
83
84 Activates the collection of Rx statistics and allocates memory for their
85 storage. For each connection with a specific UDP port on another machine,
86 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
87 so on) sent or received. To display or otherwise access the records, use
88 the Rx Monitoring API.
89
90 =item B<-enable_process_stats>
91
92 Activates the collection of Rx statistics and allocates memory for their
93 storage. A separate record is kept for each type of RPC (FetchFile,
94 GetStatus, and so on) sent or received, aggregated over all connections to
95 other machines. To display or otherwise access the records, use the Rx
96 Monitoring API.
97
98 =item B<-allow-dotted-principals>
99
100 By default, the RXKAD security layer will disallow access by Kerberos
101 principals with a dot in the first component of their name. This is to avoid
102 the confusion where principals user/admin and user.admin are both mapped to the
103 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
104 between principal names may disable this check by starting the server
105 with this option.
106
107 =item B<-rxbind>
108
109 Bind the Rx socket to the primary interface only.  (If not specified, the
110 Rx socket will listen on all interfaces.)
111
112 =item B<-help>
113
114 Prints the online help for this command. All other valid options are
115 ignored.
116
117 =back
118
119 =head1 EXAMPLES
120
121 The following B<bos create> command creates a vlserver process on the
122 machine C<fs2.abc.com> that uses six lightweight processes. Type the
123 command on a single line:
124
125    % bos create -server fs2.abc.com -instance vlserver -type simple \
126                 -cmd "/usr/afs/bin/vlserver -p 6"
127
128 =head1 PRIVILEGE REQUIRED
129
130 The issuer must be logged in as the superuser C<root> on a file server
131 machine to issue the command at a command shell prompt. It is conventional
132 instead to create and start the process by issuing the B<bos create>
133 command.
134
135 =head1 SEE ALSO
136
137 L<BosConfig(5)>,
138 L<VLLog(5)>,
139 L<vldb.DB0(5)>,
140 L<bos_create(8)>,
141 L<bos_getlog(8)>
142
143 =head1 COPYRIGHT
144
145 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
146
147 This documentation is covered by the IBM Public License Version 1.0.  It was
148 converted from HTML to POD by software written by Chas Williams and Russ
149 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.