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