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