doc/man-pages/pod8/vlserver.pod

   1 =head1 NAME
   2
   3 vlserver - Initializes the Volume Location Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 vlserver [B<-noauth>] [B<-smallmem>]
  11     S<<< [B<-p> <I<number of threads>>] >>> [B<-nojumbo>]
  12     [B<-jumbo>] [B<-rxbind>]
  13     S<<< [B<-d> <I<debug level>>] >>>
  14     S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
  15     S<<< [B<-trace> <I<trace file>>] >>>
  16     [B<-allow-dotted-principals>]
  17     S<<< [B<-database> | B<-db> <I<database path>>] >>>
  18     S<<< [B<-logfile> <I<log file>>] >>>
  19     S<<< [B<-config> <I<configuration path>>] >>>
  20     S<<< [B<-syslog>[=<I<facility>>]>] >>>
  21     [B<-enable_peer_stats>] [B<-enable_process_stats>]
  22     S<<< [B<-auditlog> <I<log path>>] >>>
  23     S<<< [B<-audit-interface> (file | sysvmq)] >>>
  24     S<<< [B<-restricted_query> (anyuser | admin)] >>>
  25     [B<-help>]
  26
  27 =for html
  28 </div>
  29
  30 =head1 DESCRIPTION
  31
  32 The B<vlserver> command initializes the Volume Location (VL) Server, which
  33 runs on every database server machine. In the conventional configuration,
  34 its binary file is located in the F</usr/afs/bin> directory on a file
  35 server machine.
  36
  37 The B<vlserver> command is not normally issued at the command shell prompt
  38 but rather placed into a file server machine's F</usr/afs/local/BosConfig>
  39 file with the B<bos create> command. If it is ever issued at the command
  40 shell prompt, the issuer must be logged onto a database server machine as
  41 the local superuser C<root>.
  42
  43 As it initializes, the VL Server process creates the two files that
  44 constitute the Volume Location Database (VLDB), F<vldb.DB0> and
  45 F<vldb.DBSYS1>, in the F</usr/afs/db> directory if they do not already
  46 exist. Use the commands in the B<vos> suite to administer the database.
  47
  48 The VL Server maintains the record of volume locations in the Volume
  49 Location Database (VLDB). When the Cache Manager fills a file request from
  50 an application program, it first contacts the VL Server to learn which
  51 file server machine currently houses the volume that contains the file.
  52 The Cache Manager then requests the file from the File Server process
  53 running on that file server machine.
  54
  55 The VL Server records a trace of its activity in the
  56 F</usr/afs/logs/VLLog> file. Use the B<bos getlog> command to display the
  57 contents of the file. By default, it records on a minimal number of
  58 messages. For instructions on increasing the amount of logging, see
  59 L<VLLog(5)>.
  60
  61 By default, the VL Server runs nine lightweight processes (LWPs). To
  62 change the number, use the B<-p> argument.
  63
  64 This command does not use the syntax conventions of the AFS command
  65 suites. Provide the command name and all option names in full.
  66
  67 =head1 OPTIONS
  68
  69 =over 4
  70
  71 =item B<-d> <I<debug level>>
  72
  73 Sets the detail level for the debugging trace written to the
  74 F</usr/afs/logs/VLLog> file. Provide one of the following values, each
  75 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
  76 and C<125>.
  77
  78 =item B<-p> <I<number of threads>>
  79
  80 Sets the number of server lightweight processes (LWPs or pthreads) to run.
  81 Provide an integer between C<3> and C<64>. The default is C<9>.
  82
  83 =item B<-jumbo>
  84
  85 Allows the server to send and receive jumbograms. A jumbogram is
  86 a large-size packet composed of 2 to 4 normal Rx data packets that share
  87 the same header. The VL Server does not use jumbograms by default, as some
  88 routers are not capable of properly breaking the jumbogram into smaller
  89 packets and reassembling them.
  90
  91 =item B<-nojumbo>
  92
  93 Deprecated; Jumbograms are disabled by default.
  94
  95 =item B<-enable_peer_stats>
  96
  97 Activates the collection of Rx statistics and allocates memory for their
  98 storage. For each connection with a specific UDP port on another machine,
  99 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 100 so on) sent or received. To display or otherwise access the records, use
 101 the Rx Monitoring API.
 102
 103 =item B<-enable_process_stats>
 104
 105 Activates the collection of Rx statistics and allocates memory for their
 106 storage. A separate record is kept for each type of RPC (FetchFile,
 107 GetStatus, and so on) sent or received, aggregated over all connections to
 108 other machines. To display or otherwise access the records, use the Rx
 109 Monitoring API.
 110
 111 =item B<-allow-dotted-principals>
 112
 113 By default, the RXKAD security layer will disallow access by Kerberos
 114 principals with a dot in the first component of their name. This is to avoid
 115 the confusion where principals user/admin and user.admin are both mapped to the
 116 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions
 117 between principal names may disable this check by starting the server
 118 with this option.
 119
 120 =item B<-auditlog> <I<log path>>
 121
 122 Turns on audit logging, and sets the path for the audit log.  The audit
 123 log records information about RPC calls, including the name of the RPC
 124 call, the host that submitted the call, the authenticated entity (user)
 125 that issued the call, the parameters for the call, and if the call
 126 succeeded or failed.
 127
 128 =item B<-audit-interface> (file | sysvmq)
 129
 130 Specifies what audit interface to use. Defaults to C<file>. See
 131 L<fileserver(8)> for an explanation of each interface.
 132
 133 =item B<-rxbind>
 134
 135 Bind the Rx socket to the primary interface only.  (If not specified, the
 136 Rx socket will listen on all interfaces.)
 137
 138 =item B<-syslog>[=<I<syslog facility>>]
 139
 140 Specifies that logging output should go to syslog instead of the normal log
 141 file. B<-syslog>=I<FACILITY> can be used to specify to which facility the log
 142 message should be sent. Logging message sent to syslog are tagged with the
 143 string "vlserver".
 144
 145 =item B<-noauth>
 146
 147 Turns off all authorization checks, and allows all connecting users to act as
 148 administrators, even unauthenticated users. The use of this option is
 149 inherently insecure, and should only be used in controlled environments for
 150 experimental or debug purposes. See L<NoAuth(5)>.
 151
 152 =item B<-smallmem>
 153
 154 Specifies that the vlserver should limit its memory usage during certain
 155 operations, and return an error to the calling client instead of allocating
 156 more memory. This option is only useful on systems where memory is severely
 157 limited, and should not be needed on any remotely modern system.
 158
 159 =item B<-rxmaxmtu> <I<bytes>>
 160
 161 Sets the maximum transmission unit for the RX protocol.
 162
 163 =item B<-trace> <I<trace file>>
 164
 165 Turns on low-level Rx packet tracing, and logs the trace information to the
 166 specified file. The trace file can be later dumped into a human-readable form
 167 with a tool called B<dumptrace>.
 168
 169 It is not recommended to turn on this option during normal operation, since the
 170 detailed tracing may cause performance issues and use up a lot of disk space.
 171
 172 =item B<-logfile> <I<log file>>
 173
 174 Sets the file to use for server logging. If logfile is not specified, and
 175 no other logging options are supplied, this will be F</usr/afs/logs/VLLog>.
 176 Note that this option is intended for debugging and testing purposes.
 177 Changing the location of the log file from the command line may result
 178 in undesirable interactions with tools such as B<bos>.
 179
 180 =item B<-database> | B<-db> <I<database path>>
 181
 182 Set the location of the database used by this program. This option is
 183 intended primarily for testing purposes.
 184
 185 =item B<-config> <I<configuration directory>>
 186
 187 Set the location of the configuration directory used to configure this
 188 service. In a typical configuration this will be F</usr/afs/etc> - this
 189 option allows the use of alternative configuration locations for testing
 190 purposes.
 191
 192 =item B<-restricted_query> (anyuser | admin)
 193
 194 Restrict RPCs that query information about volumes to a specific group
 195 of users. Only the RPCs that are not used by cache managers will be
 196 restricted, since cache manager connections to the Volume Server are
 197 always unauthenticated. You can use C<admin> to restrict to AFS
 198 administrators.  The C<anyuser> option doesn't restrict the RPCs and
 199 leaves it open for all users including unauthenticated users, this is
 200 the default.
 201
 202 =item B<-help>
 203
 204 Prints the online help for this command. All other valid options are
 205 ignored.
 206
 207 =back
 208
 209 =head1 EXAMPLES
 210
 211 The following B<bos create> command creates a vlserver process on the
 212 machine C<fs2.example.com> that uses six lightweight processes. Type the
 213 command on a single line:
 214
 215    % bos create -server fs2.example.com -instance vlserver -type simple \
 216                 -cmd "/usr/afs/bin/vlserver -p 6"
 217
 218 =head1 PRIVILEGE REQUIRED
 219
 220 The issuer must be logged in as the superuser C<root> on a file server
 221 machine to issue the command at a command shell prompt. It is conventional
 222 instead to create and start the process by issuing the B<bos create>
 223 command.
 224
 225 =head1 SEE ALSO
 226
 227 L<BosConfig(5)>,
 228 L<VLLog(5)>,
 229 L<vldb.DB0(5)>,
 230 L<bos_create(8)>,
 231 L<bos_getlog(8)>
 232
 233 =head1 COPYRIGHT
 234
 235 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 236
 237 This documentation is covered by the IBM Public License Version 1.0.  It was
 238 converted from HTML to POD by software written by Chas Williams and Russ
 239 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.