1ad49a069ca52f3cf7f25e55027128be0207b9c2
[openafs.git] / doc / man-pages / pod8 / fragments / volserver-options.pod
1 =over 4
2
3 =item B<-d> <I<debug level>>
4
5 Sets the detail level for the debugging trace written to the
6 F</usr/afs/logs/VolserLog> file. Provide one of the following values, each
7 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
8 and C<125>. 
9
10 =item B<-log>
11
12 Records in the /usr/afs/logs/VolserLog file the names of all users who
13 successfully initiate a B<vos> command. The Volume Server also records any
14 file removals that result from issuing the B<vos release> command with the
15 B<-f> flag.
16
17 =item B<-p> <I<number of processes>>
18
19 Sets the number of server lightweight processes (LWPs) to run.  Provide an
20 integer between C<4> and C<16>. The default is C<9>.
21
22 =item B<-auditlog> <I<log path>>
23
24 Turns on audit logging, and sets the path for the audit log.  The audit
25 log records information about RPC calls, including the name of the RPC
26 call, the host that submitted the call, the authenticated entity (user)
27 that issued the call, the parameters for the call, and if the call
28 succeeded or failed.
29
30 =item B<-audit-interface> (file | sysvmq)
31
32 Specifies what audit interface to use. Defaults to C<file>. See
33 L<fileserver(8)> for an explanation of each interface.
34
35 =item B<-udpsize> <I<size of socket buffer>>
36
37 Sets the size of the UDP buffer in bytes, which is 64 KB by
38 default. Provide a positive integer, preferably larger than the default.
39
40 =item B<-jumbo>
41
42 Allows the server to send and receive jumbograms. A jumbogram is
43 a large-size packet composed of 2 to 4 normal Rx data packets that share
44 the same header. The volserver does not use jumbograms by default, as some
45 routers are not capable of properly breaking the jumbogram into smaller
46 packets and reassembling them.
47
48 =item B<-nojumbo>
49
50 Deprecated; jumbograms are disabled by default.
51
52 =item B<-enable_peer_stats>
53
54 Activates the collection of Rx statistics and allocates memory for their
55 storage. For each connection with a specific UDP port on another machine,
56 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
57 so on) sent or received. To display or otherwise access the records, use
58 the Rx Monitoring API.
59
60 =item B<-enable_process_stats>
61
62 Activates the collection of Rx statistics and allocates memory for their
63 storage. A separate record is kept for each type of RPC (FetchFile,
64 GetStatus, and so on) sent or received, aggregated over all connections to
65 other machines. To display or otherwise access the records, use the Rx
66 Monitoring API.
67
68 =item B<-allow-dotted-principals>
69
70 By default, the RXKAD security layer will disallow access by Kerberos
71 principals with a dot in the first component of their name. This is to avoid
72 the confusion where principals user/admin and user.admin are both mapped to the
73 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
74 between principal names may disable this check by starting the server
75 with this option.
76
77 =item B<-preserve-vol-stats>
78
79 Preserve volume access statistics over volume restore and reclone operations.
80 By default, volume access statistics are reset during volume restore and reclone
81 operations.
82
83 =item B<-sync> <I<sync behavior>>
84
85 This is the same as the B<-sync> option in L<fileserver(8)>. See
86 L<fileserver(8)>.
87
88 =item B<-help>
89
90 Prints the online help for this command. All other valid options are
91 ignored.
92
93 =back