Use rxkad_crypt for inter-volser traffic, if asked
[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<-transarc-logs>
18
19 Use Transarc style logging features. Rename the log file
20 F</usr/afs/logs/VolserLog> to F</usr/afs/logs/VolserLog.old> when the volume server is
21 restarted.  This option is provided for compatibility with older versions.
22
23 =item B<-p> <I<number of processes>>
24
25 Sets the number of server lightweight processes (LWPs) to run.  Provide an
26 integer between C<4> and C<16>. The default is C<9>.
27
28 =item B<-auditlog> <I<log path>>
29
30 Turns on audit logging, and sets the path for the audit log.  The audit
31 log records information about RPC calls, including the name of the RPC
32 call, the host that submitted the call, the authenticated entity (user)
33 that issued the call, the parameters for the call, and if the call
34 succeeded or failed.
35
36 =item B<-audit-interface> (file | sysvmq)
37
38 Specifies what audit interface to use. Defaults to C<file>. See
39 L<fileserver(8)> for an explanation of each interface.
40
41 =item B<-udpsize> <I<size of socket buffer>>
42
43 Sets the size of the UDP buffer in bytes, which is 64 KB by
44 default. Provide a positive integer, preferably larger than the default.
45
46 =item B<-jumbo>
47
48 Allows the server to send and receive jumbograms. A jumbogram is
49 a large-size packet composed of 2 to 4 normal Rx data packets that share
50 the same header. The volserver does not use jumbograms by default, as some
51 routers are not capable of properly breaking the jumbogram into smaller
52 packets and reassembling them.
53
54 =item B<-nojumbo>
55
56 Deprecated; jumbograms are disabled by default.
57
58 =item B<-enable_peer_stats>
59
60 Activates the collection of Rx statistics and allocates memory for their
61 storage. For each connection with a specific UDP port on another machine,
62 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
63 so on) sent or received. To display or otherwise access the records, use
64 the Rx Monitoring API.
65
66 =item B<-enable_process_stats>
67
68 Activates the collection of Rx statistics and allocates memory for their
69 storage. A separate record is kept for each type of RPC (FetchFile,
70 GetStatus, and so on) sent or received, aggregated over all connections to
71 other machines. To display or otherwise access the records, use the Rx
72 Monitoring API.
73
74 =item B<-allow-dotted-principals>
75
76 By default, the RXKAD security layer will disallow access by Kerberos
77 principals with a dot in the first component of their name. This is to avoid
78 the confusion where principals user/admin and user.admin are both mapped to the
79 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
80 between principal names may disable this check by starting the server
81 with this option.
82
83 =item B<-preserve-vol-stats>
84
85 Preserve volume access statistics over volume restore and reclone operations.
86 By default, volume access statistics are reset during volume restore and reclone
87 operations.
88
89 =item B<-sync> <I<sync behavior>>
90
91 This is the same as the B<-sync> option in L<fileserver(8)>. See
92 L<fileserver(8)>.
93
94 =item B<-logfile> <I<log file>>
95
96 Sets the file to use for server logging.  If logfile is not specified and
97 no other logging options are supplied, this will be F</usr/afs/logs/VolserLog>.
98 Note that this option is intended for debugging and testing purposes.
99 Changing the location of the log file from the command line may result
100 in undesirable interactions with tools such as B<bos>.
101
102 =item B<-config> <I<configuration directory>>
103
104 Set the location of the configuration directory used to configure this
105 service.  In a typical configuration this will be F</usr/afs/etc> - this
106 option allows the use of alternative configuration locations for testing
107 purposes.
108
109 =item B<-rxmaxmtu> <I<bytes>>
110
111 Defines the maximum size of an MTU.  The value must be between the
112 minimum and maximum packet data sizes for Rx.
113
114 =item B<-rxbind>
115
116 Bind the Rx socket to the primary interface only. (If not specified, the Rx
117 socket will listen on all interfaces.)
118
119 =item B<-syslog>[=<I<syslog facility>>]
120
121 Specifies that logging output should go to syslog instead of the normal
122 log file. B<-syslog>=I<FACILITY> can be used to specify to which facility
123 the log message should be sent.
124
125 =item B<-sleep> <I<sleep_time>/I<run_time>>
126
127 This option is obsolete, and is now only accepted for compatibility with older
128 releases. All it does now is log a warning message about how the option is
129 obsolete.
130
131 =item B<-restricted_query> (anyuser | admin)
132
133 Restrict RPCs that query information about volumes to a specific group
134 of users. You can use C<admin> to restrict to AFS administrators.  The
135 C<anyuser> option doesn't restrict the RPCs and leaves it open for all
136 users including unauthenticated users, this is the default.
137
138 =item B<-s2scrypt> (never | always | inherit)
139
140 Set the cryptographic disposition of inter-volserver traffic.
141
142 =over 4
143
144 =item B<never>
145
146 All inter-volserver traffic is unencrypted.  This is the default behavior.
147
148 =item B<always>
149
150 All inter-volserver traffic is encrypted (using rxkad).
151
152 =item B<inherit>
153
154 Inter-volserver traffic will be encrypted if the client connection triggering
155 the server-to-server traffic is encrypted.  This has the effect of encrypting
156 inter-server traffic if the "-encrypt" option is provided to
157 L<B<vos release>|vos_release(1)>, for example.
158
159 =back
160
161 =item B<-help>
162
163 Prints the online help for this command. All other valid options are
164 ignored.
165
166 =back