doc/man-pages/pod8/volserver.pod

   1 =head1 NAME
   2
   3 volserver - Initializes the Volume Server component of the fs process
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<volserver> [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
  11     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
  12     [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<volserver> command initializes the Volume Server component of the
  20 C<fs> process. In the conventional configuration, its binary file is
  21 located in the F</usr/afs/bin> directory on a file server machine.
  22
  23 The B<volserver> command is not normally issued at the command shell
  24 prompt but rather placed into a file server machine's
  25 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
  26 ever issued at the command shell prompt, the issuer must be logged onto a
  27 database server machine as the local superuser C<root>.
  28
  29 The Volume Server records a trace of its activity in the
  30 F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
  31 the contents of the file.
  32
  33 The Volume Server processes the B<vos> commands that administrators use to
  34 create, delete, move, and replicate volumes, as well as prepare them for
  35 archiving to tape or other media.
  36
  37 By default, the VL Server runs nine lightweight processes (LWPs). To
  38 change the number, use the B<-p> argument.
  39
  40 This command does not use the syntax conventions of the AFS command
  41 suites. Provide the command name and all option names in full.
  42
  43 =head1 OPTIONS
  44
  45 =over 4
  46
  47 =item B<-log>
  48
  49 Records in the /usr/afs/logs/VolserLog file the names of all users who
  50 successfully initiate a B<vos> command. The Volume Server also records any
  51 file removals that result from issuing the B<vos release> command with the
  52 B<-f> flag.
  53
  54 =item B<-p> <I<number of processes>>
  55
  56 Sets the number of server lightweight processes (LWPs) to run.  Provide an
  57 integer between C<4> and C<16>. The default is C<9>.
  58
  59 =item B<-udpsize> <I<size of socket buffer>>
  60
  61 Sets the size of the UDP buffer in bytes, which is 64 KB by
  62 default. Provide a positive integer, preferably larger than the default.
  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 C<volserver> process on the
  90 machine C<fs2.abc.com>:
  91
  92    % bos create -server fs2.abc.com -instance volserver -type simple \
  93                  -cmd /usr/afs/bin/volserver
  94
  95 =head1 PRIVILEGE REQUIRED
  96
  97 The issuer must be logged in as the superuser C<root> on a file server
  98 machine to issue the command at a command shell prompt. It is conventional
  99 instead to create and start the process by issuing the B<bos create>
 100 command.
 101
 102 =head1 SEE ALSO
 103
 104 L<BosConfig(5)>,
 105 L<VolserLog(5)>,
 106 L<bos_create(8)>,
 107 L<bos_getlog(8)>,
 108 L<vos(1)>
 109
 110 =head1 COPYRIGHT
 111
 112 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 113
 114 This documentation is covered by the IBM Public License Version 1.0.  It was
 115 converted from HTML to POD by software written by Chas Williams and Russ
 116 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.