rxkad-v5-dot-check-20080122
[openafs.git] / doc / man-pages / pod8 / volserver.pod
1 =head1 NAME
2
3 volserver - Initializes the Volume Server component of the fs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<volserver> [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
11     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
12     [B<-enable_peer_stats>] [B<-enable_process_stats>] 
13     [B<-allow-dotted-principal>] [B<-help>]
14
15 =for html
16 </div>
17
18 =head1 DESCRIPTION
19
20 The B<volserver> command initializes the Volume Server component of the
21 C<fs> process. In the conventional configuration, its binary file is
22 located in the F</usr/afs/bin> directory on a file server machine.
23
24 The B<volserver> command is not normally issued at the command shell
25 prompt but rather placed into a file server machine's
26 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
27 ever issued at the command shell prompt, the issuer must be logged onto a
28 database server machine as the local superuser C<root>.
29
30 The Volume Server records a trace of its activity in the
31 F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
32 the contents of the file.
33
34 The Volume Server processes the B<vos> commands that administrators use to
35 create, delete, move, and replicate volumes, as well as prepare them for
36 archiving to tape or other media.
37
38 By default, the VL Server runs nine lightweight processes (LWPs). To
39 change the number, use the B<-p> argument.
40
41 This command does not use the syntax conventions of the AFS command
42 suites. Provide the command name and all option names in full.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-log>
49
50 Records in the /usr/afs/logs/VolserLog file the names of all users who
51 successfully initiate a B<vos> command. The Volume Server also records any
52 file removals that result from issuing the B<vos release> command with the
53 B<-f> flag.
54
55 =item B<-p> <I<number of processes>>
56
57 Sets the number of server lightweight processes (LWPs) to run.  Provide an
58 integer between C<4> and C<16>. The default is C<9>.
59
60 =item B<-udpsize> <I<size of socket buffer>>
61
62 Sets the size of the UDP buffer in bytes, which is 64 KB by
63 default. Provide a positive integer, preferably larger than the default.
64
65 =item B<-enable_peer_stats>
66
67 Activates the collection of Rx statistics and allocates memory for their
68 storage. For each connection with a specific UDP port on another machine,
69 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
70 so on) sent or received. To display or otherwise access the records, use
71 the Rx Monitoring API.
72
73 =item B<-enable_process_stats>
74
75 Activates the collection of Rx statistics and allocates memory for their
76 storage. A separate record is kept for each type of RPC (FetchFile,
77 GetStatus, and so on) sent or received, aggregated over all connections to
78 other machines. To display or otherwise access the records, use the Rx
79 Monitoring API.
80
81 =item B<-allow-dotted-principal>
82
83 By default, the RXKAD security layer will disallow access by Kerberos
84 principals with a dot in the first component of their name. This is to avoid
85 the confusion where principals user/admin and user.admin are both mapped to the
86 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
87 between principal names may disable this check by starting the server
88 with this option.
89
90 =item B<-help>
91
92 Prints the online help for this command. All other valid options are
93 ignored.
94
95 =back
96
97 =head1 EXAMPLES
98
99 The following B<bos create> command creates a C<volserver> process on the
100 machine C<fs2.abc.com>:
101
102    % bos create -server fs2.abc.com -instance volserver -type simple \
103                  -cmd /usr/afs/bin/volserver
104
105 =head1 PRIVILEGE REQUIRED
106
107 The issuer must be logged in as the superuser C<root> on a file server
108 machine to issue the command at a command shell prompt. It is conventional
109 instead to create and start the process by issuing the B<bos create>
110 command.
111
112 =head1 SEE ALSO
113
114 L<BosConfig(5)>,
115 L<VolserLog(5)>,
116 L<bos_create(8)>,
117 L<bos_getlog(8)>,
118 L<vos(1)>
119
120 =head1 COPYRIGHT
121
122 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
123
124 This documentation is covered by the IBM Public License Version 1.0.  It was
125 converted from HTML to POD by software written by Chas Williams and Russ
126 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.