document dafileserver
[openafs.git] / doc / man-pages / pod8 / fragments / fileserver-options.pod
1 =over 4
2
3 =item B<-auditlog> <I<log path>>
4
5 Turns on audit logging, and sets the path for the audit log.  The audit
6 log records information about RPC calls, including the name of the RPC
7 call, the host that submitted the call, the authenticated entity (user)
8 that issued the call, the parameters for the call, and if the call
9 succeeded or failed.
10
11 =item B<-audit-interface> (file | sysvmq)
12
13 Specifies what audit interface to use. The C<file> interface writes audit
14 messages to the file passed to B<-auditlog>. The C<sysvmq> interface
15 writes audit messages to a SYSV message (see L<msgget(2)> and
16 L<msgrcv(2)>). The message queue the C<sysvmq> interface writes to has the
17 key C<ftok(path, 1)>, where C<path> is the path specified in the
18 B<-auditlog> option.
19
20 Defaults to C<file>.
21
22 =item B<-d> <I<debug level>>
23
24 Sets the detail level for the debugging trace written to the
25 F</usr/afs/logs/FileLog> file. Provide one of the following values, each
26 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
27 and C<125>. The default value of C<0> produces only a few messages.
28
29 =item B<-p> <I<number of processes>>
30
31 Sets the number of threads (or LWPs) to run. Provide a positive integer. 
32 The File Server creates and uses five threads for special purposes, 
33 in addition to the number specified (but if this argument specifies 
34 the maximum possible number, the File Server automatically uses five 
35 of the threads for its own purposes).
36
37 The maximum number of threads can differ in each release of OpenAFS.
38 Consult the I<OpenAFS Release Notes> for the current release.
39
40 =item B<-spare> <I<number of spare blocks>>
41
42 Specifies the number of additional kilobytes an application can store in a
43 volume after the quota is exceeded. Provide a positive integer; a value of
44 C<0> prevents the volume from ever exceeding its quota. Do not combine
45 this argument with the B<-pctspare> argument.
46
47 =item B<-pctspare> <I<percentage spare>>
48
49 Specifies the amount by which the File Server allows a volume to exceed
50 its quota, as a percentage of the quota. Provide an integer between C<0>
51 and C<99>. A value of C<0> prevents the volume from ever exceeding its
52 quota. Do not combine this argument with the B<-spare> argument.
53
54 =item B<-b> <I<buffers>>
55
56 Sets the number of directory buffers. Provide a positive integer.
57
58 =item B<-l> <I<large vnodes>>
59
60 Sets the number of large vnodes available in memory for caching directory
61 elements. Provide a positive integer.
62
63 =item B<-s> <I<small nodes>>
64
65 Sets the number of small vnodes available in memory for caching file
66 elements. Provide a positive integer.
67
68 =item B<-vc> <I<volume cachesize>>
69
70 Sets the number of volumes the File Server can cache in memory.  Provide a
71 positive integer.
72
73 =item B<-w> <I<call back wait interval>>
74
75 Sets the interval at which the daemon spawned by the File Server performs
76 its maintenance tasks. Do not use this argument; changing the default
77 value can cause unpredictable behavior.
78
79 =item B<-cb> <I<number of callbacks>>
80
81 Sets the number of callbacks the File Server can track. Provide a positive
82 integer.
83
84 =item B<-banner>
85
86 Prints the following banner to F</dev/console> about every 10 minutes.
87
88    File Server is running at I<time>.
89
90 =item B<-novbc>
91
92 Prevents the File Server from breaking the callbacks that Cache Managers
93 hold on a volume that the File Server is reattaching after the volume was
94 offline (as a result of the B<vos restore> command, for example). Use of
95 this flag is strongly discouraged.
96
97 =item B<-implicit> <I<admin mode bits>>
98
99 Defines the set of permissions granted by default to the
100 system:administrators group on the ACL of every directory in a volume
101 stored on the file server machine. Provide one or more of the standard
102 permission letters (C<rlidwka>) and auxiliary permission letters
103 (C<ABCDEFGH>), or one of the shorthand notations for groups of permissions
104 (C<all>, C<none>, C<read>, and C<write>). To review the meaning of the
105 permissions, see the B<fs setacl> reference page.
106
107 =item B<-readonly>
108
109 Don't allow writes to this fileserver.
110
111 =item B<-hr> <I<number of hours between refreshing the host cps>>
112
113 Specifies how often the File Server refreshes its knowledge of the
114 machines that belong to protection groups (refreshes the host CPSs for
115 machines). The File Server must update this information to enable users
116 from machines recently added to protection groups to access data for which
117 those machines now have the necessary ACL permissions.
118
119 =item B<-busyat> <I<< redirect clients when queue > n >>>
120
121 Defines the number of incoming RPCs that can be waiting for a response
122 from the File Server before the File Server returns the error code
123 C<VBUSY> to the Cache Manager that sent the latest RPC. In response, the
124 Cache Manager retransmits the RPC after a delay. This argument prevents
125 the accumulation of so many waiting RPCs that the File Server can never
126 process them all. Provide a positive integer.  The default value is
127 C<600>.
128
129 =item B<-rxpck> <I<number of rx extra packets>>
130
131 Controls the number of Rx packets the File Server uses to store data for
132 incoming RPCs that it is currently handling, that are waiting for a
133 response, and for replies that are not yet complete. Provide a positive
134 integer.
135
136 =item B<-rxdbg>
137
138 Writes a trace of the File Server's operations on Rx packets to the file
139 F</usr/afs/logs/rx_dbg>.
140
141 =item B<-rxdbge>
142
143 Writes a trace of the File Server's operations on Rx events (such as
144 retransmissions) to the file F</usr/afs/logs/rx_dbg>.
145
146 =item B<-rxmaxmtu> <I<bytes>>
147
148 Defines the maximum size of an MTU.  The value must be between the
149 minimum and maximum packet data sizes for Rx.
150
151 =item B<-jumbo>
152
153 Allows the server to send and receive jumbograms. A jumbogram is
154 a large-size packet composed of 2 to 4 normal Rx data packets that share
155 the same header. The fileserver does not use jumbograms by default, as some
156 routers are not capable of properly breaking the jumbogram into smaller
157 packets and reassembling them.
158
159 =item B<-nojumbo>
160
161 Deprecated; jumbograms are disabled by default.
162
163 =item B<-rxbind>
164
165 Force the fileserver to only bind to one IP address.
166
167 =item B<-allow-dotted-principals>
168
169 By default, the RXKAD security layer will disallow access by Kerberos
170 principals with a dot in the first component of their name. This is to avoid
171 the confusion where principals user/admin and user.admin are both mapped to the
172 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
173 between principal names may disable this check by starting the server
174 with this option.
175
176 =item B<-L>
177
178 Sets values for many arguments in a manner suitable for a large file
179 server machine. Combine this flag with any option except the B<-S> flag;
180 omit both flags to set values suitable for a medium-sized file server
181 machine.
182
183 =item B<-S>
184
185 Sets values for many arguments in a manner suitable for a small file
186 server machine. Combine this flag with any option except the B<-L> flag;
187 omit both flags to set values suitable for a medium-sized file server
188 machine.
189
190 =item B<-k> <I<stack size>>
191
192 Sets the LWP stack size in units of 1 kilobyte. Do not use this argument,
193 and in particular do not specify a value less than the default of C<24>.
194
195 =item B<-realm> <I<Kerberos realm name>>
196
197 Defines the Kerberos realm name for the File Server to use. If this
198 argument is not provided, it uses the realm name corresponding to the cell
199 listed in the local F</usr/afs/etc/ThisCell> file.
200
201 =item B<-udpsize> <I<size of socket buffer in bytes>>
202
203 Sets the size of the UDP buffer, which is 64 KB by default. Provide a
204 positive integer, preferably larger than the default.
205
206 =item B<-sendsize> <I<size of send buffer in bytes>>
207
208 Sets the size of the send buffer, which is 16384 bytes by default.
209
210 =item B<-abortthreshold> <I<abort threshold>>
211
212 Sets the abort threshold, which is triggered when an AFS client sends
213 a number of FetchStatus requests in a row and all of them fail due to
214 access control or some other error. When the abort threshold is
215 reached, the file server starts to slow down the responses to the
216 problem client in order to reduce the load on the file server.
217
218 The throttling behaviour can cause issues especially for some versions
219 of the Windows OpenAFS client. When using Windows Explorer to navigate
220 the AFS directory tree, directories with only "look" access for the
221 current user may load more slowly because of the throttling. This is
222 because the Windows OpenAFS client sends FetchStatus calls one at a
223 time instead of in bulk like the Unix Open AFS client.
224
225 Setting the threshold to 0 disables the throttling behavior. This
226 option is available in OpenAFS versions 1.4.1 and later.
227
228 =item B<-enable_peer_stats>
229
230 Activates the collection of Rx statistics and allocates memory for their
231 storage. For each connection with a specific UDP port on another machine,
232 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
233 so on) sent or received. To display or otherwise access the records, use
234 the Rx Monitoring API.
235
236 =item B<-enable_process_stats>
237
238 Activates the collection of Rx statistics and allocates memory for their
239 storage. A separate record is kept for each type of RPC (FetchFile,
240 GetStatus, and so on) sent or received, aggregated over all connections to
241 other machines. To display or otherwise access the records, use the Rx
242 Monitoring API.
243
244 =item B<-syslog [<loglevel>]
245
246 Use syslog instead of the normal logging location for the fileserver
247 process.  If provided, log messages are at <loglevel> instead of the
248 default LOG_USER.
249
250 =item B<-mrafslogs>
251
252 Use MR-AFS (Multi-Resident) style logging.  This option is deprecated.
253
254 =item B<-saneacls>
255
256 Offer the SANEACLS capability for the fileserver.  This option is
257 currently unimplemented.
258
259 =item B<-help>
260
261 Prints the online help for this command. All other valid options are
262 ignored.
263
264 =item B<-vhandle-setaside> <I<fds reserved for non-cache io>>
265
266 Number of file handles set aside for I/O not in the cache. Defaults to 128.
267
268 =item B<-vhandle-max-cachesize> <I<max open files>>
269
270 Maximum number of available file handles.
271
272 =item B<-vhandle-initial-cachesize> <I<initial open file cache>>
273
274 Number of file handles set aside for I/O in the cache. Defaults to 128.
275
276 =item B<-vattachpar> <I<number of volume attach threads>>
277
278 The number of threads assigned to attach and detach volumes.  The default
279 is 1.  Warning: many of the I/O parallism features of Demand-Attach
280 Fileserver are turned off when the number of volume attach threads is only
281 1.
282
283 This option is only meaningful for a file server built with pthreads
284 support.
285
286 =item B<-m> <I<min percentage spare in partition>>
287
288 Specifies the percentage of each AFS server partition that the AIX version
289 of the File Server creates as a reserve. Specify an integer value between
290 C<0> and C<30>; the default is 8%. A value of C<0> means that the
291 partition can become completely full, which can have serious negative
292 consequences.  This option is not supported on platforms other than AIX.
293
294 =item B<-lock>
295
296 Prevents any portion of the fileserver binary from being paged (swapped)
297 out of memory on a file server machine running the IRIX operating system.
298 This option is not supported on platforms other than IRIX.