doc/man-pages/pod8/ptserver.pod

   1 =head1 NAME
   2
   3 ptserver - Initializes the Protection Server
   4
   5 =head1 SYNOPSIS
   6
   7 B<ptserver> [B<-database> <I<db path>>]  [B<-p> <I<number of processes>>] [-rebuildDB]
   8 [B<-enable_peer_stats>]  [B<-enable_process_stats>]  [B<-help>]
   9
  10 This command does not use the syntax conventions of the AFS command
  11 suites. Provide the command name and all option names in full.
  12
  13 =head1 DESCRIPTION
  14
  15 The ptserver command initializes the Protection Server, which
  16 must run on every database server machine. In the conventional
  17 configuration, its binary file is located in the B</usr/afs/bin>
  18 directory on a file server machine.
  19
  20 The ptserver command is not normally issued at the command shell
  21 prompt, but rather placed into a database server machine's
  22 B</usr/afs/local/BosConfig> file with the B<bos create>
  23 command. If it is ever issued at the command shell prompt, the issuer
  24 must be logged onto a file server machine as the local superuser
  25 B<root>.
  26
  27 The Protection Server performs the following tasks:
  28
  29 =over 4
  30
  31 =item *
  32
  33 Maintains the Protection Database, which contains entries for every user
  34 and group in the cell. Use the B<pts> commands to administer
  35 the database.
  36
  37
  38 =item *
  39
  40 Allocates AFS IDs for new user, machine and group entries and maps each ID
  41 to the corresponding name.
  42
  43
  44 =item *
  45
  46 Generates a current protection subgroup (CPS) at the File Server's
  47 request. The CPS lists all groups to which a user or machine
  48 belongs.
  49
  50
  51 =back
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item -database
  58
  59 Specifies the pathname of an alternate directory in which the Protection
  60 Database files reside. Provide the complete pathname, ending in the
  61 base filename to which the B<.DB0> and
  62 B<.DBSYS1> extensions are appended. For example, the
  63 appropriate value for the default database files is
  64 B</usr/afs/db/prdb>.
  65
  66 =item -p
  67
  68 Sets the number of server lightweight processes (LWPs) to run.
  69 Provide a positive integer from the range B<3> to
  70 B<16>. The default value is 3.
  71
  72 =item -rebuildDB
  73
  74 Rebuilds the Protection Database at the beginning of Protection Server
  75 initialization. Use this argument only in consultation with AFS
  76 Development or Product Support.
  77
  78 =item -enable_peer_stats
  79
  80 Activates the collection of Rx statistics and allocates memory for their
  81 storage. For each connection with a specific UDP port on another
  82 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
  83 and so on) sent or received. To display or otherwise access the
  84 records, use the Rx Monitoring API.
  85
  86 =item -enable_process_stats
  87
  88 Activates the collection of Rx statistics and allocates memory for their
  89 storage. A separate record is kept for each type of RPC (FetchFile,
  90 GetStatus, and so on) sent or received, aggregated over all connections to
  91 other machines. To display or otherwise access the records, use the Rx
  92 Monitoring API.
  93
  94 =item -help
  95
  96 Prints the online help for this command. All other valid options
  97 are ignored.
  98
  99 =back
 100
 101 =head1 EXAMPLES
 102
 103 The following B<bos create> command creates a ptserver
 104 process on the machine B<fs3.abc.com>. The
 105 command appears here on multiple lines only for legibility.
 106
 107    % bos create -server fs3.abc.com -instance ptserver  \
 108                 -type simple -cmd /usr/afs/bin/ptserver
 109
 110 =head1 PRIVILEGE REQUIRED
 111
 112 The issuer must be logged in as the superuser root on a file
 113 server machine to issue the command at a command shell prompt. It is
 114 conventional instead to create and start the process by issuing the B<bos
 115 create> command.
 116
 117 =head1 SEE ALSO
 118
 119 L<BosConfig(1)>,
 120 L<prdb.DB0 and prdb.DBSYS1(1)>
 121
 122 L<bos_create(1)>,
 123 L<bos_getlog(1)>,
 124 L<pts(1)>
 125
 126 =head1 COPYRIGHT
 127
 128 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 129
 130 This documentation is covered by the IBM Public License Version 1.0.  It was
 131 converted from HTML to POD by software written by Chas Williams and Russ
 132 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.