dafileserver synopsis
[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<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
12     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
13     S<<< [B<-d> <I<debug level>>] >>>
14     [B<-nojumbo>] [B<-jumbo>] 
15     [B<-enable_peer_stats>] [B<-enable_process_stats>] 
16     [B<-allow-dotted-principals>] [B<-help>]
17
18 =for html
19 </div>
20
21 =head1 DESCRIPTION
22
23 The B<volserver> command initializes the Volume Server component of the
24 C<fs> process. In the conventional configuration, its binary file is
25 located in the F</usr/afs/bin> directory on a file server machine.
26
27 The B<volserver> command is not normally issued at the command shell
28 prompt but rather placed into a file server machine's
29 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
30 ever issued at the command shell prompt, the issuer must be logged onto a
31 database server machine as the local superuser C<root>.
32
33 The Volume Server records a trace of its activity in the
34 F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
35 the contents of the file.
36
37 The Volume Server processes the B<vos> commands that administrators use to
38 create, delete, move, and replicate volumes, as well as prepare them for
39 archiving to tape or other media.
40
41 By default, the VL Server runs nine lightweight processes (LWPs). To
42 change the number, use the B<-p> argument.
43
44 This command does not use the syntax conventions of the AFS command
45 suites. Provide the command name and all option names in full.
46
47 =head1 OPTIONS
48
49 =over 4
50
51 =item B<-d> <I<debug level>>
52
53 Sets the detail level for the debugging trace written to the
54 F</usr/afs/logs/VolserLog> file. Provide one of the following values, each
55 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
56 and C<125>. 
57
58 =item B<-log>
59
60 Records in the /usr/afs/logs/VolserLog file the names of all users who
61 successfully initiate a B<vos> command. The Volume Server also records any
62 file removals that result from issuing the B<vos release> command with the
63 B<-f> flag.
64
65 =item B<-p> <I<number of processes>>
66
67 Sets the number of server lightweight processes (LWPs) to run.  Provide an
68 integer between C<4> and C<16>. The default is C<9>.
69
70 =item B<-auditlog> <I<log path>>
71
72 Turns on audit logging, and sets the path for the audit log.  The audit
73 log records information about RPC calls, including the name of the RPC
74 call, the host that submitted the call, the authenticated entity (user)
75 that issued the call, the parameters for the call, and if the call
76 succeeded or failed.
77
78 =item B<-audit-interface> (file | sysvmq)
79
80 Specifies what audit interface to use. Defaults to C<file>. See
81 L<fileserver(8)> for an explanation of each interface.
82
83 =item B<-udpsize> <I<size of socket buffer>>
84
85 Sets the size of the UDP buffer in bytes, which is 64 KB by
86 default. Provide a positive integer, preferably larger than the default.
87
88 =item B<-jumbo>
89
90 Allows the server to send and receive jumbograms. A jumbogram is
91 a large-size packet composed of 2 to 4 normal Rx data packets that share
92 the same header. The volserver does not use jumbograms by default, as some
93 routers are not capable of properly breaking the jumbogram into smaller
94 packets and reassembling them.
95
96 =item B<-nojumbo>
97
98 Deprecated; jumbograms are disabled by default.
99
100 =item B<-enable_peer_stats>
101
102 Activates the collection of Rx statistics and allocates memory for their
103 storage. For each connection with a specific UDP port on another machine,
104 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
105 so on) sent or received. To display or otherwise access the records, use
106 the Rx Monitoring API.
107
108 =item B<-enable_process_stats>
109
110 Activates the collection of Rx statistics and allocates memory for their
111 storage. A separate record is kept for each type of RPC (FetchFile,
112 GetStatus, and so on) sent or received, aggregated over all connections to
113 other machines. To display or otherwise access the records, use the Rx
114 Monitoring API.
115
116 =item B<-allow-dotted-principals>
117
118 By default, the RXKAD security layer will disallow access by Kerberos
119 principals with a dot in the first component of their name. This is to avoid
120 the confusion where principals user/admin and user.admin are both mapped to the
121 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
122 between principal names may disable this check by starting the server
123 with this option.
124
125 =item B<-help>
126
127 Prints the online help for this command. All other valid options are
128 ignored.
129
130 =back
131
132 =head1 EXAMPLES
133
134 The following B<bos create> command creates a C<volserver> process on the
135 machine C<fs2.abc.com>:
136
137    % bos create -server fs2.abc.com -instance volserver -type simple \
138                  -cmd /usr/afs/bin/volserver
139
140 =head1 PRIVILEGE REQUIRED
141
142 The issuer must be logged in as the superuser C<root> on a file server
143 machine to issue the command at a command shell prompt. It is conventional
144 instead to create and start the process by issuing the B<bos create>
145 command.
146
147 =head1 SEE ALSO
148
149 L<BosConfig(5)>,
150 L<VolserLog(5)>,
151 L<bos_create(8)>,
152 L<bos_getlog(8)>,
153 L<vos(1)>
154
155 =head1 COPYRIGHT
156
157 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
158
159 This documentation is covered by the IBM Public License Version 1.0.  It was
160 converted from HTML to POD by software written by Chas Williams and Russ
161 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.