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 B<volserver> [B<-log>]  [-p <I<number of processes>>]
   8 [B<-udpsize> <I<size of socket buffer in bytes>>]
   9           [B<-enable_peer_stats>]  [B<-enable_process_stats>]  [-help]
  10
  11 This command does not use the syntax conventions of the AFS command
  12 suites. Provide the command name and all option names in full.
  13
  14 =head1 DESCRIPTION
  15
  16 The volserver command initializes the Volume Server component of
  17 the B<fs> process. In the conventional configuration, its
  18 binary file is located in the B</usr/afs/bin> directory on a file
  19 server machine.
  20
  21 The volserver command is not normally issued at the command
  22 shell prompt but rather placed into a file server machine's
  23 B</usr/afs/local/BosConfig> file with the B<bos create>
  24 command. If it is ever issued at the command shell prompt, the issuer
  25 must be logged onto a database server machine as the local superuser
  26 B<root>.
  27
  28 The Volume Server records a trace of its activity in the
  29 B</usr/afs/logs/VolserLog> file. Use the B<bos getlog>
  30 command to display the contents of the file.
  31
  32 The Volume Server processes the vos commands that administrators
  33 use to create, delete, move, and replicate volumes, as well as prepare them
  34 for archiving to tape or other media.
  35
  36 By default, the VL Server runs nine lightweight processes (LWPs). To
  37 change the number, use the B<-p> argument.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item -log
  44
  45 Records in the /usr/afs/logs/VolserLog file the names of all
  46 users who successfully initiate a B<vos> command. The Volume
  47 Server also records any file removals that result from issuing the B<vos
  48 release> command with the B<-f> flag.
  49
  50 =item -p
  51
  52 Sets the number of server lightweight processes (LWPs) to run.
  53 Provide an integer between B<4> and B<16>. The default
  54 is 9.
  55
  56 =item -udpsize
  57
  58 Sets the size of the UDP buffer, which is 64 KB by default. Provide
  59 a positive integer, preferably larger than the default.
  60
  61 =item -enable_peer_stats
  62
  63 Activates the collection of Rx statistics and allocates memory for their
  64 storage. For each connection with a specific UDP port on another
  65 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
  66 and so on) sent or received. To display or otherwise access the
  67 records, use the Rx Monitoring API.
  68
  69 =item -enable_process_stats
  70
  71 Activates the collection of Rx statistics and allocates memory for their
  72 storage. A separate record is kept for each type of RPC (FetchFile,
  73 GetStatus, and so on) sent or received, aggregated over all connections to
  74 other machines. To display or otherwise access the records, use the Rx
  75 Monitoring API.
  76
  77 =item -help
  78
  79 Prints the online help for this command. All other valid options
  80 are ignored.
  81
  82 =back
  83
  84 =head1 EXAMPLES
  85
  86 The following B<bos create> command creates a volserver
  87 process on the machine B<fs2.abc.com>:
  88
  89    % bos create -server fs2.abc.com -instance volserver -type simple   \
  90                  -cmd /usr/afs/bin/volserver
  91
  92 =head1 PRIVILEGE REQUIRED
  93
  94 The issuer must be logged in as the superuser root on a file
  95 server machine to issue the command at a command shell prompt. It is
  96 conventional instead to create and start the process by issuing the B<bos
  97 create> command.
  98
  99 =head1 SEE ALSO
 100
 101 L<BosConfig(1)>,
 102 L<VolserLog(1)>,
 103 L<bos_create(1)>,
 104 L<bos_getlog(1)>,
 105 L<vos(1)>
 106
 107 =head1 COPYRIGHT
 108
 109 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 110
 111 This documentation is covered by the IBM Public License Version 1.0.  It was
 112 converted from HTML to POD by software written by Chas Williams and Russ
 113 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.