doc/man-pages/pod8/ptserver.pod

   1 =head1 NAME
   2
   3 ptserver - Initializes the Protection Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<ptserver> S<<< [B<-database> <I<db path>>] >>> S<<< [B<-p> <I<number of threads>>] >>>
  11     [B<-rebuildDB>] [B<-enable_peer_stats>] [B<-enable_process_stats>]
  12     [B<-allow-dotted-principal>] [B<-rxbind>] [B<-help>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<ptserver> command initializes the Protection Server, which must run
  20 on every database server machine. In the conventional configuration, its
  21 binary file is located in the F</usr/afs/bin> directory on a file server
  22 machine.
  23
  24 The ptserver command is not normally issued at the command shell prompt,
  25 but rather placed into a database server machine's
  26 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
  27 ever issued at the command shell prompt, the issuer must be logged onto a
  28 file server machine as the local superuser C<root>.
  29
  30 The Protection Server performs the following tasks:
  31
  32 =over 4
  33
  34 =item *
  35
  36 Maintains the Protection Database, which contains entries for every user
  37 and group in the cell. Use the B<pts> commands to administer the database.
  38
  39 =item *
  40
  41 Allocates AFS IDs for new user, machine and group entries and maps each ID
  42 to the corresponding name.
  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 belongs.
  48
  49 =back
  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<-database> <I<db path>>
  59
  60 Specifies the pathname of an alternate directory in which the Protection
  61 Database files reside. Provide the complete pathname, ending in the base
  62 filename to which the C<.DB0> and C<.DBSYS1> extensions are appended. For
  63 example, the appropriate value for the default database files is
  64 F</usr/afs/db/prdb>.
  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 a positive integer from the range C<3> to C<16>. The default
  70 value is C<3>.
  71
  72 =item B<-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 B<-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 machine,
  82 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
  83 so on) sent or received. To display or otherwise access the records, use
  84 the Rx Monitoring API.
  85
  86 =item B<-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 B<-allow-dotted-principal>
  95
  96 By default, the RXKAD security layer will disallow access by Kerberos
  97 principals with a dot in the first component of their name. This is to avoid
  98 the confusion where principals user/admin and user.admin are both mapped to the
  99 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions
 100 between principal names may disable this check by starting the server
 101 with this option.
 102
 103 =item B<-rxbind>
 104
 105 Bind the Rx socket to the primary interface only.  (If not specified, the
 106 Rx socket will listen on all interfaces.)
 107
 108 =item B<-help>
 109
 110 Prints the online help for this command. All other valid options are
 111 ignored.
 112
 113 =back
 114
 115 =head1 EXAMPLES
 116
 117 The following B<bos create> command creates a C<ptserver> process on the
 118 machine C<fs3.abc.com>. The command appears here on multiple lines only
 119 for legibility.
 120
 121    % bos create -server fs3.abc.com -instance ptserver \
 122                 -type simple -cmd /usr/afs/bin/ptserver
 123
 124 =head1 PRIVILEGE REQUIRED
 125
 126 The issuer must be logged in as the superuser C<root> on a file server
 127 machine to issue the command at a command shell prompt. It is conventional
 128 instead to create and start the process by issuing the B<bos create>
 129 command.
 130
 131 =head1 SEE ALSO
 132
 133 L<BosConfig(5)>,
 134 L<prdb.DB0(5)>,
 135 L<bos_create(8)>,
 136 L<bos_getlog(8)>,
 137 L<pts(1)>
 138
 139 =head1 COPYRIGHT
 140
 141 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 142
 143 This documentation is covered by the IBM Public License Version 1.0.  It was
 144 converted from HTML to POD by software written by Chas Williams and Russ
 145 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.