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<-clear-vol-stats>
  84
  85 Clear volume access statistics during volume restore and reclone operations.
  86 This includes clearing the volume access statistics of read-only volumes during
  87 a volume release.  By default, volume access statistics are preserved during
  88 volume restore and reclone operations.
  89
  90 Volume access statistics were cleared by default in versions prior to OpenAFS
  91 1.8.0.  This flag is intended to provide compatible behaviour.
  92
  93 =item B<-sync> <I<sync behavior>>
  94
  95 This is the same as the B<-sync> option in L<fileserver(8)>. See
  96 L<fileserver(8)>.
  97
  98 =item B<-logfile> <I<log file>>
  99
 100 Sets the file to use for server logging.  If logfile is not specified and
 101 no other logging options are supplied, this will be F</usr/afs/logs/VolserLog>.
 102 Note that this option is intended for debugging and testing purposes.
 103 Changing the location of the log file from the command line may result
 104 in undesirable interactions with tools such as B<bos>.
 105
 106 =item B<-config> <I<configuration directory>>
 107
 108 Set the location of the configuration directory used to configure this
 109 service.  In a typical configuration this will be F</usr/afs/etc> - this
 110 option allows the use of alternative configuration locations for testing
 111 purposes.
 112
 113 =item B<-rxmaxmtu> <I<bytes>>
 114
 115 Defines the maximum size of an MTU.  The value must be between the
 116 minimum and maximum packet data sizes for Rx.
 117
 118 =item B<-rxbind>
 119
 120 Bind the Rx socket to the primary interface only. (If not specified, the Rx
 121 socket will listen on all interfaces.)
 122
 123 =item B<-syslog>[=<I<syslog facility>>]
 124
 125 Specifies that logging output should go to syslog instead of the normal
 126 log file. B<-syslog>=I<FACILITY> can be used to specify to which facility
 127 the log message should be sent.
 128
 129 =item B<-sleep> <I<sleep_time>/I<run_time>>
 130
 131 This option is obsolete, and is now only accepted for compatibility with older
 132 releases. All it does now is log a warning message about how the option is
 133 obsolete.
 134
 135 =item B<-restricted_query> (anyuser | admin)
 136
 137 Restrict RPCs that query information about volumes to a specific group
 138 of users. You can use C<admin> to restrict to AFS administrators.  The
 139 C<anyuser> option doesn't restrict the RPCs and leaves it open for all
 140 users including unauthenticated users, this is the default.
 141
 142 =item B<-s2scrypt> (never | always | inherit)
 143
 144 Set the cryptographic disposition of inter-volserver traffic.
 145
 146 =over 4
 147
 148 =item B<never>
 149
 150 All inter-volserver traffic is unencrypted.  This is the default behavior.
 151
 152 =item B<always>
 153
 154 All inter-volserver traffic is encrypted (using rxkad).
 155
 156 =item B<inherit>
 157
 158 Inter-volserver traffic will be encrypted if the client connection triggering
 159 the server-to-server traffic is encrypted.  This has the effect of encrypting
 160 inter-server traffic if the "-encrypt" option is provided to
 161 L<B<vos release>|vos_release(1)>, for example.
 162
 163 =back
 164
 165 =item B<-help>
 166
 167 Prints the online help for this command. All other valid options are
 168 ignored.
 169
 170 =back