man-fileserver-args-20070611
[openafs.git] / doc / man-pages / pod8 / fileserver.pod
1 =head1 NAME
2
3 fileserver - Initializes the File Server component of the fs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fileserver> S<<< [B<-auditlog> <I<log path>>] >>>
11     S<<< [B<-d> <I<debug level>>] >>>
12     S<<< [B<-p> <I<number of processes>>] >>>
13     S<<< [B<-spare> <I<number of spare blocks>>] >>>
14     S<<< [B<-pctspare> <I<percentage spare>>] >>> S<<< [B<-b> <I<buffers>>] >>>
15     S<<< [B<-l> <I<large vnodes>>] >>> S<<< [B<-s> <I<small nodes>>] >>>
16     S<<< [B<-vc> <I<volume cachesize>>] >>> S<<< [B<-w> <I<call back wait interval>>] >>>
17     S<<< [B<-cb> <I<number of call backs>>] >>> [B<-banner>] [B<-novbc>]
18     S<<< [B<-implicit> <I<admin mode bits: rlidwka>>] >>> [B<-readonly>]
19     S<<< [B<-hr> <I<number of hours between refreshing the host cps>>] >>>
20     [B<-busyat> <I<< redirect clients when queue > n >>>]
21     [B<-nobusy>] S<<< [B<-rxpck> <I<number of rx extra packets>>] >>>
22     [B<-rxdbg>] [B<-rxdbge>] S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
23     S<<< [B<-rxbind> <I<address to bind the Rx socket to>>] >>>
24     S<<< [B<-vattachpar> <I<number of volume attach threads>>] >>>
25     S<<< [B<-m> <I<min percentage spare in partition>>] >>>
26     [B<-lock>] [B<-L>] [B<-S>] S<<< [B<-k> <I<stack size>>] >>>
27     S<<< [B<-realm> <I<Kerberos realm name>>] >>>
28     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
29     S<<< [B<-sendsize> <I<size of send buffer in bytes>>] >>>
30     S<<< [B<-abortthreshold> <I<abort threshold>>] >>>
31     S<<< [B<-auditlog> <I<path to log file>>] >>>
32     [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>]
33
34 =for html
35 </div>
36
37 =head1 DESCRIPTION
38
39 The B<fileserver> command initializes the File Server component of the
40 C<fs> process. In the conventional configuration, its binary file is
41 located in the F</usr/afs/bin> directory on a file server machine.
42
43 The B<fileserver> command is not normally issued at the command shell
44 prompt, but rather placed into a database server machine's
45 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
46 ever issued at the command shell prompt, the issuer must be logged onto a
47 file server machine as the local superuser C<root>.
48
49 The File Server creates the F</usr/afs/logs/FileLog> log file as it
50 initializes, if the file does not already exist. It does not write a
51 detailed trace by default, but use the B<-d> option to increase the amount
52 of detail. Use the B<bos getlog> command to display the contents of the
53 log file.
54
55 The command's arguments enable the administrator to control many aspects
56 of the File Server's performance, as detailed in L<OPTIONS>.  By default
57 the B<fileserver> command sets values for many arguments that are suitable
58 for a medium-sized file server machine. To set values suitable for a small
59 or large file server machine, use the B<-S> or B<-L> flag
60 respectively. The following list describes the parameters and
61 corresponding argument for which the B<fileserver> command sets default
62 values, and the table below summarizes the setting for each of the three
63 machine sizes.
64
65 =over 4
66
67 =item *
68
69 The maximum number of lightweight processes (LWPs) the File Server uses to
70 handle requests for data; corresponds to the B<-p> argument. The File
71 Server always uses a minimum of 32 KB for these processes.
72
73 =item *
74
75 The maximum number of directory blocks the File Server caches in memory;
76 corresponds to the B<-b> argument. Each cached directory block (buffer)
77 consumes 2,092 bytes of memory.
78
79 =item *
80
81 The maximum number of large vnodes the File Server caches in memory for
82 tracking directory elements; corresponds to the B<-l> argument. Each large
83 vnode consumes 292 bytes of memory.
84
85 =item *
86
87 The maximum number of small vnodes the File Server caches in memory for
88 tracking file elements; corresponds to the B<-s> argument.  Each small
89 vnode consumes 100 bytes of memory.
90
91 =item *
92
93 The maximum volume cache size, which determines how many volumes the File
94 Server can cache in memory before having to retrieve data from disk;
95 corresponds to the B<-vc> argument.
96
97 =item *
98
99 The maximum number of callback structures the File Server caches in
100 memory; corresponds to the B<-cb> argument. Each callback structure
101 consumes 16 bytes of memory.
102
103 =item *
104
105 The maximum number of Rx packets the File Server uses; corresponds to the
106 B<-rxpck> argument. Each packet consumes 1544 bytes of memory.
107
108 =back
109
110 The default values are:
111
112   Parameter (Argument)               Small (-S)     Medium   Large (-L)
113   ---------------------------------------------------------------------
114   Number of LWPs (-p)                        6           9           12
115   Number of cached dir blocks (-b)          70          90          120
116   Number of cached large vnodes (-l)       200         400          600
117   Number of cached small vnodes (-s)       200         400          600
118   Maximum volume cache size (-vc)          200         400          600
119   Number of callbacks (-cb)             20,000      60,000       64,000
120   Number of Rx packets (-rxpck)            100         150          200
121
122 To override any of the values, provide the indicated argument (which can
123 be combined with the B<-S> or B<-L> flag).
124
125 The amount of memory required for the File Server varies. The approximate
126 default memory usage is 751 KB when the B<-S> flag is used (small
127 configuration), 1.1 MB when all defaults are used (medium configuration),
128 and 1.4 MB when the B<-L> flag is used (large configuration). If
129 additional memory is available, increasing the value of the B<-cb> and
130 B<-vc> arguments can improve File Server performance most directly.
131
132 By default, the File Server allows a volume to exceed its quota by 1 MB
133 when an application is writing data to an existing file in a volume that
134 is full. The File Server still does not allow users to create new files in
135 a full volume. To change the default, use one of the following arguments:
136
137 =over 4
138
139 =item *
140
141 Set the B<-spare> argument to the number of extra kilobytes that the File
142 Server allows as overage. A value of C<0> allows no overage.
143
144 =item *
145
146 Set the B<-pctspare> argument to the percentage of the volume's quota the
147 File Server allows as overage.
148
149 =back
150
151 By default, the File Server implicitly grants the C<a> (administer) and
152 C<l> (lookup) permissions to system:administrators on the access control
153 list (ACL) of every directory in the volumes stored on its file server
154 machine. In other words, the group's members can exercise those two
155 permissions even when an entry for the group does not appear on an ACL. To
156 change the set of default permissions, use the B<-implicit> argument.
157
158 The File Server maintains a I<host current protection subgroup> (I<host
159 CPS>) for each client machine from which it has received a data access
160 request. Like the CPS for a user, a host CPS lists all of the Protection
161 Database groups to which the machine belongs, and the File Server compares
162 the host CPS to a directory's ACL to determine in what manner users on the
163 machine are authorized to access the directory's contents. When the B<pts
164 adduser> or B<pts removeuser> command is used to change the groups to
165 which a machine belongs, the File Server must recompute the machine's host
166 CPS in order to notice the change. By default, the File Server contacts
167 the Protection Server every two hours to recompute host CPSs, implying
168 that it can take that long for changed group memberships to become
169 effective. To change this frequency, use the B<-hr> argument.
170
171 The File Server generates the following message when a partition is nearly
172 full:
173
174    No space left on device
175
176 This command does not use the syntax conventions of the AFS command
177 suites. Provide the command name and all option names in full.
178
179 =head1 CAUTIONS
180
181 Do not use the B<-k> and -w arguments, which are intended for use by the
182 AFS Development group only. Changing them from their default values can
183 result in unpredictable File Server behavior.  In any case, on many
184 operating systems the File Server uses native threads rather than the LWP
185 threads, so using the B<-k> argument to set the number of LWP threads has
186 no effect.
187
188 Do not specify both the B<-spare> and B<-pctspare> arguments. Doing so
189 causes the File Server to exit, leaving an error message in the
190 F</usr/afs/logs/FileLog> file.
191
192 Options that are available only on some system types, such as the B<-m>
193 and B<-lock> options, appear in the output generated by the B<-help>
194 option only on the relevant system type.
195
196 =head1 OPTIONS
197
198 =over 4
199
200 =item B<-auditlog> <I<log path>>
201
202 Set and enable auditing.
203
204 =item B<-d> <I<debug level>>
205
206 Sets the detail level for the debugging trace written to the
207 F</usr/afs/logs/FileLog> file. Provide one of the following values, each
208 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
209 and C<125>. The default value of C<0> produces only a few messages.
210
211 =item B<-p> <I<number of processes>>
212
213 Sets the number of threads to run. Provide a positive integer. The File
214 Server creates and uses five threads for special purposes, in addition to
215 the number specified (but if this argument specifies the maximum possible
216 number, the File Server automatically uses five of the threads for its own
217 purposes).
218
219 The maximum number of threads can differ in each release of AFS.  Consult
220 the I<IBM AFS Release Notes> for the current release.
221
222 =item B<-spare> <I<number of spare blocks>>
223
224 Specifies the number of additional kilobytes an application can store in a
225 volume after the quota is exceeded. Provide a positive integer; a value of
226 C<0> prevents the volume from ever exceeding its quota. Do not combine
227 this argument with the B<-pctspare> argument.
228
229 =item B<-pctspare> <I<percentage spare>>
230
231 Specifies the amount by which the File Server allows a volume to exceed
232 its quota, as a percentage of the quota. Provide an integer between C<0>
233 and C<99>. A value of C<0> prevents the volume from ever exceeding its
234 quota. Do not combine this argument with the B<-spare> argument.
235
236 =item B<-b> <I<buffers>>
237
238 Sets the number of directory buffers. Provide a positive integer.
239
240 =item B<-l> <I<large vnodes>>
241
242 Sets the number of large vnodes available in memory for caching directory
243 elements. Provide a positive integer.
244
245 =item B<-s> <I<small nodes>>
246
247 Sets the number of small vnodes available in memory for caching file
248 elements. Provide a positive integer.
249
250 =item B<-vc> <I<volume cachesize>>
251
252 Sets the number of volumes the File Server can cache in memory.  Provide a
253 positive integer.
254
255 =item B<-w> <I<call back wait interval>>
256
257 Sets the interval at which the daemon spawned by the File Server performs
258 its maintenance tasks. Do not use this argument; changing the default
259 value can cause unpredictable behavior.
260
261 =item B<-cb> <I<number of callbacks>>
262
263 Sets the number of callbacks the File Server can track. Provide a positive
264 integer.
265
266 =item B<-banner>
267
268 Prints the following banner to F</dev/console> about every 10 minutes.
269
270    File Server is running at I<time>.
271
272 =item B<-novbc>
273
274 Prevents the File Server from breaking the callbacks that Cache Managers
275 hold on a volume that the File Server is reattaching after the volume was
276 offline (as a result of the B<vos restore> command, for example). Use of
277 this flag is strongly discouraged.
278
279 =item B<-implicit> <I<admin mode bits>>
280
281 Defines the set of permissions granted by default to the
282 system:administrators group on the ACL of every directory in a volume
283 stored on the file server machine. Provide one or more of the standard
284 permission letters (C<rlidwka>) and auxiliary permission letters
285 (C<ABCDEFGH>), or one of the shorthand notations for groups of permissions
286 (C<all>, C<none>, C<read>, and C<write>). To review the meaning of the
287 permissions, see the B<fs setacl> reference page.
288
289 =item B<-hr> <I<number of hours between refreshing the host cps>>
290
291 Specifies how often the File Server refreshes its knowledge of the
292 machines that belong to protection groups (refreshes the host CPSs for
293 machines). The File Server must update this information to enable users
294 from machines recently added to protection groups to access data for which
295 those machines now have the necessary ACL permissions.
296
297 =item B<-busyat> <I<< redirect clients when queue > n >>>
298
299 Defines the number of incoming RPCs that can be waiting for a response
300 from the File Server before the File Server returns the error code
301 C<VBUSY> to the Cache Manager that sent the latest RPC. In response, the
302 Cache Manager retransmits the RPC after a delay. This argument prevents
303 the accumulation of so many waiting RPCs that the File Server can never
304 process them all. Provide a positive integer.  The default value is
305 C<600>.
306
307 =item B<-rxpck> <I<number of rx extra packets>>
308
309 Controls the number of Rx packets the File Server uses to store data for
310 incoming RPCs that it is currently handling, that are waiting for a
311 response, and for replies that are not yet complete. Provide a positive
312 integer.
313
314 =item B<-rxdbg>
315
316 Writes a trace of the File Server's operations on Rx packets to the file
317 F</usr/afs/logs/rx_dbg>.
318
319 =item F<-rxdbge>
320
321 Writes a trace of the File Server's operations on Rx events (such as
322 retransmissions) to the file F</usr/afs/logs/rx_dbg>.
323
324 =item F<-m> <I<min percentage spare in partition>>
325
326 Specifies the percentage of each AFS server partition that the AIX version
327 of the File Server creates as a reserve. Specify an integer value between
328 C<0> and C<30>; the default is 8%. A value of C<0> means that the
329 partition can become completely full, which can have serious negative
330 consequences.
331
332 =item B<-lock>
333
334 Prevents any portion of the fileserver binary from being paged (swapped)
335 out of memory on a file server machine running the IRIX operating system.
336
337 =item B<-L>
338
339 Sets values for many arguments in a manner suitable for a large file
340 server machine. Combine this flag with any option except the B<-S> flag;
341 omit both flags to set values suitable for a medium-sized file server
342 machine.
343
344 =item B<-S>
345
346 Sets values for many arguments in a manner suitable for a small file
347 server machine. Combine this flag with any option except the B<-L> flag;
348 omit both flags to set values suitable for a medium-sized file server
349 machine.
350
351 =item B<-k> <I<stack size>>
352
353 Sets the LWP stack size in units of 1 kilobyte. Do not use this argument,
354 and in particular do not specify a value less than the default of C<24>.
355
356 =item B<-realm> <I<Kerberos realm name>>
357
358 Defines the Kerberos realm name for the File Server to use. If this
359 argument is not provided, it uses the realm name corresponding to the cell
360 listed in the local F</usr/afs/etc/ThisCell> file.
361
362 =item B<-udpsize> <I<size of socket buffer in bytes>>
363
364 Sets the size of the UDP buffer, which is 64 KB by default. Provide a
365 positive integer, preferably larger than the default.
366
367 =item B<-enable_peer_stats>
368
369 Activates the collection of Rx statistics and allocates memory for their
370 storage. For each connection with a specific UDP port on another machine,
371 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
372 so on) sent or received. To display or otherwise access the records, use
373 the Rx Monitoring API.
374
375 =item B<-enable_process_stats>
376
377 Activates the collection of Rx statistics and allocates memory for their
378 storage. A separate record is kept for each type of RPC (FetchFile,
379 GetStatus, and so on) sent or received, aggregated over all connections to
380 other machines. To display or otherwise access the records, use the Rx
381 Monitoring API.
382
383 =item B<-help>
384
385 Prints the online help for this command. All other valid options are
386 ignored.
387
388 =back
389
390 =head1 EXAMPLES
391
392 The following B<bos create> command creates an fs process on the file
393 server machine C<fs2.abc.com> that uses the large configuration size, and
394 allows volumes to exceed their quota by 10%. Type the command on a single
395 line:
396
397    % bos create -server fs2.abc.com -instance fs -type fs \
398                 -cmd "/usr/afs/bin/fileserver -pctspare 10 \
399                 -L" /usr/afs/bin/volserver /usr/afs/bin/salvager
400
401 =head1 PRIVILEGE REQUIRED
402
403 The issuer must be logged in as the superuser C<root> on a file server
404 machine to issue the command at a command shell prompt. It is conventional
405 instead to create and start the process by issuing the B<bos create>
406 command.
407
408 =head1 SEE ALSO
409
410 L<BosConfig(5)>,
411 L<FileLog(5)>,
412 L<bos_create(8)>,
413 L<bos_getlog(8)>,
414 L<fs_setacl(1)>,
415 L<salvager(8)>,
416 L<volserver(8)>
417
418 =head1 COPYRIGHT
419
420 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
421
422 This documentation is covered by the IBM Public License Version 1.0.  It was
423 converted from HTML to POD by software written by Chas Williams and Russ
424 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.