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