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