3 =item B<-auditlog> <I<log path>>
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
11 =item B<-audit-interface> (file | sysvmq)
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
22 =item B<-d> <I<debug level>>
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.
29 =item B<-p> <I<number of processes>>
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).
37 The maximum number of threads can differ in each release of OpenAFS.
38 Consult the I<OpenAFS Release Notes> for the current release.
40 =item B<-spare> <I<number of spare blocks>>
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.
47 =item B<-pctspare> <I<percentage spare>>
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.
54 =item B<-b> <I<buffers>>
56 Sets the number of directory buffers. Provide a positive integer.
58 =item B<-l> <I<large vnodes>>
60 Sets the number of large vnodes available in memory for caching directory
61 elements. Provide a positive integer.
63 =item B<-s> <I<small nodes>>
65 Sets the number of small vnodes available in memory for caching file
66 elements. Provide a positive integer.
68 =item B<-vc> <I<volume cachesize>>
70 Sets the number of volumes the File Server can cache in memory. Provide a
73 =item B<-w> <I<call back wait interval>>
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.
79 =item B<-cb> <I<number of callbacks>>
81 Sets the number of callbacks the File Server can track. Provide a positive
86 Prints the following banner to F</dev/console> about every 10 minutes.
88 File Server is running at I<time>.
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.
97 =item B<-implicit> <I<admin mode bits>>
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.
109 Don't allow writes to this fileserver.
111 =item B<-hr> <I<number of hours between refreshing the host cps>>
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.
119 =item B<-busyat> <I<< redirect clients when queue > n >>>
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
129 =item B<-rxpck> <I<number of rx extra packets>>
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
138 Writes a trace of the File Server's operations on Rx packets to the file
139 F</usr/afs/logs/rx_dbg>.
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>.
146 =item B<-rxmaxmtu> <I<bytes>>
148 Defines the maximum size of an MTU. The value must be between the
149 minimum and maximum packet data sizes for Rx.
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.
161 Deprecated; jumbograms are disabled by default.
165 Force the fileserver to only bind to one IP address.
167 =item B<-allow-dotted-principals>
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
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
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
190 =item B<-k> <I<stack size>>
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>.
195 =item B<-realm> <I<Kerberos realm name>>
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.
201 =item B<-udpsize> <I<size of socket buffer in bytes>>
203 Sets the size of the UDP buffer, which is 64 KB by default. Provide a
204 positive integer, preferably larger than the default.
206 =item B<-sendsize> <I<size of send buffer in bytes>>
208 Sets the size of the send buffer, which is 16384 bytes by default.
210 =item B<-abortthreshold> <I<abort threshold>>
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.
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.
225 Setting the threshold to 0 disables the throttling behavior. This
226 option is available in OpenAFS versions 1.4.1 and later.
228 =item B<-enable_peer_stats>
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.
236 =item B<-enable_process_stats>
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
244 =item B<-syslog [<loglevel>]
246 Use syslog instead of the normal logging location for the fileserver
247 process. If provided, log messages are at <loglevel> instead of the
252 Use MR-AFS (Multi-Resident) style logging. This option is deprecated.
256 Offer the SANEACLS capability for the fileserver. This option is
257 currently unimplemented.
261 Prints the online help for this command. All other valid options are
264 =item B<-vhandle-setaside> <I<fds reserved for non-cache io>>
266 Number of file handles set aside for I/O not in the cache. Defaults to 128.
268 =item B<-vhandle-max-cachesize> <I<max open files>>
270 Maximum number of available file handles.
272 =item B<-vhandle-initial-cachesize> <I<initial open file cache>>
274 Number of file handles set aside for I/O in the cache. Defaults to 128.
276 =item B<-vattachpar> <I<number of volume attach threads>>
278 The number of threads assigned to attach and detach volumes. The default
279 is 1. Warning: many of the I/O parallelism features of Demand-Attach
280 Fileserver are turned off when the number of volume attach threads is only
283 This option is only meaningful for a file server built with pthreads
286 =item B<-m> <I<min percentage spare in partition>>
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.
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.
300 =item B<-offline-timeout> <I<timeout in seconds>>
302 Setting this option to I<N> means that if any clients are reading from a
303 volume when we want to offline that volume (for example, as part of
304 releasing a volume), we will wait I<N> seconds for the clients' request
305 to finish. If the clients' requests have not finished, we will then
306 interrupt the client requests and send an error to those clients,
307 allowing the volume to go offline.
309 If a client is interrupted, from the client's point of view, it will
310 appear as if they had accessed the volume after it had gone offline. For
311 RO volumes, this mean the client should fail-over to other valid RO
312 sites for that volume. This option may speed up volume releases if
313 volumes are being accessed by clients that have slow or unreliable
316 Setting this option to C<0> means to interrupt clients immediately if a
317 volume is waiting to go offline. Setting this option to C<-1> means to
318 wait forever for client requests to finish. The default value is C<-1>.
320 For the LWP fileserver, the only valid value for this option is C<-1>.
322 =item B<-offline-shutdown-timeout> <I<timeout in seconds>>
324 This option behaves similarly to B<-offline-timeout> but applies to
325 volumes that are going offline as part of the fileserver shutdown
326 process. If the value specified is I<N>, we will interrupt any clients
327 reading from volumes after I<N> seconds have passed since we first
328 needed to wait for a volume to offline during the shutdown process.
330 Setting this option to C<0> means to interrupt all clients reading from
331 volumes immediately during the shutdown process. Setting this option to
332 C<-1> means to wait forever for client requests to finish during the
335 If B<-offline-timeout> is specified, the default value of
336 B<-offline-shutdown-timeout> is the value specified for
337 B<-offline-timeout>. Otherwise, the default value is C<-1>.
339 For the LWP fileserver, the only valid value for this option is C<-1>.
341 =item B<-sync> <always | onclose | none>
343 This option changes how hard the fileserver tries to ensure that data written
344 to volumes actually hits the physical disk.
346 Normally, when the fileserver writes to disk, the underlying filesystem or
347 Operating System may delay writes from actually going to disk, and reorder
348 which writes hit the disk first. So, during an unclean shutdown of the machine
349 (if the power goes out, or the machine crashes, etc), file data may become lost
350 that the server previously told clients was already successfully written.
352 To try to mitigate this, the fileserver will try to "sync" file data to the
353 physical disk at numerous points during various I/O. However, this can result
354 in significantly reduced performance. Depending on the usage patterns, this may
355 or may not be acceptable. This option dictates specifically what the fileserver
356 does when it wants to perform a "sync".
358 There are several options; pass one of these as the argument to -sync. The
359 default is C<onclose>.
365 This causes a sync operation to always sync immediately and synchronously.
366 This is the slowest option that provides the greatest protection against data
367 loss in the event of a crash.
369 Note that this is still not a 100% guarantee that data will not be lost or
370 corrupted during a crash. The underlying filesystem itself may cause data to
371 be lost or corrupt in such a situation. And OpenAFS itself does not (yet) even
372 guarantee that all data is consistent at any point in time; so even if the
373 filesystem and OS do not buffer or reorder any writes, you are not guaranteed
374 that all data will be okay after a crash.
376 This was the only behavior allowed in OpenAFS releases prior to 1.4.5.
380 This causes a sync to do nothing immediately, but causes the relevant file to
381 be flagged as potentially needing a sync. When a volume is detached, volume
382 metadata files flaged for synced are synced, as well as data files that have
383 been accessed recently. Events that cause a volume to detach include:
384 performing volume operations (dump, restore, clone, etc), a clean shutdown
385 of the fileserver, or during DAFS "soft detachment".
387 Effectively this option is the same as C<never> while a volume is attached and
388 actively being used, but if a volume is detached, there is an additional
389 guarantee for the data's consistency.
391 After the removal of the C<delayed> option after the OpenAFS 1.6 series, this
392 option became the default.
396 This causes all syncs to never do anything. This is the fastest option, with
397 the weakest guarantees for data consistency.
399 Depending on the underlying filesystem and Operating System, there may be
400 guarantees that any data written to disk will hit the physical media after a
401 certain amount of time. For example, Linux's pdflush process usually makes this
402 guarantee, and ext3 can make certain various consistency guarantees according
403 to the options given. ZFS on Solaris can also provide similar guarantees, as
404 can various other platforms and filesystems. Consult the documentation for
405 your platform if you are unsure.
409 This option used to exist in OpenAFS 1.6, but was later removed due to issues
410 encountered with data corruption during normal operation. Outside of the
411 OpenAFS 1.6 series, it is not a valid option, and the fileserver will fail to
412 start if you specify this (or any other unknown option). It caused syncs to
413 occur in a background thread, executing every 10 seconds.
415 This was the only behavior allowed in OpenAFS releases starting from 1.4.5 up
416 to and including 1.6.2. It was also the default for the 1.6 series starting in
421 Which option you choose is not an easy decision to make. Various developers
422 and experts sometimes disagree on which option is the most reasonable, and it
423 may depend on the specific scenario and workload involved. Some argue that
424 the C<always> option does not provide significantly greater guarantees over
425 any other option, whereas others argue that choosing anything besides the
426 C<always> option allows for an unacceptable risk of data loss. This may
427 depend on your usage patterns, your platform and filesystem, and who you talk
430 =item B<-logfile> <I<log file>>
432 Sets the file to use for server logging. If logfile is not specified and
433 no other logging options are supplied, this will be F</usr/afs/logs/FileLog>.
434 Note that this option is intended for debugging and testing purposes.
435 Changing the location of the log file from the command line may result
436 in undesirable interactions with tools such as B<bos>.
438 =item B<-config> <I<configuration directory>>
440 Set the location of the configuration directory used to configure this
441 service. In a typical configuration this will be F</usr/afs/etc> - this
442 option allows the use of alternative configuration locations for testing