DEVEL15-man-pages-allow-dots-consistent-20090505
[openafs.git] / doc / man-pages / pod8 / bosserver.pod
1 =head1 NAME
2
3 bosserver - Initializes the BOS Server
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bosserver> [B<-noauth>] [B<-log>] [B<-enable_peer_stats>]
11     [B<-enable_process_stats>] [B<-allow-dotted-principals>] [B<-help>]
12
13 =for html
14 </div>
15
16 =head1 DESCRIPTION
17
18 The bosserver command initializes the Basic OverSeer (BOS) Server
19 (B<bosserver> process). In the conventional configuration, the binary file
20 is located in the F</usr/afs/bin> directory on a file server machine.
21
22 The BOS Server must run on every file server machine and helps to automate
23 file server administration by performing the following tasks:
24
25 =over 4
26
27 =item *
28
29 Monitors the other AFS server processes on the local machine, to make sure
30 they are running correctly.
31
32 =item *
33
34 Automatically restarts failed processes, without contacting a human
35 operator. When restarting multiple server processes simultaneously, the
36 BOS Server takes interdependencies into account and initiates restarts in
37 the correct order.
38
39 =item *
40
41 Processes commands from the bos suite that administrators issue to verify
42 the status of server processes, install and start new processes, stop
43 processes either temporarily or permanently, and restart halted processes.
44
45 =item *
46
47 Manages system configuration information: the files that list the cell's
48 server encryption keys, database server machines, and users privileged to
49 issue commands from the B<bos> and B<vos> suites.
50
51 =back
52
53 The BOS Server logs a default set of important events in the file
54 F</usr/afs/logs/BosLog>. To record the name of any user who performs a
55 privileged B<bos> command (one that requires being listed in the
56 F</usr/afs/etc/UserList> file), add the B<-log> flag. To display the
57 contents of the B<BosLog> file, use the B<bos getlog> command.
58
59 The first time that the BOS Server initializes on a server machine, it
60 creates several files and subdirectories in the local F</usr/afs>
61 directory, and sets their mode bits to protect them from unauthorized
62 access. Each time it restarts, it checks that the mode bits still comply
63 with the settings listed in the following chart. A question mark indicates
64 that the BOS Server initially turns off the bit (sets it to the hyphen),
65 but does not check it at restart.
66
67 If the mode bits do not comply, the BOS Server writes the following
68 warning to the F<BosLog> file:
69
70    Bosserver reports inappropriate access on server directories
71
72 However, the BOS Server does not reset the mode bits, so the administrator
73 can set them to alternate values if desired (with the understanding that
74 the warning message then appears at startup).
75
76 This command does not use the syntax conventions of the AFS command
77 suites. Provide the command name and all option names in full.
78
79 =head1 OPTIONS
80
81 =over 4
82
83 =item B<-noauth>
84
85 Assigns the unprivileged identity C<anonymous> to the issuer, which is
86 useful only when authorization checking is disabled on the server machine
87 (for instance, during the installation of a file server machine.)
88
89 =item B<-log>
90
91 Records in the F</usr/afs/logs/BosLog> file the names of all users who
92 successfully issue a privileged B<bos> command (one that requires being
93 listed in the F</usr/afs/etc/UserList> file).
94
95 =item B<-enable_peer_stats>
96
97 Activates the collection of Rx statistics and allocates memory for their
98 storage. For each connection with a specific UDP port on another machine,
99 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
100 so on) sent or received. To display or otherwise access the records, use
101 the Rx Monitoring API.
102
103 =item B<-enable_process_stats>
104
105 Activates the collection of Rx statistics and allocates memory for their
106 storage. A separate record is kept for each type of RPC (FetchFile,
107 GetStatus, and so on) sent or received, aggregated over all connections to
108 other machines. To display or otherwise access the records, use the Rx
109 Monitoring API.
110
111 =item B<-allow-dotted-principals>
112
113 By default, the RXKAD security layer will disallow access by Kerberos
114 principals with a dot in the first component of their name. This is to avoid
115 the confusion where principals user/admin and user.admin are both mapped to the
116 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
117 between principal names may disable this check by starting the server
118 with this option.
119
120 =item B<-help>
121
122 Prints the online help for this command. All other valid options are
123 ignored.
124
125 =back
126
127 =head1 EXAMPLES
128
129 The following command initializes the BOS Server and logs the names of
130 users who issue privileged B<bos> commands.
131
132    % bosserver -log &
133
134 =head1 PRIVILEGE REQUIRED
135
136 The issuer most be logged onto a file server machine as the local
137 superuser C<root>.
138
139 =head1 SEE ALSO
140
141 L<BosConfig(5)>,
142 L<BosLog(5)>,
143 L<bos(8)>,
144 L<bos_create(8)>,
145 L<bos_exec(8)>,
146 L<bos_getlog(8)>,
147 L<bos_getrestart(8)>,
148 L<bos_restart(8)>,
149 L<bos_shutdown(8)>,
150 L<bos_start(8)>,
151 L<bos_startup(8)>,
152 L<bos_status(8)>,
153 L<bos_stop(8)>
154
155 =head1 COPYRIGHT
156
157 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
158
159 This documentation is covered by the IBM Public License Version 1.0.  It was
160 converted from HTML to POD by software written by Chas Williams and Russ
161 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.