doc/man-pages/pod8/vlserver.pod

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