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 B<vlserver> S<<< [B<-p> <I<lwp processes>>] >>> [B<-nojumbo>]
  11     [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>]
  12
  13 =for html
  14 </div>
  15
  16 =head1 DESCRIPTION
  17
  18 The B<vlserver> command initializes the Volume Location (VL) Server, which
  19 runs on every database server machine. In the conventional configuration,
  20 its binary file is located in the F</usr/afs/bin> directory on a file
  21 server machine.
  22
  23 The B<vlserver> command is not normally issued at the command shell prompt
  24 but rather placed into a file server machine's F</usr/afs/local/BosConfig>
  25 file with the B<bos create> command. If it is ever issued at the command
  26 shell prompt, the issuer must be logged onto a database server machine as
  27 the local superuser C<root>.
  28
  29 As it initializes, the VL Server process creates the two files that
  30 constitute the Volume Location Database (VLDB), F<vldb.DB0> and
  31 F<vldb.DBSYS1>, in the F</usr/afs/db> directory if they do not already
  32 exist. Use the commands in the B<vos> suite to administer the database.
  33
  34 The VL Server maintains the record of volume locations in the Volume
  35 Location Database (VLDB). When the Cache Manager fills a file request from
  36 an application program, it first contacts the VL Server to learn which
  37 file server machine currently houses the volume that contains the file.
  38 The Cache Manager then requests the file from the File Server process
  39 running on that file server machine.
  40
  41 The VL Server records a trace of its activity in the
  42 F</usr/afs/logs/VLLog> file. Use the B<bos getlog> command to display the
  43 contents of the file. By default, it records on a minimal number of
  44 messages. For instructions on increasing the amount of logging, see
  45 L<VLLog(5)>.
  46
  47 By default, the VL Server runs nine lightweight processes (LWPs). To
  48 change the number, use the B<-p> argument.
  49
  50 This command does not use the syntax conventions of the AFS command
  51 suites. Provide the command name and all option names in full.
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item B<-p> <I<lwp processes>>
  58
  59 Sets the number of server lightweight processes (LWPs) to run.  Provide an
  60 integer between C<4> and C<16>. The default is C<9>.
  61
  62 =item B<-nojumbo>
  63
  64 Prohibits the server from sending or receiving jumbograms. A jumbogram is
  65 a large-size packet composed of 2 to 4 normal Rx data packets that share
  66 the same header. The VL Server uses jumbograms by default, but some
  67 routers are not capable of properly breaking the jumbogram into smaller
  68 packets and reassembling them.
  69
  70 =item B<-enable_peer_stats>
  71
  72 Activates the collection of Rx statistics and allocates memory for their
  73 storage. For each connection with a specific UDP port on another machine,
  74 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
  75 so on) sent or received. To display or otherwise access the records, use
  76 the Rx Monitoring API.
  77
  78 =item B<-enable_process_stats>
  79
  80 Activates the collection of Rx statistics and allocates memory for their
  81 storage. A separate record is kept for each type of RPC (FetchFile,
  82 GetStatus, and so on) sent or received, aggregated over all connections to
  83 other machines. To display or otherwise access the records, use the Rx
  84 Monitoring API.
  85
  86 =item B<-help>
  87
  88 Prints the online help for this command. All other valid options are
  89 ignored.
  90
  91 =back
  92
  93 =head1 EXAMPLES
  94
  95 The following B<bos create> command creates a vlserver process on the
  96 machine C<fs2.abc.com> that uses six lightweight processes. Type the
  97 command on a single line:
  98
  99    % bos create -server fs2.abc.com -instance vlserver -type simple \
 100                 -cmd "/usr/afs/bin/vlserver -p 6"
 101
 102 =head1 PRIVILEGE REQUIRED
 103
 104 The issuer must be logged in as the superuser C<root> on a file server
 105 machine to issue the command at a command shell prompt. It is conventional
 106 instead to create and start the process by issuing the B<bos create>
 107 command.
 108
 109 =head1 SEE ALSO
 110
 111 L<BosConfig(5)>,
 112 L<VLLog(5)>,
 113 L<vldb.DB0(5)>,
 114 L<bos_create(8)>,
 115 L<bos_getlog(8)>
 116
 117 =head1 COPYRIGHT
 118
 119 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 120
 121 This documentation is covered by the IBM Public License Version 1.0.  It was
 122 converted from HTML to POD by software written by Chas Williams and Russ
 123 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.