Remove NoAuth procedures from Admin Guide
[openafs.git] / doc / xml / AdminGuide / auagd008.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter id="HDRWQ80">
3   <title>Administering Server Machines</title>
4
5   <para>
6   <indexterm>
7     <primary>server machine</primary>
8
9     <secondary>administering</secondary>
10   </indexterm>
11
12   <indexterm>
13     <primary>administering</primary>
14
15     <secondary>server machine</secondary>
16   </indexterm>
17
18   This chapter describes how to administer an AFS server machine. It describes the following configuration information and
19   administrative tasks: <itemizedlist>
20       <listitem>
21         <para>The binary and configuration files that must reside in the subdirectories of the <emphasis
22         role="bold">/usr/afs</emphasis> directory on every server machine's local disk; see <link linkend="HDRWQ83">Local Disk Files
23         on a Server Machine</link>.</para>
24       </listitem>
25
26       <listitem>
27         <para>The various <emphasis>roles</emphasis> or functions that an AFS server machine can perform, and how to determine which
28         machines are taking a role; see <link linkend="HDRWQ90">The Four Roles for File Server Machines</link>.</para>
29       </listitem>
30
31       <listitem>
32         <para>How to maintain database server machines; see <link linkend="HDRWQ101">Administering Database Server
33         Machines</link>.</para>
34       </listitem>
35
36       <listitem>
37         <para>How to maintain the list of database server machines in the <emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>
38         file; see <link linkend="HDRWQ118">Maintaining the Server CellServDB File</link>.</para>
39       </listitem>
40
41       <listitem>
42         <para>How to control authorization checking on a server machine; see <link linkend="HDRWQ123">Managing Authentication and
43         Authorization Requirements</link>.</para>
44       </listitem>
45
46       <listitem>
47         <para>How to install new disks or partitions on a file server machine; see <link linkend="HDRWQ130">Adding or Removing Disks
48         and Partitions</link>.</para>
49       </listitem>
50
51       <listitem>
52         <para>How to change a server machine's IP addresses and manager VLDB server entries; see <link linkend="HDRWQ138">Managing
53         Server IP Addresses and VLDB Server Entries</link>.</para>
54       </listitem>
55
56       <listitem>
57         <para>How to reboot a file server machine; see <link linkend="HDRWQ139">Rebooting a Server Machine</link>.</para>
58       </listitem>
59     </itemizedlist></para>
60
61   <para>To learn how to install and configure a new server machine, see the <emphasis>OpenAFS Quick Beginnings</emphasis>.</para>
62
63   <para>To learn how to administer the server processes themselves, see <link linkend="HDRWQ142">Monitoring and Controlling Server
64   Processes</link>.</para>
65
66   <para>To learn how to administer volumes, see <link linkend="HDRWQ174">Managing Volumes</link>.</para>
67
68   <sect1 id="HDRWQ81">
69     <title>Summary of Instructions</title>
70
71     <para>This chapter explains how to perform the following tasks by using the indicated commands:</para>
72
73     <informaltable frame="none">
74       <tgroup cols="2">
75         <colspec colwidth="70*" />
76
77         <colspec colwidth="30*" />
78
79         <tbody>
80           <row>
81             <entry>Install new binaries</entry>
82
83             <entry><emphasis role="bold">bos install</emphasis></entry>
84           </row>
85
86           <row>
87             <entry>Examine binary check-and-restart time</entry>
88
89             <entry><emphasis role="bold">bos getrestart</emphasis></entry>
90           </row>
91
92           <row>
93             <entry>Set binary check-and-restart time</entry>
94
95             <entry><emphasis role="bold">bos setrestart</emphasis></entry>
96           </row>
97
98           <row>
99             <entry>Examine compilation dates on binary files</entry>
100
101             <entry><emphasis role="bold">bos getdate</emphasis></entry>
102           </row>
103
104           <row>
105             <entry>Restart a process to use new binaries</entry>
106
107             <entry><emphasis role="bold">bos restart</emphasis></entry>
108           </row>
109
110           <row>
111             <entry>Revert to old version of binaries</entry>
112
113             <entry><emphasis role="bold">bos uninstall</emphasis></entry>
114           </row>
115
116           <row>
117             <entry>Remove obsolete <emphasis role="bold">.BAK</emphasis> and <emphasis role="bold">.OLD</emphasis> versions</entry>
118
119             <entry><emphasis role="bold">bos prune</emphasis></entry>
120           </row>
121
122           <row>
123             <entry>List partitions on a file server machine</entry>
124
125             <entry><emphasis role="bold">vos listpart</emphasis></entry>
126           </row>
127
128           <row>
129             <entry>Shutdown AFS server processes</entry>
130
131             <entry><emphasis role="bold">bos shutdown</emphasis></entry>
132           </row>
133
134           <row>
135             <entry>List volumes on a partition</entry>
136
137             <entry><emphasis role="bold">vos listvldb</emphasis></entry>
138           </row>
139
140           <row>
141             <entry>Move read/write volumes</entry>
142
143             <entry><emphasis role="bold">vos move</emphasis></entry>
144           </row>
145
146           <row>
147             <entry>List a cell's database server machines</entry>
148
149             <entry><emphasis role="bold">bos listhosts</emphasis></entry>
150           </row>
151
152           <row>
153             <entry>Add a database server machine to server <emphasis role="bold">CellServDB</emphasis> file</entry>
154
155             <entry><emphasis role="bold">bos addhost</emphasis></entry>
156           </row>
157
158           <row>
159             <entry>Remove a database server machine from server <emphasis role="bold">CellServDB</emphasis> file</entry>
160
161             <entry><emphasis role="bold">bos removehost</emphasis></entry>
162           </row>
163
164           <row>
165             <entry>Set authorization checking requirements</entry>
166
167             <entry><emphasis role="bold">bos setauth</emphasis></entry>
168           </row>
169
170           <row>
171             <entry>Prevent authentication for <emphasis role="bold">bos</emphasis>, <emphasis role="bold">pts</emphasis>, and
172             <emphasis role="bold">vos</emphasis> commands</entry>
173
174             <entry>Include <emphasis role="bold">-noauth</emphasis> flag</entry>
175           </row>
176
177           <row>
178             <entry>Prevent authentication for kas commands</entry>
179
180             <entry>Include <emphasis role="bold">-noauth</emphasis> flag on some commands or issue <emphasis
181             role="bold">noauthentication</emphasis> while in interactive mode</entry>
182           </row>
183
184           <row>
185             <entry>Display all VLDB server entries</entry>
186
187             <entry><emphasis role="bold">vos listaddrs</emphasis></entry>
188           </row>
189
190           <row>
191             <entry>Remove a VLDB server entry</entry>
192
193             <entry><emphasis role="bold">vos changeaddr</emphasis></entry>
194           </row>
195
196           <row>
197             <entry>Reboot a server machine remotely</entry>
198
199             <entry><emphasis role="bold">bos exec</emphasis> <emphasis>reboot_command</emphasis></entry>
200           </row>
201         </tbody>
202       </tgroup>
203     </informaltable>
204   </sect1>
205
206   <sect1 id="HDRWQ83">
207     <title>Local Disk Files on a Server Machine</title>
208
209     <para>Several types of files must reside in the subdirectories of the <emphasis role="bold">/usr/afs</emphasis> directory on an
210     AFS server machine's local disk. They include binaries, configuration files, the administrative database files (on database
211     server machines), log files, and volume header files.</para>
212
213     <para><emphasis role="bold">Note for Windows users:</emphasis> Some files described in this document possibly do not exist on
214     machines that run a Windows operating system. Also, Windows uses a backslash (<emphasis role="bold">\</emphasis>) rather than a
215     forward slash (<emphasis role="bold">/</emphasis>) to separate the elements in a pathname.</para>
216
217     <indexterm>
218       <primary>usr/afs/bin directory on server machines</primary>
219
220       <secondary>contents listed</secondary>
221     </indexterm>
222
223     <indexterm>
224       <primary>directory</primary>
225
226       <secondary>/usr/afs/bin on server machines</secondary>
227     </indexterm>
228
229     <indexterm>
230       <primary>server process binaries</primary>
231
232       <secondary>in /usr/afs/bin</secondary>
233     </indexterm>
234
235     <sect2 id="HDRWQ84">
236       <title>Binaries in the /usr/afs/bin Directory</title>
237
238       <para>The <emphasis role="bold">/usr/afs/bin</emphasis> directory stores the AFS server process and command suite binaries
239       appropriate for the machine's system (CPU and operating system) type. If a process has both a server portion and a client
240       portion (as with the Update Server) or if it has separate components (as with the <emphasis role="bold">fs</emphasis>
241       process), each component resides in a separate file.</para>
242
243       <para>To ensure predictable system performance, all file server machines must run the same AFS build version of a given
244       process. To maintain consistency easily, use the Update Server process to distribute binaries from a binary distribution
245       machine of each system type, as described further in <link linkend="HDRWQ93">Binary Distribution Machines</link>.</para>
246
247       <para>It is best to keep the binaries for all processes in the <emphasis role="bold">/usr/afs/bin</emphasis> directory, even
248       if you do not run the process actively on the machine. It simplifies the process of reconfiguring machines (for example,
249       adding database server functionality to an existing file server machine). Similarly, it is best to keep the command suite
250       binaries in the directory, even if you do not often issue commands while working on the server machine. It enables you to
251       issue commands during recovery from server and machine outages.</para>
252
253       <para>The following lists the binary files in the <emphasis role="bold">/usr/afs/bin</emphasis> directory that are directly
254       related to the AFS server processes or command suites. Other binaries (for example, for the <emphasis
255       role="bold">klog</emphasis> command) sometimes appear in this directory on a particular file server machine's disk or in an
256       AFS distribution. <variablelist>
257           <indexterm>
258             <primary>files</primary>
259
260             <secondary>backup command binary</secondary>
261           </indexterm>
262
263           <indexterm>
264             <primary>backup commands</primary>
265
266             <secondary>binary in /usr/afs/bin</secondary>
267           </indexterm>
268
269           <varlistentry>
270             <term><emphasis role="bold">backup</emphasis></term>
271
272             <listitem>
273               <para>The command suite for the AFS Backup System (the binary for the Backup Server is <emphasis
274               role="bold">buserver</emphasis>).</para>
275
276               <indexterm>
277                 <primary>files</primary>
278
279                 <secondary>bos command binary</secondary>
280               </indexterm>
281
282               <indexterm>
283                 <primary>bos commands</primary>
284
285                 <secondary>binary in /usr/afs/bin</secondary>
286               </indexterm>
287             </listitem>
288           </varlistentry>
289
290           <varlistentry>
291             <term><emphasis role="bold">bos</emphasis></term>
292
293             <listitem>
294               <para>The command suite for communicating with the Basic OverSeer (BOS) Server (the binary for the BOS Server is
295               <emphasis role="bold">bosserver</emphasis>).</para>
296
297               <indexterm>
298                 <primary>bosserver</primary>
299
300                 <secondary>binary in /usr/afs/bin</secondary>
301               </indexterm>
302
303               <indexterm>
304                 <primary>bosserver</primary>
305
306                 <secondary></secondary>
307
308                 <see>BOS Server</see>
309               </indexterm>
310
311               <indexterm>
312                 <primary>files</primary>
313
314                 <secondary>bosserver binary</secondary>
315               </indexterm>
316
317               <indexterm>
318                 <primary>programs</primary>
319
320                 <secondary>bosserver</secondary>
321               </indexterm>
322
323               <indexterm>
324                 <primary>processes</primary>
325
326                 <secondary>BOS Server, binary in /usr/afs/bin</secondary>
327               </indexterm>
328
329               <indexterm>
330                 <primary>BOS Server</primary>
331
332                 <secondary>binary in /usr/afs/bin</secondary>
333               </indexterm>
334             </listitem>
335           </varlistentry>
336
337           <varlistentry>
338             <term><emphasis role="bold">bosserver</emphasis></term>
339
340             <listitem>
341               <para>The binary for the Basic OverSeer (BOS) Server process.</para>
342
343               <indexterm>
344                 <primary>buserver</primary>
345
346                 <secondary>binary in /usr/afs/bin</secondary>
347               </indexterm>
348
349               <indexterm>
350                 <primary>buserver</primary>
351
352                 <secondary></secondary>
353
354                 <see>Backup Server</see>
355               </indexterm>
356
357               <indexterm>
358                 <primary>files</primary>
359
360                 <secondary>buserver</secondary>
361               </indexterm>
362
363               <indexterm>
364                 <primary>programs</primary>
365
366                 <secondary>buserver</secondary>
367               </indexterm>
368
369               <indexterm>
370                 <primary>processes</primary>
371
372                 <secondary>Backup Server, binary in /usr/afs/bin</secondary>
373               </indexterm>
374
375               <indexterm>
376                 <primary>Backup Server</primary>
377
378                 <secondary>binary in /usr/afs/bin</secondary>
379               </indexterm>
380             </listitem>
381           </varlistentry>
382
383           <varlistentry>
384             <term><emphasis role="bold">buserver</emphasis></term>
385
386             <listitem>
387               <para>The binary for the Backup Server process.</para>
388
389               <indexterm>
390                 <primary>fileserver</primary>
391
392                 <secondary>binary in /usr/afs/bin</secondary>
393               </indexterm>
394
395               <indexterm>
396                 <primary>fileserver</primary>
397
398                 <secondary></secondary>
399
400                 <see>File Server</see>
401               </indexterm>
402
403               <indexterm>
404                 <primary>files</primary>
405
406                 <secondary>fileserver</secondary>
407               </indexterm>
408
409               <indexterm>
410                 <primary>programs</primary>
411
412                 <secondary>fileserver</secondary>
413               </indexterm>
414
415               <indexterm>
416                 <primary>processes</primary>
417
418                 <secondary>File Server, binary in /usr/afs/bin</secondary>
419               </indexterm>
420
421               <indexterm>
422                 <primary>File Server</primary>
423
424                 <secondary>binary in /usr/afs/bin</secondary>
425               </indexterm>
426             </listitem>
427           </varlistentry>
428
429           <varlistentry>
430             <term><emphasis role="bold">fileserver</emphasis></term>
431
432             <listitem>
433               <para>The binary for the File Server component of the <emphasis role="bold">fs</emphasis> process.</para>
434
435               <indexterm>
436                 <primary>files</primary>
437
438                 <secondary>kas command binary</secondary>
439               </indexterm>
440
441               <indexterm>
442                 <primary>kas commands</primary>
443
444                 <secondary>binary in /usr/afs/bin</secondary>
445               </indexterm>
446             </listitem>
447           </varlistentry>
448
449           <varlistentry>
450             <term><emphasis role="bold">kas</emphasis></term>
451
452             <listitem>
453               <para>The command suite for communicating with the Authentication Server (the binary for the Authentication Server is
454               <emphasis role="bold">kaserver</emphasis>).</para>
455
456               <indexterm>
457                 <primary>kaserver process</primary>
458
459                 <secondary>binary in /usr/afs/bin</secondary>
460               </indexterm>
461
462               <indexterm>
463                 <primary>kaserver process</primary>
464
465                 <secondary></secondary>
466
467                 <see>Authentication Server</see>
468               </indexterm>
469
470               <indexterm>
471                 <primary>files</primary>
472
473                 <secondary>kaserver binary file</secondary>
474               </indexterm>
475
476               <indexterm>
477                 <primary>programs</primary>
478
479                 <secondary>kaserver</secondary>
480               </indexterm>
481
482               <indexterm>
483                 <primary>processes</primary>
484
485                 <secondary>Authentication Server, binary in /usr/afs/bin</secondary>
486               </indexterm>
487
488               <indexterm>
489                 <primary>Authentication Server</primary>
490
491                 <secondary>binary in /usr/afs/bin</secondary>
492               </indexterm>
493             </listitem>
494           </varlistentry>
495
496           <varlistentry>
497             <term><emphasis role="bold">kaserver</emphasis></term>
498
499             <listitem>
500               <para>The binary for the Authentication Server process.</para>
501
502               <indexterm>
503                 <primary>files</primary>
504
505                 <secondary>pts command binary</secondary>
506               </indexterm>
507
508               <indexterm>
509                 <primary>pts commands</primary>
510
511                 <secondary>binary in /usr/afs/bin</secondary>
512               </indexterm>
513             </listitem>
514           </varlistentry>
515
516           <varlistentry>
517             <term><emphasis role="bold">pts</emphasis></term>
518
519             <listitem>
520               <para>The command suite for communicating with the Protection Server process (the binary for the Protection Server is
521               <emphasis role="bold">ptserver</emphasis>).</para>
522
523               <indexterm>
524                 <primary>ptserver process</primary>
525
526                 <secondary>binary in /usr/afs/bin</secondary>
527               </indexterm>
528
529               <indexterm>
530                 <primary>ptserver process</primary>
531
532                 <secondary></secondary>
533
534                 <see>Protection Server</see>
535               </indexterm>
536
537               <indexterm>
538                 <primary>files</primary>
539
540                 <secondary>ptserver binary</secondary>
541               </indexterm>
542
543               <indexterm>
544                 <primary>programs</primary>
545
546                 <secondary>ptserver</secondary>
547               </indexterm>
548
549               <indexterm>
550                 <primary>processes</primary>
551
552                 <secondary>Protection Server, binary in /usr/afs/bin</secondary>
553               </indexterm>
554
555               <indexterm>
556                 <primary>Protection Server</primary>
557
558                 <secondary>binary in /usr/afs/bin</secondary>
559               </indexterm>
560             </listitem>
561           </varlistentry>
562
563           <varlistentry>
564             <term><emphasis role="bold">ptserver</emphasis></term>
565
566             <listitem>
567               <para>The binary for the Protection Server process.</para>
568
569               <indexterm>
570                 <primary>Salvager</primary>
571
572                 <secondary>binary in /usr/afs/bin</secondary>
573               </indexterm>
574
575               <indexterm>
576                 <primary>Salvager</primary>
577
578                 <secondary></secondary>
579
580                 <see>Salvager</see>
581               </indexterm>
582
583               <indexterm>
584                 <primary>files</primary>
585
586                 <secondary>salvager</secondary>
587               </indexterm>
588
589               <indexterm>
590                 <primary>programs</primary>
591
592                 <secondary>salvager</secondary>
593               </indexterm>
594
595               <indexterm>
596                 <primary>processes</primary>
597
598                 <secondary>Salvager, binary in /usr/afs/bin</secondary>
599               </indexterm>
600             </listitem>
601           </varlistentry>
602
603           <varlistentry>
604             <term><emphasis role="bold">salvager</emphasis></term>
605
606             <listitem>
607               <para>The binary for the Salvager component of the <emphasis role="bold">fs</emphasis> process.</para>
608
609               <indexterm>
610                 <primary>udebug</primary>
611
612                 <secondary>binary in /usr/afs/bin</secondary>
613               </indexterm>
614
615               <indexterm>
616                 <primary>files</primary>
617
618                 <secondary>udebug</secondary>
619               </indexterm>
620
621               <indexterm>
622                 <primary>commands</primary>
623
624                 <secondary>udebug</secondary>
625               </indexterm>
626
627               <indexterm>
628                 <primary>programs</primary>
629
630                 <secondary>udebug</secondary>
631               </indexterm>
632             </listitem>
633           </varlistentry>
634
635           <varlistentry>
636             <term><emphasis role="bold">udebug</emphasis></term>
637
638             <listitem>
639               <para>The binary for a program that reports the status of AFS's distributed database technology, Ubik.</para>
640
641               <indexterm>
642                 <primary>upclient</primary>
643
644                 <secondary>binary in /usr/afs/bin</secondary>
645               </indexterm>
646
647               <indexterm>
648                 <primary>upclient</primary>
649
650                 <secondary></secondary>
651
652                 <see>Update Server</see>
653               </indexterm>
654
655               <indexterm>
656                 <primary>files</primary>
657
658                 <secondary>upclient</secondary>
659               </indexterm>
660
661               <indexterm>
662                 <primary>programs</primary>
663
664                 <secondary>upclient</secondary>
665               </indexterm>
666
667               <indexterm>
668                 <primary>processes</primary>
669
670                 <secondary>Update Server, binaries in /usr/afs/bin</secondary>
671               </indexterm>
672
673               <indexterm>
674                 <primary>Update Server</primary>
675
676                 <secondary>binaries in /usr/afs/bin</secondary>
677               </indexterm>
678             </listitem>
679           </varlistentry>
680
681           <varlistentry>
682             <term><emphasis role="bold">upclient</emphasis></term>
683
684             <listitem>
685               <para>The binary for the client portion of the Update Server process.</para>
686
687               <indexterm>
688                 <primary>upserver</primary>
689
690                 <secondary>binary in /usr/afs/bin</secondary>
691               </indexterm>
692
693               <indexterm>
694                 <primary>upserver</primary>
695
696                 <secondary></secondary>
697
698                 <see>Update Server</see>
699               </indexterm>
700
701               <indexterm>
702                 <primary>files</primary>
703
704                 <secondary>upserver</secondary>
705               </indexterm>
706
707               <indexterm>
708                 <primary>programs</primary>
709
710                 <secondary>upserver</secondary>
711               </indexterm>
712             </listitem>
713           </varlistentry>
714
715           <varlistentry>
716             <term><emphasis role="bold">upserver</emphasis></term>
717
718             <listitem>
719               <para>The binary for the server portion of the Update Server process.</para>
720
721               <indexterm>
722                 <primary>vlserver</primary>
723
724                 <secondary>binary in /usr/afs/bin</secondary>
725               </indexterm>
726
727               <indexterm>
728                 <primary>vlserver</primary>
729
730                 <secondary></secondary>
731
732                 <see>VL Server</see>
733               </indexterm>
734
735               <indexterm>
736                 <primary>files</primary>
737
738                 <secondary>vlserver</secondary>
739               </indexterm>
740
741               <indexterm>
742                 <primary>programs</primary>
743
744                 <secondary>vlserver</secondary>
745               </indexterm>
746
747               <indexterm>
748                 <primary>processes</primary>
749
750                 <secondary>VL Server, binary in /usr/afs/bin</secondary>
751               </indexterm>
752
753               <indexterm>
754                 <primary>VL Server</primary>
755
756                 <secondary>binary in /usr/afs/bin</secondary>
757               </indexterm>
758
759               <indexterm>
760                 <primary>Volume Location Server</primary>
761
762                 <secondary></secondary>
763
764                 <see>VL Server</see>
765               </indexterm>
766             </listitem>
767           </varlistentry>
768
769           <varlistentry>
770             <term><emphasis role="bold">vlserver</emphasis></term>
771
772             <listitem>
773               <para>The binary for the Volume Location (VL) Server process.</para>
774
775               <indexterm>
776                 <primary>volserver</primary>
777
778                 <secondary>binary in /usr/afs/bin</secondary>
779               </indexterm>
780
781               <indexterm>
782                 <primary>volserver</primary>
783
784                 <secondary></secondary>
785
786                 <see>Volume Server</see>
787               </indexterm>
788
789               <indexterm>
790                 <primary>files</primary>
791
792                 <secondary>volserver</secondary>
793               </indexterm>
794
795               <indexterm>
796                 <primary>programs</primary>
797
798                 <secondary>volserver</secondary>
799               </indexterm>
800
801               <indexterm>
802                 <primary>processes</primary>
803
804                 <secondary>Volume Server, binary in /usr/afs/bin</secondary>
805               </indexterm>
806
807               <indexterm>
808                 <primary>Volume Server</primary>
809
810                 <secondary>binary in /usr/afs/bin</secondary>
811               </indexterm>
812             </listitem>
813           </varlistentry>
814
815           <varlistentry>
816             <term><emphasis role="bold">volserver</emphasis></term>
817
818             <listitem>
819               <para>The binary for the Volume Server component of the <emphasis role="bold">fs</emphasis> process.</para>
820
821               <indexterm>
822                 <primary>files</primary>
823
824                 <secondary>vos command binary</secondary>
825               </indexterm>
826
827               <indexterm>
828                 <primary>vos commands</primary>
829
830                 <secondary>binary in /usr/afs/bin</secondary>
831               </indexterm>
832             </listitem>
833           </varlistentry>
834
835           <varlistentry>
836             <term><emphasis role="bold">vos</emphasis></term>
837
838             <listitem>
839               <para>The command suite for communicating with the Volume and VL Server processes (the binaries for the servers are
840               <emphasis role="bold">volserver</emphasis> and <emphasis role="bold">vlserver</emphasis>, respectively).</para>
841             </listitem>
842           </varlistentry>
843         </variablelist></para>
844
845       <indexterm>
846         <primary>usr/afs/etc directory on server machines</primary>
847
848         <secondary>contents listed</secondary>
849       </indexterm>
850
851       <indexterm>
852         <primary>directory</primary>
853
854         <secondary>/usr/afs/etc</secondary>
855       </indexterm>
856
857       <indexterm>
858         <primary>files</primary>
859
860         <secondary>server configuration, in /usr/afs/etc directory</secondary>
861       </indexterm>
862
863       <indexterm>
864         <primary>common configuration files (server)</primary>
865       </indexterm>
866
867       <indexterm>
868         <primary>server machine</primary>
869
870         <secondary>configuration files in /usr/afs/etc</secondary>
871       </indexterm>
872     </sect2>
873
874     <sect2 id="HDRWQ85">
875       <title>Common Configuration Files in the /usr/afs/etc Directory</title>
876
877       <para>The directory <emphasis role="bold">/usr/afs/etc</emphasis> on every file server machine's local disk contains
878       configuration files in ASCII and machine-independent binary format. For predictable AFS performance throughout a cell, all
879       server machines must have the same version of each configuration file: <itemizedlist>
880           <indexterm>
881             <primary>Update Server</primary>
882
883             <secondary>distributing server configuration files</secondary>
884           </indexterm>
885
886           <listitem>
887             <para>Cells conventionally use the Update Server to distribute a common
888             version of each file from the cell's system control machine to other server machines (for more on the system control
889             machine, see <link linkend="HDRWQ94">The System Control Machine</link>). Run the Update Server's server portion on the
890             system control machine, and the client portion on all other server machines. Update the files on the system control
891             machine only, except as directed by instructions for dealing with emergencies.</para>
892           </listitem>
893         </itemizedlist></para>
894
895       <para>Never directly edit any of the files in the <emphasis role="bold">/usr/afs/etc</emphasis> directory, except as directed
896       by instructions for dealing with emergencies. In normal circumstances, use the appropriate <emphasis
897       role="bold">bos</emphasis> commands to change the files. The following list includes pointers to instructions.</para>
898
899       <para>The files in this directory include: <variablelist>
900           <indexterm>
901             <primary>CellServDB file (server)</primary>
902
903             <secondary>about</secondary>
904           </indexterm>
905
906           <indexterm>
907             <primary>files</primary>
908
909             <secondary>CellServDB (server)</secondary>
910           </indexterm>
911
912           <varlistentry>
913             <term><emphasis role="bold">CellServDB</emphasis></term>
914
915             <listitem>
916               <para>An ASCII file that names the cell's database server machines, which run the Authentication, Backup, Protection,
917               and VL Server processes. You create the initial version of this file by issuing the <emphasis role="bold">bos
918               setcellname</emphasis> command while installing your cell's first server machine. It is very important to update this
919               file when you change the identity of your cell's database server machines.</para>
920
921               <para>The server <emphasis role="bold">CellServDB</emphasis> file is not the same as the <emphasis
922               role="bold">CellServDB</emphasis> file stored in the <emphasis role="bold">/usr/vice/etc</emphasis> directory on
923               client machines. The client version lists the database server machines for every AFS cell that you choose to make
924               accessible from the client machine. The server <emphasis role="bold">CellServDB</emphasis> file lists only the local
925               cell's database server machines, because server processes never contact processes in other cells.</para>
926
927               <para>For instructions on maintaining this file, see <link linkend="HDRWQ118">Maintaining the Server CellServDB
928               File</link>.</para>
929
930               <indexterm>
931                 <primary>KeyFile file</primary>
932
933                 <secondary>function of</secondary>
934               </indexterm>
935
936               <indexterm>
937                 <primary>files</primary>
938
939                 <secondary>KeyFile</secondary>
940               </indexterm>
941
942               <indexterm>
943                 <primary>server encryption key</primary>
944               </indexterm>
945             </listitem>
946           </varlistentry>
947
948           <varlistentry>
949             <term><emphasis role="bold">KeyFile</emphasis></term>
950
951             <listitem>
952               <para>A machine-independent, binary-format file that lists the server encryption keys the AFS server processes use to
953               encrypt and decrypt tickets. The information in this file is the basis for secure communication in the cell, and so is
954               extremely sensitive. The file is specially protected so that only privileged users can read or change it.</para>
955
956               <para>For instructions on maintaining this file, see <link linkend="HDRWQ355">Managing Server Encryption
957               Keys</link>.</para>
958
959               <indexterm>
960                 <primary>ThisCell file (server)</primary>
961               </indexterm>
962
963               <indexterm>
964                 <primary>files</primary>
965
966                 <secondary>ThisCell (server)</secondary>
967               </indexterm>
968             </listitem>
969           </varlistentry>
970
971           <varlistentry>
972             <term><emphasis role="bold">ThisCell</emphasis></term>
973
974             <listitem>
975               <para>An ASCII file that consists of a single line defining the complete Internet domain-style name of the cell (such
976               as <computeroutput>example.com</computeroutput>). You create this file with the <emphasis role="bold">bos
977               setcellname</emphasis> command during the installation of your cell's first file server machine, as instructed in the
978               <emphasis>OpenAFS Quick Beginnings</emphasis>.</para>
979
980               <para>Note that changing this file is only one step in changing your cell's name. For discussion, see <link
981               linkend="HDRWQ34">Choosing a Cell Name</link>.</para>
982
983               <indexterm>
984                 <primary>UserList file</primary>
985               </indexterm>
986
987               <indexterm>
988                 <primary>files</primary>
989
990                 <secondary>UserList</secondary>
991               </indexterm>
992             </listitem>
993           </varlistentry>
994
995           <varlistentry>
996             <term><emphasis role="bold">UserList</emphasis></term>
997
998             <listitem>
999               <para>An ASCII file that lists the usernames of the system administrators authorized to issue privileged <emphasis
1000               role="bold">bos</emphasis>, <emphasis role="bold">vos</emphasis>, and <emphasis role="bold">backup</emphasis>
1001               commands. For instructions on maintaining the file, see <link linkend="HDRWQ592">Administering the UserList
1002               File</link>.</para>
1003             </listitem>
1004           </varlistentry>
1005         </variablelist></para>
1006
1007       <indexterm>
1008         <primary>usr/afs/local directory on server machines</primary>
1009
1010         <secondary>contents listed</secondary>
1011       </indexterm>
1012
1013       <indexterm>
1014         <primary>directory</primary>
1015
1016         <secondary>/usr/afs/local on server machines</secondary>
1017       </indexterm>
1018
1019       <indexterm>
1020         <primary>local configuration files (server)</primary>
1021       </indexterm>
1022
1023       <indexterm>
1024         <primary>file server machine</primary>
1025
1026         <secondary>configuration files in /usr/afs/local</secondary>
1027       </indexterm>
1028     </sect2>
1029
1030     <sect2 id="HDRWQ86">
1031       <title>Local Configuration Files in the /usr/afs/local Directory</title>
1032
1033       <para>The directory <emphasis role="bold">/usr/afs/local</emphasis> contains configuration files that are different for each
1034       file server machine in a cell. Thus, they are not updated automatically from a central source like the files in <emphasis
1035       role="bold">/usr/afs/bin</emphasis> and <emphasis role="bold">/usr/afs/etc</emphasis> directories. The most important file is
1036       the <emphasis role="bold">BosConfig</emphasis> file; it defines which server processes are to run on that machine.</para>
1037
1038       <para>As with the common configuration files in <emphasis role="bold">/usr/afs/etc</emphasis>, you must not edit these files
1039       directly. Use commands from the <emphasis role="bold">bos</emphasis> command suite where appropriate; some files never need to
1040       be altered.</para>
1041
1042       <para>The files in this directory include the following: <variablelist>
1043           <indexterm>
1044             <primary>BosConfig file</primary>
1045           </indexterm>
1046
1047           <indexterm>
1048             <primary>files</primary>
1049
1050             <secondary>BosConfig</secondary>
1051           </indexterm>
1052
1053           <varlistentry>
1054             <term><emphasis role="bold">BosConfig</emphasis></term>
1055
1056             <listitem>
1057               <para>This file lists the server processes to run on the server machine, by defining which processes the BOS Server
1058               monitors and what it does if the process fails. It also defines the times at which the BOS Server automatically
1059               restarts processes for maintenance purposes.</para>
1060
1061               <para>As you create server processes during a file server machine's installation, their entries are defined in this
1062               file automatically. The <emphasis>OpenAFS Quick Beginnings</emphasis> outlines the <emphasis
1063               role="bold">bos</emphasis> commands to use. For a more complete description of the file, and instructions for
1064               controlling process status by editing the file with commands from the <emphasis role="bold">bos</emphasis> suite, see
1065               <link linkend="HDRWQ142">Monitoring and Controlling Server Processes</link>.</para>
1066
1067               <indexterm>
1068                 <primary>NetInfo file (server version)</primary>
1069               </indexterm>
1070
1071               <indexterm>
1072                 <primary>files</primary>
1073
1074                 <secondary>NetInfo (server version)</secondary>
1075               </indexterm>
1076             </listitem>
1077           </varlistentry>
1078
1079           <varlistentry>
1080             <term><emphasis role="bold">NetInfo</emphasis></term>
1081
1082             <listitem>
1083               <para>This optional ASCII file lists one or more of the network interface addresses on the server machine. If it
1084               exists when the File Server initializes, the File Server uses it as the basis for the list of interfaces that it
1085               registers in its Volume Location Database (VLDB) server entry. See <link linkend="HDRWQ138">Managing Server IP
1086               Addresses and VLDB Server Entries</link>.</para>
1087
1088               <indexterm>
1089                 <primary>NetRestrict file (server version)</primary>
1090               </indexterm>
1091
1092               <indexterm>
1093                 <primary>files</primary>
1094
1095                 <secondary>NetRestrict (server version)</secondary>
1096               </indexterm>
1097             </listitem>
1098           </varlistentry>
1099
1100           <varlistentry>
1101             <term><emphasis role="bold">NetRestrict</emphasis></term>
1102
1103             <listitem>
1104               <para>This optional ASCII file lists one or more network interface addresses. If it exists when the File Server
1105               initializes, the File Server removes the specified addresses from the list of interfaces that it registers in its VLDB
1106               server entry. See <link linkend="HDRWQ138">Managing Server IP Addresses and VLDB Server Entries</link>.</para>
1107
1108               <indexterm>
1109                 <primary>NoAuth file</primary>
1110               </indexterm>
1111
1112               <indexterm>
1113                 <primary>files</primary>
1114
1115                 <secondary>NoAuth</secondary>
1116               </indexterm>
1117             </listitem>
1118           </varlistentry>
1119
1120           <varlistentry>
1121             <term><emphasis role="bold">NoAuth</emphasis></term>
1122
1123             <listitem>
1124               <para>This zero-length file instructs all AFS server processes running on the machine not to perform authorization
1125               checking. Thus, they perform any action for any user, even <emphasis role="bold">anonymous</emphasis>. This very
1126               insecure state was once a part of the initial installation
1127 procedure, but is no longer needed.  It should not be used.</para>
1128
1129               <para>The file is created automatically when you start the initial <emphasis role="bold">bosserver</emphasis> process
1130               with the <emphasis role="bold">-noauth</emphasis> flag, or issue the <emphasis role="bold">bos setauth</emphasis>
1131               command to turn off authentication requirements. When you use the <emphasis role="bold">bos setauth</emphasis> command
1132               to turn on authentication, the BOS Server removes this file. For more information, see <link
1133               linkend="HDRWQ123">Managing Authentication and Authorization Requirements</link>.</para>
1134
1135               <indexterm>
1136                 <primary>SALVAGE.fs file</primary>
1137               </indexterm>
1138
1139               <indexterm>
1140                 <primary>files</primary>
1141
1142                 <secondary>SALVAGE.fs</secondary>
1143               </indexterm>
1144             </listitem>
1145           </varlistentry>
1146
1147           <varlistentry>
1148             <term><emphasis role="bold">SALVAGE.fs</emphasis></term>
1149
1150             <listitem>
1151               <para>This zero-length file controls how the BOS Server handles a crash of the File Server component of the <emphasis
1152               role="bold">fs</emphasis> process. The BOS Server creates this file each time it starts or restarts the <emphasis
1153               role="bold">fs</emphasis> process. If the file is present when the File Server crashes, then the BOS Server runs the
1154               Salvager before restarting the File Server and Volume Server again. When the File Server exits normally, the BOS
1155               Server removes the file so that the Salvager does not run.</para>
1156
1157               <para>Do not create or remove this file yourself; the BOS Server does so automatically. If necessary, you can salvage
1158               a volume or partition by using the <emphasis role="bold">bos salvage</emphasis> command; see <link
1159               linkend="HDRWQ232">Salvaging Volumes</link>.</para>
1160
1161               <indexterm>
1162                 <primary>salvage.lock file</primary>
1163               </indexterm>
1164
1165               <indexterm>
1166                 <primary>files</primary>
1167
1168                 <secondary>salvage.lock</secondary>
1169               </indexterm>
1170             </listitem>
1171           </varlistentry>
1172
1173           <varlistentry>
1174             <term><emphasis role="bold">salvage.lock</emphasis></term>
1175
1176             <listitem>
1177               <para>This file guarantees that only one Salvager process runs on a file server machine at a time (the single process
1178               can fork multiple subprocesses to salvage multiple partitions in parallel). As the Salvager initiates (when invoked by
1179               the BOS Server or by issue of the <emphasis role="bold">bos salvage</emphasis> command), it creates this zero-length
1180               file and issues the <emphasis role="bold">flock</emphasis> system call on it. It removes the file when it completes
1181               the salvage operation. Because the Salvager must lock the file in order to run, only one Salvager can run at a
1182               time.</para>
1183
1184               <indexterm>
1185                 <primary>sysid file</primary>
1186               </indexterm>
1187
1188               <indexterm>
1189                 <primary>files</primary>
1190
1191                 <secondary>sysid</secondary>
1192               </indexterm>
1193
1194               <indexterm>
1195                 <primary>File Server</primary>
1196
1197                 <secondary>interfaces registered in VLDB</secondary>
1198
1199                 <tertiary>listed in sysid file</tertiary>
1200               </indexterm>
1201
1202               <indexterm>
1203                 <primary>VLDB</primary>
1204
1205                 <secondary>server machine interfaces registered</secondary>
1206
1207                 <tertiary>listed in sysid file</tertiary>
1208               </indexterm>
1209             </listitem>
1210           </varlistentry>
1211
1212           <varlistentry>
1213             <term><emphasis role="bold">sysid</emphasis></term>
1214
1215             <listitem>
1216               <para>This file records the network interface addresses that the File Server (<emphasis
1217               role="bold">fileserver</emphasis> process) registers in its VLDB server entry. When the Cache Manager requests volume
1218               location information, the Volume Location (VL) Server provides all of the interfaces registered for each server
1219               machine that houses the volume. This enables the Cache Manager to make use of multiple addresses when accessing AFS
1220               data stored on a multihomed file server machine. For further information, see <link linkend="HDRWQ138">Managing Server
1221               IP Addresses and VLDB Server Entries</link>.</para>
1222             </listitem>
1223           </varlistentry>
1224         </variablelist></para>
1225
1226       <indexterm>
1227         <primary>usr/afs/db directory on server machines</primary>
1228
1229         <secondary>contents listed</secondary>
1230       </indexterm>
1231
1232       <indexterm>
1233         <primary>directory</primary>
1234
1235         <secondary>/usr/afs/db on server machines</secondary>
1236       </indexterm>
1237
1238       <indexterm>
1239         <primary>database files</primary>
1240       </indexterm>
1241
1242       <indexterm>
1243         <primary>replicated database files</primary>
1244       </indexterm>
1245
1246       <indexterm>
1247         <primary>log files</primary>
1248
1249         <secondary>for replicated databases</secondary>
1250       </indexterm>
1251
1252       <indexterm>
1253         <primary>file server machine</primary>
1254
1255         <secondary>database files in /usr/afs/db</secondary>
1256       </indexterm>
1257     </sect2>
1258
1259     <sect2 id="HDRWQ87">
1260       <title>Replicated Database Files in the /usr/afs/db Directory</title>
1261
1262       <para>The directory <emphasis role="bold">/usr/afs/db</emphasis> contains two types of files pertaining to the four replicated
1263       databases in the cell--the Authentication Database, Backup Database, Protection Database, and Volume Location Database (VLDB):
1264       <itemizedlist>
1265           <listitem>
1266             <para>A file that contains each database, with a <emphasis role="bold">.DB0</emphasis> extension.</para>
1267           </listitem>
1268
1269           <listitem>
1270             <para>A log file for each database, with a <emphasis role="bold">.DBSYS1</emphasis> extension. The database server
1271             process logs each database operation in this file before performing it. If the operation is interrupted, the process
1272             consults this file to learn how to finish it.</para>
1273           </listitem>
1274         </itemizedlist></para>
1275
1276       <para>Each database server process (Authentication, Backup, Protection, or VL Server) maintains its own database and log
1277       files. The database files are in binary format, so you must always access or alter them using commands from the <emphasis
1278       role="bold">kas</emphasis> suite (for the Authentication Database), <emphasis role="bold">backup</emphasis> suite (for the
1279       Backup Database), <emphasis role="bold">pts</emphasis> suite (for the Protection Database), or <emphasis
1280       role="bold">vos</emphasis> suite (for the VLDB).</para>
1281
1282       <para>If a cell runs more than one database server machine, each database server process keeps its own copy of its database on
1283       its machine's hard disk. However, it is important that all the copies of a given database are the same. To synchronize them,
1284       the database server processes call on AFS's distributed database technology, Ubik, as described in <link
1285       linkend="HDRWQ102">Replicating the OpenAFS Administrative Databases</link>.</para>
1286
1287       <para>The files listed here appear in this directory only on database server machines. On non-database server machines, this
1288       directory is empty. <variablelist>
1289           <indexterm>
1290             <primary>files</primary>
1291
1292             <secondary>bdb.DB0</secondary>
1293           </indexterm>
1294
1295           <indexterm>
1296             <primary>bdb.DB0 file</primary>
1297           </indexterm>
1298
1299           <varlistentry>
1300             <term><emphasis role="bold">bdb.DB0</emphasis></term>
1301
1302             <listitem>
1303               <para>The Backup Database file.</para>
1304
1305               <indexterm>
1306                 <primary>files</primary>
1307
1308                 <secondary>bdb.DBSYS1</secondary>
1309               </indexterm>
1310
1311               <indexterm>
1312                 <primary>bdb.DBSYS1 file</primary>
1313               </indexterm>
1314             </listitem>
1315           </varlistentry>
1316
1317           <varlistentry>
1318             <term><emphasis role="bold">bdb.DBSYS1</emphasis></term>
1319
1320             <listitem>
1321               <para>The Backup Database log file.</para>
1322
1323               <indexterm>
1324                 <primary>files</primary>
1325
1326                 <secondary>kaserver.DB0</secondary>
1327               </indexterm>
1328
1329               <indexterm>
1330                 <primary>kaserver.DB0 file</primary>
1331               </indexterm>
1332             </listitem>
1333           </varlistentry>
1334
1335           <varlistentry>
1336             <term><emphasis role="bold">kaserver.DB0</emphasis></term>
1337
1338             <listitem>
1339               <para>The Authentication Database file.</para>
1340
1341               <indexterm>
1342                 <primary>files</primary>
1343
1344                 <secondary>kaserver.DBSYS1</secondary>
1345               </indexterm>
1346
1347               <indexterm>
1348                 <primary>kaserver.DBSYS1 file</primary>
1349               </indexterm>
1350             </listitem>
1351           </varlistentry>
1352
1353           <varlistentry>
1354             <term><emphasis role="bold">kaserver.DBSYS1</emphasis></term>
1355
1356             <listitem>
1357               <para>The Authentication Database log file.</para>
1358
1359               <indexterm>
1360                 <primary>files</primary>
1361
1362                 <secondary>prdb.DB0</secondary>
1363               </indexterm>
1364
1365               <indexterm>
1366                 <primary>prdb.DB0 file</primary>
1367               </indexterm>
1368             </listitem>
1369           </varlistentry>
1370
1371           <varlistentry>
1372             <term><emphasis role="bold">prdb.DB0</emphasis></term>
1373
1374             <listitem>
1375               <para>The Protection Database file.</para>
1376
1377               <indexterm>
1378                 <primary>files</primary>
1379
1380                 <secondary>prdb.DBSYS1</secondary>
1381               </indexterm>
1382
1383               <indexterm>
1384                 <primary>prdb.DBSYS1 file</primary>
1385               </indexterm>
1386             </listitem>
1387           </varlistentry>
1388
1389           <varlistentry>
1390             <term><emphasis role="bold">prdb.DBSYS1</emphasis></term>
1391
1392             <listitem>
1393               <para>The Protection Database log file.</para>
1394
1395               <indexterm>
1396                 <primary>files</primary>
1397
1398                 <secondary>vldb.DB0</secondary>
1399               </indexterm>
1400
1401               <indexterm>
1402                 <primary>vldb.DB0 file</primary>
1403               </indexterm>
1404             </listitem>
1405           </varlistentry>
1406
1407           <varlistentry>
1408             <term><emphasis role="bold">vldb.DB0</emphasis></term>
1409
1410             <listitem>
1411               <para>The Volume Location Database file.</para>
1412
1413               <indexterm>
1414                 <primary>files</primary>
1415
1416                 <secondary>vldb.DBSYS1</secondary>
1417               </indexterm>
1418
1419               <indexterm>
1420                 <primary>vldb.DBSYS1 file</primary>
1421               </indexterm>
1422             </listitem>
1423           </varlistentry>
1424
1425           <varlistentry>
1426             <term><emphasis role="bold">vldb.DBSYS1</emphasis></term>
1427
1428             <listitem>
1429               <para>The Volume Location Database log file.</para>
1430             </listitem>
1431           </varlistentry>
1432         </variablelist></para>
1433
1434       <indexterm>
1435         <primary>usr/afs/logs directory on server machines</primary>
1436
1437         <secondary>contents listed</secondary>
1438       </indexterm>
1439
1440       <indexterm>
1441         <primary>directory</primary>
1442
1443         <secondary>/usr/afs/logs on server machines</secondary>
1444       </indexterm>
1445
1446       <indexterm>
1447         <primary>file server machine</primary>
1448
1449         <secondary>core files in /usr/afs/logs</secondary>
1450       </indexterm>
1451
1452       <indexterm>
1453         <primary>file server machine</primary>
1454
1455         <secondary>log files in /usr/afs/logs</secondary>
1456       </indexterm>
1457
1458       <indexterm>
1459         <primary>log files</primary>
1460
1461         <secondary>for server processes</secondary>
1462       </indexterm>
1463
1464       <indexterm>
1465         <primary>core files</primary>
1466
1467         <secondary>for server processes</secondary>
1468       </indexterm>
1469     </sect2>
1470
1471     <sect2 id="HDRWQ88">
1472       <title>Log Files in the /usr/afs/logs Directory</title>
1473
1474       <para>The <emphasis role="bold">/usr/afs/logs</emphasis> directory contains log files from various server processes. The files
1475       detail interesting events that occur during normal operations. For instance, the Volume Server can record volume moves in the
1476       <emphasis role="bold">VolserLog</emphasis> file. Events are recorded at completion, so the server processes do not use these
1477       files to reconstruct failed operations unlike the ones in the <emphasis role="bold">/usr/afs/db</emphasis> directory.</para>
1478
1479       <para>The information in log files can be very useful as you evaluate process failures and other problems. For instance, if
1480       you receive a timeout message when you try to access a volume, checking the <emphasis role="bold">FileLog</emphasis> file
1481       possibly provides an explanation, showing that the File Server was unable to attach the volume. To examine a log file
1482       remotely, use the <emphasis role="bold">bos getlog</emphasis> command as described in <link linkend="HDRWQ173">Displaying
1483       Server Process Log Files</link>.</para>
1484
1485       <para>This directory also contains the core image files generated if a process being monitored by the BOS Server crashes. The
1486       BOS Server attempts to add an extension to the standard <emphasis role="bold">core</emphasis> name to indicate which process
1487       generated the core file (for example, naming a core file generated by the Protection Server <emphasis
1488       role="bold">core.ptserver</emphasis>). The BOS Server cannot always assign the correct extension if two processes fail at
1489       about the same time, so it is not guaranteed to be correct.</para>
1490
1491       <para>The directory contains the following files: <variablelist>
1492           <indexterm>
1493             <primary>AuthLog file</primary>
1494           </indexterm>
1495
1496           <indexterm>
1497             <primary>files</primary>
1498
1499             <secondary>AuthLog</secondary>
1500           </indexterm>
1501
1502           <varlistentry>
1503             <term><emphasis role="bold">AuthLog</emphasis></term>
1504
1505             <listitem>
1506               <para>The Authentication Server's log file.</para>
1507
1508               <indexterm>
1509                 <primary>BackupLog file</primary>
1510               </indexterm>
1511
1512               <indexterm>
1513                 <primary>files</primary>
1514
1515                 <secondary>BackupLog</secondary>
1516               </indexterm>
1517             </listitem>
1518           </varlistentry>
1519
1520           <varlistentry>
1521             <term><emphasis role="bold">BackupLog</emphasis></term>
1522
1523             <listitem>
1524               <para>The Backup Server's log file.</para>
1525
1526               <indexterm>
1527                 <primary>BosLog file</primary>
1528               </indexterm>
1529
1530               <indexterm>
1531                 <primary>files</primary>
1532
1533                 <secondary>BosLog</secondary>
1534               </indexterm>
1535             </listitem>
1536           </varlistentry>
1537
1538           <varlistentry>
1539             <term><emphasis role="bold">BosLog</emphasis></term>
1540
1541             <listitem>
1542               <para>The BOS Server's log file.</para>
1543
1544               <indexterm>
1545                 <primary>files</primary>
1546
1547                 <secondary>FileLog</secondary>
1548               </indexterm>
1549
1550               <indexterm>
1551                 <primary>FileLog file</primary>
1552               </indexterm>
1553             </listitem>
1554           </varlistentry>
1555
1556           <varlistentry>
1557             <term><emphasis role="bold">FileLog</emphasis></term>
1558
1559             <listitem>
1560               <para>The File Server's log file.</para>
1561
1562               <indexterm>
1563                 <primary>files</primary>
1564
1565                 <secondary>SalvageLog</secondary>
1566               </indexterm>
1567
1568               <indexterm>
1569                 <primary>SalvageLog file</primary>
1570               </indexterm>
1571             </listitem>
1572           </varlistentry>
1573
1574           <varlistentry>
1575             <term><emphasis role="bold">SalvageLog</emphasis></term>
1576
1577             <listitem>
1578               <para>The Salvager's log file.</para>
1579
1580               <indexterm>
1581                 <primary>VLLog file</primary>
1582               </indexterm>
1583
1584               <indexterm>
1585                 <primary>files</primary>
1586
1587                 <secondary>VLLog</secondary>
1588               </indexterm>
1589             </listitem>
1590           </varlistentry>
1591
1592           <varlistentry>
1593             <term><emphasis role="bold">VLLog</emphasis></term>
1594
1595             <listitem>
1596               <para>The Volume Location (VL) Server's log file.</para>
1597
1598               <indexterm>
1599                 <primary>VolserLog file</primary>
1600               </indexterm>
1601
1602               <indexterm>
1603                 <primary>files</primary>
1604
1605                 <secondary>VolserLog</secondary>
1606               </indexterm>
1607             </listitem>
1608           </varlistentry>
1609
1610           <varlistentry>
1611             <term><emphasis role="bold">VolserLog</emphasis></term>
1612
1613             <listitem>
1614               <para>The Volume Server's log file.</para>
1615             </listitem>
1616           </varlistentry>
1617
1618           <varlistentry>
1619             <term><emphasis role="bold">core.process</emphasis></term>
1620
1621             <listitem>
1622               <para>If present, a core image file produced as an AFS server process on the machine crashed (probably the process
1623               named by process).</para>
1624             </listitem>
1625           </varlistentry>
1626         </variablelist></para>
1627
1628       <note>
1629         <para>To prevent log files from growing unmanageably large, restart the server processes periodically, particularly the
1630         database server processes. To avoid restarting the processes, use the UNIX <emphasis role="bold">rm</emphasis> command to
1631         remove the file as the process runs; it re-creates it automatically.</para>
1632       </note>
1633
1634       <indexterm>
1635         <primary>vicep directory on server machines</primary>
1636
1637         <secondary>contents listed</secondary>
1638       </indexterm>
1639
1640       <indexterm>
1641         <primary>directory</primary>
1642
1643         <secondary>/vicep on server machines</secondary>
1644       </indexterm>
1645
1646       <indexterm>
1647         <primary>volume header</primary>
1648
1649         <secondary>in /vicep directories</secondary>
1650       </indexterm>
1651
1652       <indexterm>
1653         <primary>partition</primary>
1654
1655         <secondary>housing AFS volumes</secondary>
1656       </indexterm>
1657
1658       <indexterm>
1659         <primary>file server machine</primary>
1660
1661         <secondary>partitions, naming</secondary>
1662       </indexterm>
1663     </sect2>
1664
1665     <sect2 id="HDRWQ89">
1666       <title>Volume Headers on Server Partitions</title>
1667
1668       <para>A partition that houses AFS volumes must be mounted at a subdirectory of the machine's root ( / ) directory (not, for
1669       instance under the <emphasis role="bold">/usr</emphasis> directory). The file server machine's file system registry file
1670       (<emphasis role="bold">/etc/fstab</emphasis> or equivalent) must correctly map the directory name and the partition's device
1671       name. The directory name is of the form <emphasis role="bold">/vicep</emphasis>index, where each index is one or two lowercase
1672       letters. By convention, the first AFS partition on a machine is mounted at <emphasis role="bold">/vicepa</emphasis>, the
1673       second at <emphasis role="bold">/vicepb</emphasis>, and so on. If there are more than 26 partitions, continue with <emphasis
1674       role="bold">/vicepaa</emphasis>, <emphasis role="bold">/vicepab</emphasis> and so on. The <emphasis>OpenAFS Release
1675       Notes</emphasis> specifies the number of supported partitions per server machine.</para>
1676
1677       <para>Do not store non-AFS files on AFS partitions. The File Server and Volume Server expect to have available all of the
1678       space on the partition.</para>
1679
1680       <para>The <emphasis role="bold">/vicep</emphasis> directories contain two types of files: <variablelist>
1681           <indexterm>
1682             <primary>V.<emphasis>vol_ID</emphasis>.vol file</primary>
1683           </indexterm>
1684
1685           <indexterm>
1686             <primary>files</primary>
1687
1688             <secondary>V.<emphasis>vol_ID</emphasis>.vol</secondary>
1689           </indexterm>
1690
1691           <varlistentry>
1692             <term><emphasis role="bold">Vvol_ID.vol</emphasis></term>
1693
1694             <listitem>
1695               <para>Each such file is a volume header. The vol_ID corresponds to the volume ID number displayed in the output from
1696               the <emphasis role="bold">vos examine</emphasis>, <emphasis role="bold">vos listvldb</emphasis>, and <emphasis
1697               role="bold">vos listvol</emphasis> commands.</para>
1698
1699               <indexterm>
1700                 <primary>FORCESALVAGE file</primary>
1701               </indexterm>
1702
1703               <indexterm>
1704                 <primary>files</primary>
1705
1706                 <secondary>FORCESALVAGE</secondary>
1707               </indexterm>
1708             </listitem>
1709           </varlistentry>
1710
1711           <varlistentry>
1712             <term><emphasis role="bold">FORCESALVAGE</emphasis></term>
1713
1714             <listitem>
1715               <para>This zero-length file triggers the Salvager to salvage the entire partition. The AFS-modified version of the
1716               <emphasis role="bold">fsck</emphasis> program creates this file if it discovers corruption.</para>
1717             </listitem>
1718           </varlistentry>
1719         </variablelist></para>
1720
1721       <note>
1722         <para>For most system types, it is important never to run the standard <emphasis role="bold">fsck</emphasis> program
1723         provided with the operating system on an AFS file server machine. It removes all AFS volume data from server partitions
1724         because it does not recognize their format.</para>
1725       </note>
1726
1727       <indexterm>
1728         <primary>roles for server machine</primary>
1729       </indexterm>
1730
1731       <indexterm>
1732         <primary>server machine</primary>
1733
1734         <secondary>roles summarized</secondary>
1735       </indexterm>
1736     </sect2>
1737   </sect1>
1738
1739   <sect1 id="HDRWQ90">
1740     <title>The Four Roles for File Server Machines</title>
1741
1742     <para>In cells that have more than one server machine, not all server machines have to perform exactly the same functions. The
1743     are four possible <emphasis>roles</emphasis> a machine can assume, determined by which server processes it is running. A machine
1744     can assume more than one role by running all of the relevant processes. The following list summarizes the four roles, which are
1745     described more completely in subsequent sections. <itemizedlist>
1746         <listitem>
1747           <para>A <emphasis>simple file server</emphasis> machine runs only the processes that store and deliver AFS files to client
1748           machines. You can run as many simple file server machines as you need to satisfy your cell's performance and disk space
1749           requirements.</para>
1750         </listitem>
1751
1752         <listitem>
1753           <para>A <emphasis>database server machine</emphasis> runs the four database server processes that maintain AFS's
1754           replicated administrative databases: the Authentication, Backup, Protection, and Volume Location (VL) Server
1755           processes.</para>
1756         </listitem>
1757
1758         <listitem>
1759           <para>A <emphasis>binary distribution machine</emphasis> distributes the AFS server binaries for its system type to all
1760           other server machines of that system type.</para>
1761         </listitem>
1762
1763         <listitem>
1764           <para>The single <emphasis>system control machine</emphasis> distributes common server configuration files to all other
1765           server machines in the cell.</para>
1766         </listitem>
1767       </itemizedlist></para>
1768
1769     <para>If a cell has a single server machine, it assumes the simple file server and database server roles. The instructions in
1770     the <emphasis>OpenAFS Quick Beginnings</emphasis> also have you configure it as the system control machine and binary
1771     distribution machine for its system type, but it does not actually perform those functions until you install another server
1772     machine.</para>
1773
1774     <para>It is best to keep the binaries for all of the AFS server processes in the <emphasis role="bold">/usr/afs/bin</emphasis>
1775     directory, even if not all processes are running. You can then change which roles a machine assumes simply by starting or
1776     stopping the processes that define the role.</para>
1777
1778     <indexterm>
1779       <primary>simple file server machine</primary>
1780     </indexterm>
1781
1782     <indexterm>
1783       <primary>server machine</primary>
1784
1785       <secondary>simple file server role</secondary>
1786     </indexterm>
1787
1788     <sect2 id="HDRWQ91">
1789       <title>Simple File Server Machines</title>
1790
1791       <para>A <emphasis>simple file server machine</emphasis> runs only the server processes that store and deliver AFS files to
1792       client machines, monitor process status, and pick up binaries and configuration files from the cell's binary distribution and
1793       system control machines.</para>
1794
1795       <para>In general, only cells with more than three server machines need to run simple file server machines. In cells with three
1796       or fewer machines, all of them are usually database server machines (to benefit from replicating the administrative
1797       databases); see <link linkend="HDRWQ92">Database Server Machines</link>.</para>
1798
1799       <para>The following processes run on a simple file server machine: <itemizedlist>
1800           <listitem>
1801             <para>The BOS Server (<emphasis role="bold">bosserver</emphasis> process)</para>
1802           </listitem>
1803
1804           <listitem>
1805             <para>The <emphasis role="bold">fs</emphasis> process, which combines the File Server, Volume Server, and Salvager
1806             processes so that they can coordinate their operations on the data in volumes and avoid the inconsistencies that can
1807             result from multiple simultaneous operations on the same data</para>
1808           </listitem>
1809
1810           <listitem>
1811             <para>A client portion of the Update Server that picks up binary files from the binary distribution machine of its AFS
1812             system type (the <emphasis role="bold">upclientbin</emphasis> process)</para>
1813           </listitem>
1814
1815           <listitem>
1816             <para>A client portion of the Update Server that picks up common configuration files from the system control machine
1817             (the <emphasis role="bold">upclientetc</emphasis> process)</para>
1818           </listitem>
1819         </itemizedlist></para>
1820
1821       <indexterm>
1822         <primary>database server machine</primary>
1823
1824         <secondary>defined</secondary>
1825       </indexterm>
1826
1827       <indexterm>
1828         <primary>server machine</primary>
1829
1830         <secondary>database server role</secondary>
1831       </indexterm>
1832
1833       <indexterm>
1834         <primary>Backup Server</primary>
1835
1836         <secondary>runs on database server machine</secondary>
1837       </indexterm>
1838
1839       <indexterm>
1840         <primary>Authentication Server</primary>
1841
1842         <secondary>runs on database server machine</secondary>
1843       </indexterm>
1844
1845       <indexterm>
1846         <primary>Protection Server</primary>
1847
1848         <secondary>runs on database server machine</secondary>
1849       </indexterm>
1850
1851       <indexterm>
1852         <primary>VL Server</primary>
1853
1854         <secondary>runs on database server machine</secondary>
1855       </indexterm>
1856     </sect2>
1857
1858     <sect2 id="HDRWQ92">
1859       <title>Database Server Machines</title>
1860
1861       <para>A <emphasis>database server machine</emphasis> runs the four processes that maintain the AFS replicated administrative
1862       databases: the Authentication Server, Backup Server, Protection Server, and Volume Location (VL) Server, which maintain the
1863       Authentication Database, Backup Database, Protection Database, and Volume Location Database (VLDB), respectively. To review
1864       the functions of these server processes and their databases, see <link linkend="HDRWQ17">AFS Server Processes and the Cache
1865       Manager</link>.</para>
1866
1867       <para>If a cell has more than one server machine, it is best to run more than one database server machine, but more than three
1868       are rarely necessary. Replicating the databases in this way yields the same benefits as replicating volumes: increased
1869       availability and reliability of information. If one database server machine or process goes down, the information in the
1870       database is still available from others. The load of requests for database information is spread across multiple machines,
1871       preventing any one from becoming overloaded.</para>
1872
1873       <para>Unlike replicated volumes, however, replicated databases do change frequently. Consistent system performance demands
1874       that all copies of the database always be identical, so it is not possible to record changes in only some of them. To
1875       synchronize the copies of a database, the database server processes use AFS's distributed database technology, Ubik. See <link
1876       linkend="HDRWQ102">Replicating the OpenAFS Administrative Databases</link>.</para>
1877
1878       <para>It is critical that the AFS server processes on every server machine in a cell know which machines are the database
1879       server machines. The database server processes in particular must maintain constant contact with their peers in order to
1880       coordinate the copies of the database. The other server processes often need information from the databases. Every file server
1881       machine keeps a list of its cell's database server machines in its local <emphasis
1882       role="bold">/usr/afs/etc/CellServDB</emphasis> file. Cells that use the States edition of AFS can use the system control
1883       machine to distribute this file (see <link linkend="HDRWQ94">The System Control Machine</link>).</para>
1884
1885       <para>The following processes define a database server machine: <itemizedlist>
1886           <listitem>
1887             <para>The Authentication Server (<emphasis role="bold">kaserver</emphasis> process)</para>
1888           </listitem>
1889
1890           <listitem>
1891             <para>The Backup Server (<emphasis role="bold">buserver</emphasis> process)</para>
1892           </listitem>
1893
1894           <listitem>
1895             <para>The Protection Server (<emphasis role="bold">ptserver</emphasis> process)</para>
1896           </listitem>
1897
1898           <listitem>
1899             <para>The VL Server (<emphasis role="bold">vlserver</emphasis> process)</para>
1900           </listitem>
1901         </itemizedlist></para>
1902
1903       <para>Database server machines can also run the processes that define a simple file server machine, as listed in <link
1904       linkend="HDRWQ91">Simple File Server Machines</link>. One database server machine can act as the cell's system control
1905       machine, and any database server machine can serve as the binary distribution machine for its system type; see <link
1906       linkend="HDRWQ94">The System Control Machine</link> and <link linkend="HDRWQ93">Binary Distribution Machines</link>.</para>
1907
1908       <indexterm>
1909         <primary>binary distribution machine</primary>
1910
1911         <secondary>defined</secondary>
1912       </indexterm>
1913
1914       <indexterm>
1915         <primary>server machine</primary>
1916
1917         <secondary>binary distribution role</secondary>
1918       </indexterm>
1919
1920       <indexterm>
1921         <primary>Update Server</primary>
1922
1923         <secondary>server portion</secondary>
1924
1925         <tertiary>on binary distribution machine</tertiary>
1926       </indexterm>
1927
1928       <indexterm>
1929         <primary>Update Server</primary>
1930
1931         <secondary>client portion</secondary>
1932
1933         <tertiary>for binaries</tertiary>
1934       </indexterm>
1935     </sect2>
1936
1937     <sect2 id="HDRWQ93">
1938       <title>Binary Distribution Machines</title>
1939
1940       <para>A <emphasis>binary distribution machine</emphasis> stores and distributes the binary files for the AFS processes and
1941       command suites to all other server machines of its system type. Each file server machine keeps its own copy of AFS server
1942       process binaries on its local disk, by convention in the <emphasis role="bold">/usr/afs/bin</emphasis> directory. For
1943       consistent system performance, however, all server machines must run the same version (build level) of a process. For
1944       instructions for checking a binary's build level, see <link linkend="HDRWQ117">Displaying A Binary File's Build Level</link>.
1945       The easiest way to keep the binaries consistent is to have a binary distribution machine of each system type distribute them
1946       to its system-type peers.</para>
1947
1948       <para>The process that defines a binary distribution machine is the server portion of the Update Server (<emphasis
1949       role="bold">upserver</emphasis> process). The client portion of the Update Server (<emphasis
1950       role="bold">upclientbin</emphasis> process) runs on the other server machines of that system type and references the binary
1951       distribution machine.</para>
1952
1953       <para>Binary distribution machines usually also run the processes that define a simple file server machine, as listed in <link
1954       linkend="HDRWQ91">Simple File Server Machines</link>. One binary distribution machine can act as the cell's system control
1955       machine, and any binary distribution machine can serve as a database server machine; see <link linkend="HDRWQ94">The System
1956       Control Machine</link> and <link linkend="HDRWQ92">Database Server Machines</link>.</para>
1957
1958       <indexterm>
1959         <primary>system control machine</primary>
1960       </indexterm>
1961
1962       <indexterm>
1963         <primary>configuration files</primary>
1964
1965         <secondary>server machine, common</secondary>
1966       </indexterm>
1967
1968       <indexterm>
1969         <primary>server machine</primary>
1970
1971         <secondary>system control role</secondary>
1972       </indexterm>
1973     </sect2>
1974
1975     <sect2 id="HDRWQ94">
1976       <title>The System Control Machine</title>
1977
1978       <para>The <emphasis>system control machine</emphasis> stores and
1979       distributes system configuration files shared by all of the server machines in the cell. Each file server machine keeps its
1980       own copy of the configuration files on its local disk, by convention in the <emphasis role="bold">/usr/afs/etc</emphasis>
1981       directory. For consistent system performance, however, all server machines must use the same files. The easiest way to keep
1982       the files consistent is to have the system control machine distribute them. You make changes only to the copy stored on the
1983       system control machine, as directed by the instructions in this document.</para>
1984
1985       <para>For a list of the configuration files stored in the <emphasis role="bold">/usr/afs/etc</emphasis> directory, see <link
1986       linkend="HDRWQ85">Common Configuration Files in the /usr/afs/etc Directory</link>.</para>
1987
1988       <para>The <emphasis>OpenAFS Quick Beginnings</emphasis> configures a cell's first server machine as the system control
1989       machine. If you wish, you can reassign the role to a different machine that you install later, but you must then change the
1990       client portion of the Update Server (<emphasis role="bold">upclientetc</emphasis>) process running on all other server
1991       machines to refer to the new system control machine.</para>
1992
1993       <para>The following processes define the system control machine: <itemizedlist>
1994           <indexterm>
1995             <primary>Update Server</primary>
1996
1997             <secondary>server portion</secondary>
1998
1999             <tertiary>on system control machine</tertiary>
2000           </indexterm>
2001
2002           <indexterm>
2003             <primary>Update Server</primary>
2004
2005             <secondary>client portion</secondary>
2006
2007             <tertiary>for configuration files</tertiary>
2008           </indexterm>
2009
2010           <listitem>
2011             <para>The server portion of the Update Server (<emphasis role="bold">upserver</emphasis>) process
2012             The client portion of the Update Server (<emphasis role="bold">upclientetc</emphasis>
2013             process) runs on the other server machines and references the system control machine.</para>
2014           </listitem>
2015         </itemizedlist></para>
2016
2017       <para>The system control machine can also run the processes that define a simple file server machine, as listed in <link
2018       linkend="HDRWQ91">Simple File Server Machines</link>. It can also server as a database server machine, and by convention acts
2019       as the binary distribution machine for its system type. A single <emphasis role="bold">upserver</emphasis> process can
2020       distribute both configuration files and binaries. See <link linkend="HDRWQ92">Database Server Machines</link> and <link
2021       linkend="HDRWQ93">Binary Distribution Machines</link>.</para>
2022
2023       <indexterm>
2024         <primary>determining</primary>
2025
2026         <secondary>roles taken by server machine</secondary>
2027       </indexterm>
2028
2029       <indexterm>
2030         <primary>identifying</primary>
2031
2032         <secondary>roles taken by server machine</secondary>
2033       </indexterm>
2034
2035       <indexterm>
2036         <primary>server machine</primary>
2037
2038         <secondary>determining roles</secondary>
2039       </indexterm>
2040
2041       <indexterm>
2042         <primary>roles for server machine</primary>
2043
2044         <secondary>determining</secondary>
2045       </indexterm>
2046
2047       <indexterm>
2048         <primary>database server machine</primary>
2049
2050         <secondary>identifying with bos status</secondary>
2051       </indexterm>
2052
2053       <indexterm>
2054         <primary>determining</primary>
2055
2056         <secondary>identity of database server machines</secondary>
2057       </indexterm>
2058
2059       <indexterm>
2060         <primary>identifying</primary>
2061
2062         <secondary>database server machine</secondary>
2063       </indexterm>
2064     </sect2>
2065
2066     <sect2 id="HDRWQ95">
2067       <title>To locate database server machines</title>
2068
2069       <orderedlist>
2070         <listitem>
2071           <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command. <programlisting>
2072    % <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
2073 </programlisting></para>
2074
2075           <para>The machines listed in the output are the cell's database server machines. For complete instructions and example
2076           output, see <link linkend="HDRWQ120">To display a cell's database server machines</link>.</para>
2077         </listitem>
2078
2079         <listitem>
2080           <para><emphasis role="bold">(Optional)</emphasis> Issue the <emphasis role="bold">bos status</emphasis> command to verify
2081           that a machine listed in the output of the <emphasis role="bold">bos listhosts</emphasis> command is actually running the
2082           processes that define it as a database server machine. For complete instructions, see <link linkend="HDRWQ158">Displaying
2083           Process Status and Information from the BosConfig File</link>. <programlisting>
2084    % <emphasis role="bold">bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver kaserver ptserver vlserver</emphasis>
2085 </programlisting></para>
2086
2087           <para>If the specified machine is a database server machine, the output from the <emphasis role="bold">bos
2088           status</emphasis> command includes the following lines:</para>
2089
2090           <programlisting>
2091    Instance buserver, currently running normally.
2092    Instance kaserver, currently running normally.
2093    Instance ptserver, currently running normally.
2094    Instance vlserver, currently running normally.
2095 </programlisting>
2096         </listitem>
2097       </orderedlist>
2098
2099       <indexterm>
2100         <primary>system control machine</primary>
2101
2102         <secondary>identifying with bos status</secondary>
2103       </indexterm>
2104
2105       <indexterm>
2106         <primary>determining</primary>
2107
2108         <secondary>identity of system control machine</secondary>
2109       </indexterm>
2110
2111       <indexterm>
2112         <primary>identifying</primary>
2113
2114         <secondary>system control machine</secondary>
2115       </indexterm>
2116     </sect2>
2117
2118     <sect2 id="HDRWQ96">
2119       <title>To locate the system control machine</title>
2120
2121       <orderedlist>
2122         <listitem>
2123           <para>Issue the <emphasis role="bold">bos status</emphasis> command for any server machine. Complete instructions appear
2124           in <link linkend="HDRWQ158">Displaying Process Status and Information from the BosConfig File</link>. <programlisting>
2125    % <emphasis role="bold">bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">upserver upclientbin upclientetc</emphasis> <emphasis
2126                 role="bold">-long</emphasis>
2127 </programlisting></para>
2128
2129           <para>The output you see depends on the machine you have contacted: a simple file server machine, the system control
2130           machine, or a binary distribution machine. See <link linkend="HDRWQ98">Interpreting the Output from the bos status
2131           Command</link>.</para>
2132         </listitem>
2133       </orderedlist>
2134
2135       <indexterm>
2136         <primary>binary distribution machine</primary>
2137
2138         <secondary>identifying with bos status</secondary>
2139       </indexterm>
2140
2141       <indexterm>
2142         <primary>determining</primary>
2143
2144         <secondary>identity of binary distribution machine</secondary>
2145       </indexterm>
2146
2147       <indexterm>
2148         <primary>identifying</primary>
2149
2150         <secondary>binary distribution machine</secondary>
2151       </indexterm>
2152     </sect2>
2153
2154     <sect2 id="HDRWQ97">
2155       <title>To locate the binary distribution machine for a system type</title>
2156
2157       <orderedlist>
2158         <listitem>
2159           <para>Issue the <emphasis role="bold">bos status</emphasis> command for a file server machine of the system type you are
2160           checking (to determine a machine's system type, issue the <emphasis role="bold">fs sysname</emphasis> or <emphasis
2161           role="bold">sys</emphasis> command as described in <link linkend="HDRWQ417">Displaying and Setting the System Type
2162           Name</link>. Complete instructions for the <emphasis role="bold">bos status</emphasis> command appear in <link
2163           linkend="HDRWQ158">Displaying Process Status and Information from the BosConfig File</link>. <programlisting>
2164    % <emphasis role="bold">bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">upserver upclientbin upclientetc -long</emphasis>
2165 </programlisting></para>
2166
2167           <para>The output you see depends on the machine you have contacted: a simple file server machine, the system control
2168           machine, or a binary distribution machine. See <link linkend="HDRWQ98">Interpreting the Output from the bos status
2169           Command</link>.</para>
2170         </listitem>
2171       </orderedlist>
2172
2173       <indexterm>
2174         <primary>simple file server machine</primary>
2175
2176         <secondary>identifying with bos status</secondary>
2177       </indexterm>
2178
2179       <indexterm>
2180         <primary>determining</primary>
2181
2182         <secondary>identity of:</secondary>
2183
2184         <tertiary>simple file server machines</tertiary>
2185       </indexterm>
2186
2187       <indexterm>
2188         <primary>identifying</primary>
2189
2190         <secondary>simple file server machine</secondary>
2191       </indexterm>
2192     </sect2>
2193
2194     <sect2 id="HDRWQ98">
2195       <title>Interpreting the Output from the bos status Command</title>
2196
2197       <para>Interpreting the output of the <emphasis role="bold">bos status</emphasis> command is most straightforward for a simple
2198       file server machine. There is no <emphasis role="bold">upserver</emphasis> process, so the output includes the following
2199       message:</para>
2200
2201       <programlisting>
2202    bos: failed to get instance info for 'upserver' (no such entity)
2203 </programlisting>
2204
2205       <para>A simple file server machine runs the <emphasis role="bold">upclientbin</emphasis> process, so the output includes a
2206       message like the following. It indicates that <emphasis role="bold">fs7.example.com</emphasis> is the binary distribution machine
2207       for this system type.</para>
2208
2209       <programlisting>
2210    Instance upclientbin, (type is simple) currently running normally.
2211    Process last started at Wed Mar 10  23:37:09 1999 (1 proc start)
2212    Command 1 is '/usr/afs/bin/upclient fs7.example.com -t 60 /usr/afs/bin'
2213 </programlisting>
2214
2215       <para>A simple file server machine also runs the <emphasis
2216       role="bold">upclientetc</emphasis> process, so the output includes a message like the following. It indicates that <emphasis
2217       role="bold">fs1.example.com</emphasis> is the system control machine.</para>
2218
2219       <programlisting>
2220    Instance upclientetc, (type is simple) currently running normally.
2221    Process last started at Mon Mar 22  05:23:49 1999 (1 proc start)
2222    Command 1 is '/usr/afs/bin/upclient fs1.example.com -t 60 /usr/afs/etc'
2223 </programlisting>
2224
2225       <sect3 id="HDRWQ99">
2226         <title>The Output on the System Control Machine</title>
2227
2228         <para>If you have issued the <emphasis role="bold">bos status</emphasis> command
2229         for the system control machine, the output includes an entry for the <emphasis role="bold">upserver</emphasis> process
2230         similar to the following:</para>
2231
2232         <programlisting>
2233    Instance upserver, (type is simple) currently running normally.
2234    Process last started at Mon Mar 22 05:23:54 1999 (1 proc start)
2235    Command 1 is '/usr/afs/bin/upserver'
2236 </programlisting>
2237
2238         <para>If you are using the default configuration recommended in the <emphasis>OpenAFS Quick Beginnings</emphasis>, the
2239         system control machine is also the binary distribution machine for its system type, and a single <emphasis
2240         role="bold">upserver</emphasis> process distributes both kinds of updates. In that case, the output includes the following
2241         messages:</para>
2242
2243         <programlisting>
2244    bos: failed to get instance info for 'upclientbin' (no such entity)
2245    bos: failed to get instance info for 'upclientetc' (no such entity)
2246 </programlisting>
2247
2248         <para>If the system control machine is not a binary distribution machine, the output includes an error message for the
2249         <emphasis role="bold">upclientetc</emphasis> process, but a complete a listing for the <emphasis
2250         role="bold">upclientbin</emphasis> process (in this case it refers to the machine <emphasis
2251         role="bold">fs5.example.com</emphasis> as the binary distribution machine):</para>
2252
2253         <programlisting>
2254    Instance upclientbin, (type is simple) currently running normally.
2255    Process last started at Mon Mar 22  05:23:49 1999 (1 proc start)
2256    Command 1 is '/usr/afs/bin/upclient fs5.example.com -t 60 /usr/afs/bin'
2257    bos: failed to get instance info for 'upclientetc' (no such entity)
2258 </programlisting>
2259       </sect3>
2260
2261       <sect3 id="HDRWQ100">
2262         <title>The Output on a Binary Distribution Machine</title>
2263
2264         <para>If you have issued the <emphasis role="bold">bos status</emphasis> command for a binary distribution machine, the
2265         output includes an entry for the <emphasis role="bold">upserver</emphasis> process similar to the following and error
2266         message for the <emphasis role="bold">upclientbin</emphasis> process:</para>
2267
2268         <programlisting>
2269    Instance upserver, (type is simple) currently running normally.
2270    Process last started at Mon Apr 5 05:23:54 1999 (1 proc start)
2271    Command 1 is '/usr/afs/bin/upserver'
2272    bos: failed to get instance info for 'upclientbin' (no such entity)
2273 </programlisting>
2274
2275         <para>Unless this machine also happens to be the system control machine, a message like the following references the system
2276         control machine (in this case, <emphasis role="bold">fs3.example.com</emphasis>):</para>
2277
2278         <programlisting>
2279    Instance upclientetc, (type is simple) currently running normally.
2280    Process last started at Mon Apr 5 05:23:49 1999 (1 proc start)
2281    Command 1 is '/usr/afs/bin/upclient fs3.example.com -t 60 /usr/afs/etc'
2282 </programlisting>
2283       </sect3>
2284     </sect2>
2285   </sect1>
2286
2287   <sect1 id="HDRWQ101">
2288     <title>Administering Database Server Machines</title>
2289
2290     <para>This section explains how to administer database server machines. For installation instructions, see the <emphasis>OpenAFS
2291     Quick Beginnings</emphasis>.</para>
2292
2293     <indexterm>
2294       <primary>distribution</primary>
2295
2296       <secondary>of databases</secondary>
2297     </indexterm>
2298
2299     <indexterm>
2300       <primary>database, distributed</primary>
2301
2302       <secondary></secondary>
2303
2304       <see>administrative database</see>
2305     </indexterm>
2306
2307     <indexterm>
2308       <primary>distributed database</primary>
2309
2310       <secondary></secondary>
2311
2312       <see>administrative database</see>
2313     </indexterm>
2314
2315     <indexterm>
2316       <primary>administrative database</primary>
2317
2318       <secondary>about replicating</secondary>
2319     </indexterm>
2320
2321     <indexterm>
2322       <primary>database server machine</primary>
2323
2324       <secondary>maintaining</secondary>
2325     </indexterm>
2326
2327     <indexterm>
2328       <primary>Ubik</primary>
2329
2330       <secondary>operation described</secondary>
2331     </indexterm>
2332
2333     <indexterm>
2334       <primary>synchronization site (Ubik)</primary>
2335
2336       <secondary>defined</secondary>
2337     </indexterm>
2338
2339     <indexterm>
2340       <primary>secondary site (Ubik)</primary>
2341     </indexterm>
2342
2343     <indexterm>
2344       <primary>coordinator (Ubik)</primary>
2345
2346       <secondary>defined</secondary>
2347     </indexterm>
2348
2349     <indexterm>
2350       <primary>Ubik</primary>
2351
2352       <secondary>automatic updates</secondary>
2353     </indexterm>
2354
2355     <indexterm>
2356       <primary>automatic</primary>
2357
2358       <secondary>update to admin. databases by Ubik</secondary>
2359     </indexterm>
2360
2361     <sect2 id="HDRWQ102">
2362       <title>Replicating the OpenAFS Administrative Databases</title>
2363
2364       <para>There are several benefits to replicating the AFS administrative databases (the Authentication, Backup, Protection, and
2365       Volume Location Databases), as discussed in <link linkend="HDRWQ52">Replicating the OpenAFS Administrative Databases</link>. For
2366       correct cell functioning, the copies of each database must be identical at all times. To keep the databases synchronized, AFS
2367       uses library of utilities called <emphasis>Ubik</emphasis>. Each database server process runs an associated lightweight Ubik
2368       process, and client-side programs call Ubik's client-side subroutines when they submit requests to read and change the
2369       databases.</para>
2370
2371       <para>Ubik is designed to work with minimal administrator intervention, but there are several configuration requirements, as
2372       detailed in <link linkend="HDRWQ103">Configuring the Cell for Proper Ubik Operation</link>. The following brief overview of
2373       Ubik's operation is helpful for understanding the requirements. For more details, see <link linkend="HDRWQ104">How Ubik
2374       Operates Automatically</link>.</para>
2375
2376       <para>Ubik is designed to distribute changes made in an AFS administrative database to all copies as quickly as possible. Only
2377       one copy of the database, the <emphasis>synchronization site</emphasis>, accepts change requests from clients; the lightweight
2378       Ubik process running there is the <emphasis>Ubik coordinator</emphasis>. To maintain maximum availability, there is a separate
2379       Ubik coordinator for each database, and the synchronization site for each of the four databases can be on a different machine.
2380       The synchronization site for a database can also move from machine to machine in response to process, machine, or network
2381       outages.</para>
2382
2383       <para>The other copies of a database, and the Ubik processes that maintain them, are termed <emphasis>secondary</emphasis>.
2384       The secondary sites do not accept database changes directly from client-side programs, but only from the synchronization
2385       site.</para>
2386
2387       <para>After the Ubik coordinator records a change in its copy of a database, it immediately sends the change to the secondary
2388       sites. During the brief distribution period, clients cannot access any of the copies of the database, even for reading. If the
2389       coordinator cannot reach a majority of the secondary sites, it halts the distribution and informs the client that the
2390       attempted change failed.</para>
2391
2392       <para>To avoid distribution failures, the Ubik processes maintain constant contact by exchanging time-stamped messages. As
2393       long as a majority of the secondary sites respond to the coordinator's messages, there is a <emphasis>quorum</emphasis> of
2394       sites that are synchronized with the coordinator. If a process, machine, or network outage breaks the quorum, the Ubik
2395       processes attempt to elect a new coordinator in order to establish a new quorum among the highest possible number of sites.
2396       See <link linkend="HDRWQ106">A Flexible Coordinator Boosts Availability</link>.</para>
2397
2398       <indexterm>
2399         <primary>Ubik</primary>
2400
2401         <secondary>requirements summarized</secondary>
2402       </indexterm>
2403
2404       <indexterm>
2405         <primary>database server process</primary>
2406
2407         <secondary>need to run all on every database server machine</secondary>
2408       </indexterm>
2409
2410       <indexterm>
2411         <primary>CellServDB file (server)</primary>
2412
2413         <secondary>importance to Ubik operation</secondary>
2414       </indexterm>
2415
2416       <sect3 id="HDRWQ103">
2417         <title>Configuring the Cell for Proper Ubik Operation</title>
2418
2419         <para>This section describes how to configure your cell to maintain proper Ubik operation. <itemizedlist>
2420             <listitem>
2421               <para>Run all four database server processes--Authentication Server, Backup Server, Protection Server, and VL
2422               Server--on all database server machines.</para>
2423
2424               <para>Both the client and server portions of Ubik expect that all the database server machines listed in the <emphasis
2425               role="bold">CellServDB</emphasis> file are running all of the database server processes. There is no mechanism for
2426               indicating that only some database server processes are running on a machine.</para>
2427             </listitem>
2428
2429             <listitem>
2430               <para>Maintain correct information in the <emphasis role="bold">/usr/afs/etc/CellServDB</emphasis> file at all
2431               times.</para>
2432
2433               <para>Ubik consults the <emphasis role="bold">/usr/afs/etc/CellServDB</emphasis> file to determine the sites with
2434               which to establish and maintain a quorum. Incorrect information can result in unsynchronized databases or election of
2435               a coordinator in each of several subgroups of machines, because the Ubik processes on various machines do not agree on
2436               which machines need to participate in the quorum.</para>
2437
2438               <para>If you use the Update Server, it is simplest to maintain the <emphasis
2439               role="bold">/usr/afs/etc/CellServDB</emphasis> file on the system control machine, which distributes its copy to all
2440               other server machines. The <emphasis>OpenAFS Quick Beginnings</emphasis> explains how to configure the Update Server.
2441               </para>
2442
2443               <para>The only reason to alter the file is when configuring or decommissioning a database server machine. Use the
2444               appropriate <emphasis role="bold">bos</emphasis> commands rather than editing the file by hand. For instructions, see
2445               <link linkend="HDRWQ118">Maintaining the Server CellServDB File</link>. The instructions in <link
2446               linkend="HDRWQ142">Monitoring and Controlling Server Processes</link> for stopping and starting processes remind you
2447               to alter the <emphasis role="bold">CellServDB</emphasis> file when appropriate, as do the instructions in the
2448               <emphasis>OpenAFS Quick Beginnings</emphasis> for installing or decommissioning a database server machine.</para>
2449
2450               <para>(Client processes and the server processes that do not maintain databases also rely on correct information in
2451               the <emphasis role="bold">CellServDB</emphasis> file for proper operation, but their use of the information does not
2452               affect Ubik's operation. See <link linkend="HDRWQ118">Maintaining the Server CellServDB File</link> and <link
2453               linkend="HDRWQ406">Maintaining Knowledge of Database Server Machines</link>.)</para>
2454
2455               <indexterm>
2456                 <primary>clocks</primary>
2457
2458                 <secondary>need to synchronize for Ubik</secondary>
2459               </indexterm>
2460             </listitem>
2461
2462             <listitem>
2463               <para>Keep the clocks synchronized on all machines in the cell, especially the database server machines.</para>
2464
2465               <para>Keeping clocks synchronized is important because the Ubik processes at a database's sites timestamp the messages
2466               which they exchange to maintain constant contact. Timestamping the messages is necessary because in a networked
2467               environment it is not safe to assume that a message reaches its destination instantly. Ubik compares the timestamp on
2468               an incoming message with the current time. If the difference is too great, it is possible that an outage is preventing
2469               reliable communication between the Ubik sites, which can possibly result in unsynchronized databases. Ubik considers
2470               the message invalid, which can prompt it to attempt election of a different coordinator.</para>
2471
2472               <para>Electing a new coordinator is appropriate if a timestamped message is expired due to actual interruption of
2473               communication, but not if a message appears expired only because the sender and recipient do not share the same time.
2474               For detailed examples of how unsynchronized clocks can destabilize Ubik operation, see <link linkend="HDRWQ105">How
2475               Ubik Uses Timestamped Messages</link>.</para>
2476             </listitem>
2477           </itemizedlist></para>
2478
2479         <indexterm>
2480           <primary>Ubik</primary>
2481
2482           <secondary>features summarized</secondary>
2483         </indexterm>
2484
2485         <indexterm>
2486           <primary>process</primary>
2487
2488           <secondary>lightweight Ubik</secondary>
2489         </indexterm>
2490
2491         <indexterm>
2492           <primary>Ubik</primary>
2493
2494           <secondary>server and client portions</secondary>
2495         </indexterm>
2496       </sect3>
2497
2498       <sect3 id="HDRWQ104">
2499         <title>How Ubik Operates Automatically</title>
2500
2501         <para>The following Ubik features help keep its maintenance requirements to a minimum: <itemizedlist>
2502             <listitem>
2503               <para>Ubik's server and client portions operate automatically.</para>
2504
2505               <para>Each database server process runs a lightweight process to call on the server portion of the Ubik library. It is
2506               common to refer to this lightweight process itself as Ubik. Because it is lightweight, the Ubik process does not
2507               appear in process listings such as those generated by the UNIX <emphasis role="bold">ps</emphasis> command.
2508               Client-side programs that need to read and change the databases directly call the subroutines in the Ubik library's
2509               client portion, rather than running a separate lightweight process. Examples of such programs are the <emphasis
2510               role="bold">klog</emphasis> command and the commands in the <emphasis role="bold">pts</emphasis> suite.</para>
2511             </listitem>
2512
2513             <listitem>
2514               <para>Ubik tracks database version numbers.</para>
2515
2516               <para>As the coordinator records a change to a database, it increments the database's version number. The version
2517               number makes it easy for the coordinator to determine if a site has the most recent version or not. The version number
2518               speeds the return to normal functioning after election of a new coordinator or when communication is restored after an
2519               outage, because it makes it easy to determine which site has the most current database and which need to be
2520               updated.</para>
2521             </listitem>
2522
2523             <listitem>
2524               <para>Ubik's use of timestamped messages guarantees that database copies are always synchronized during normal
2525               operation.</para>
2526
2527               <para>Replicating a database to increase data availability is pointless if all copies of the database are not the
2528               same. Inconsistent performance can result if clients receive different information depending on which copy of the
2529               database they access. As previously noted, Ubik sites constantly track the status of their peers by exchanging
2530               timestamped messages. For a detailed description, see <link linkend="HDRWQ105">How Ubik Uses Timestamped
2531               Messages</link>.</para>
2532             </listitem>
2533
2534             <listitem>
2535               <para>The ability to move the coordinator maximizes database availability.</para>
2536
2537               <para>Suppose, for example, that in a cell with three database server machines a network partition separates the two
2538               secondary sites from the coordinator. The coordinator retires because it is no longer in contact with a majority of
2539               the sites listed in the <emphasis role="bold">CellServDB</emphasis> file. The two sites on the other side of the
2540               partition can elect a new coordinator among themselves, and it can then accept database changes from clients. If the
2541               coordinator cannot move in this way, the database has to be read-only until the network partition is repaired. For a
2542               detailed description of Ubik's election procedure, see <link linkend="HDRWQ106">A Flexible Coordinator Boosts
2543               Availability</link>.</para>
2544             </listitem>
2545           </itemizedlist></para>
2546
2547         <indexterm>
2548           <primary>consistency guarantees</primary>
2549
2550           <secondary>administrative databases</secondary>
2551         </indexterm>
2552
2553         <indexterm>
2554           <primary>Ubik</primary>
2555
2556           <secondary>consistency guarantees</secondary>
2557         </indexterm>
2558
2559         <sect4 id="HDRWQ105">
2560           <title>How Ubik Uses Timestamped Messages</title>
2561
2562           <para>Ubik synchronizes the copies of a database by maintaining constant contact between the synchronization site and the
2563           secondary sites. The Ubik coordinator frequently sends a time-stamped <emphasis>guarantee</emphasis> message to each of
2564           the secondary sites. When the secondary site receives the message, it concludes that it is in contact with the
2565           coordinator. It considers its copy of the database to be valid until time <emphasis>T</emphasis>, which is usually 60
2566           seconds from the time the coordinator sent the message. In response, the secondary site returns a
2567           <emphasis>vote</emphasis> message that acknowledges the coordinator as valid until a certain time X, which is usually 120
2568           seconds in the future.</para>
2569
2570           <para>The coordinator sends guarantee messages more frequently than every <emphasis>T</emphasis> seconds, so that the
2571           expiration periods overlap. There is no danger of expiration unless a network partition or other outage actually
2572           interrupts communication. If the guarantee expires, the secondary site's copy of the database it not necessarily current.
2573           Nonetheless, the database server continues to service client requests. It is considered better for overall cell
2574           functioning that a secondary site remains accessible even if the information it is distributing is possibly out of date.
2575           Most of the AFS administrative databases do not change that frequently, in any case, and making a database inaccessible
2576           causes a timeout for clients that happen to access that copy.</para>
2577
2578           <para>As previously mentioned, Ubik's use of timestamped messages makes it vital to synchronize the clocks on database
2579           server machines. There are two ways that skewed clocks can interrupt normal Ubik functioning, depending on which clock is
2580           ahead of the others.</para>
2581
2582           <para>Suppose, for example, that the Ubik coordinator's clock is ahead of the secondary sites: the coordinator's clock
2583           says 9:35:30, but the secondary clocks say 9:31:30. The secondary sites send votes messages that acknowledge the
2584           coordinator as valid until 9:33:30. This is two minutes in the future according to the secondary clocks, but is already in
2585           the past from the coordinator's perspective. The coordinator concludes that it no longer has enough support to remain
2586           coordinator and forces election of a new coordinator. Election takes about three minutes, during which time no copy of the
2587           database accepts changes.</para>
2588
2589           <para>The opposite possibility is that a secondary site's clock (14:50:00) is ahead of the coordinator's (14:46:30). When
2590           the coordinator sends a guarantee message good until 14:47:30), it has already expired according to the secondary clock.
2591           Believing that it is out of contact with the coordinator, the secondary site stops sending votes for the coordinator and
2592           tries get itself elected as coordinator. This is appropriate if the coordinator has actually failed, but is inappropriate
2593           when there is no actual outage.</para>
2594
2595           <para>The attempt of a single secondary site to get elected as the new coordinator usually does not affect the performance
2596           of the other sites. As long as their clocks agree with the coordinator's, they ignore the other secondary site's request
2597           for votes and continue voting for the current coordinator. However, if enough of the secondary sites's clocks get ahead of
2598           the coordinator's, they can force election of a new coordinator even though the current one is actually working
2599           fine.</para>
2600
2601           <indexterm>
2602             <primary>Ubik</primary>
2603
2604             <secondary>election of coordinator</secondary>
2605           </indexterm>
2606
2607           <indexterm>
2608             <primary>coordinator (Ubik)</primary>
2609
2610             <secondary>election procedure described</secondary>
2611           </indexterm>
2612
2613           <indexterm>
2614             <primary>election of Ubik coordinator</primary>
2615           </indexterm>
2616
2617           <indexterm>
2618             <primary>flexible synchronization site (Ubik)</primary>
2619           </indexterm>
2620
2621           <indexterm>
2622             <primary>synchronization site (Ubik)</primary>
2623
2624             <secondary>flexibility</secondary>
2625           </indexterm>
2626
2627           <indexterm>
2628             <primary>Ubik</primary>
2629
2630             <secondary>majority defined</secondary>
2631           </indexterm>
2632
2633           <indexterm>
2634             <primary>majority</primary>
2635
2636             <secondary>defined for Ubik</secondary>
2637           </indexterm>
2638
2639           <indexterm>
2640             <primary>outages</primary>
2641
2642             <secondary>due to Ubik election</secondary>
2643           </indexterm>
2644
2645           <indexterm>
2646             <primary>system outages</primary>
2647
2648             <secondary>due to Ubik election</secondary>
2649           </indexterm>
2650         </sect4>
2651
2652         <sect4 id="HDRWQ106">
2653           <title>A Flexible Coordinator Boosts Availability</title>
2654
2655           <para>Ubik uses timestamped messages to determine when coordinator election is necessary, just as it does to keep the
2656           database copies synchronized. As long as the coordinator receives vote messages from a majority of the sites (it
2657           implicitly votes for itself), it is appropriate for it to continue as coordinator because it is successfully distributing
2658           database changes. A majority is defined as more than 50% of all database sites when there are an odd number of sites; with
2659           an even number of sites, the site with the lowest Internet address has an extra vote for breaking ties as necessary.If the
2660           coordinator is not receiving sufficient votes, it retires and the Ubik sites elect a new coordinator. This does not happen
2661           spontaneously, but only when the coordinator really fails or stops receiving a majority of the votes. The secondary sites
2662           have a built-in bias to continue voting for an existing coordinator, which prevents undue elections.</para>
2663
2664           <para>The election of the new coordinator is by majority vote. The Ubik subprocesses have a bias to vote for the site with
2665           the lowest Internet address, which helps it gather the necessary majority quicker than if all the sites were competing to
2666           receive votes themselves. During the election (which normally lasts less than three minutes), clients can read information
2667           from the database, but cannot make any changes.</para>
2668
2669           <para>Ubik's election procedure makes it possible for each database server process's coordinator to be on a different
2670           machine. For example, if the Ubik coordinators for all four processes start out on machine A and the Protection Server on
2671           machine A fails for some reason, then a different site (say machine B) must be elected as the new Protection Database Ubik
2672           coordinator. Machine B remains the coordinator for the Protection Database even after the Protection Server on machine A
2673           is working again. The failure of the Protection Server has no effect on the Authentication, Backup, or VL Servers, so
2674           their coordinators remain on machine A.</para>
2675         </sect4>
2676       </sect3>
2677     </sect2>
2678
2679     <sect2 id="HDRWQ107">
2680       <title>Backing Up and Restoring the Administrative Databases</title>
2681
2682       <para>The AFS administrative databases store information that is critical for AFS operation in your cell. If a database
2683       becomes corrupted due to a hardware failure or other problem on a database server machine, it likely to be difficult and
2684       time-consuming to recreate all of the information from scratch. To protect yourself against loss of data, back up the
2685       administrative databases to a permanent media, such as tape, on a regular basis. The recommended method is to use a standard
2686       local disk backup utility such as the UNIX <emphasis role="bold">tar</emphasis> command.</para>
2687
2688       <para>When deciding how often to back up a database, consider the amount of data that you are willing to recreate by hand if
2689       it becomes necessary to restore the database from a backup copy. In most cells, the databases differ quite a bit in how often
2690       and how much they change. Changes to the Authentication Database are probably the least frequent, and consist mostly of
2691       changed user passwords. Protection Database and VLDB changes are probably more frequent, as users add or delete groups and
2692       change group memberships, and as you and other administrators create or move volumes. The number and frequency of changes is
2693       probably greatest in the Backup Database, particularly if you perform backups every day.</para>
2694
2695       <para>The ease with which you can recapture lost changes also differs for the different databases: <itemizedlist>
2696           <listitem>
2697             <para>If regular users make a large proportion of the changes to the Authentication Database and Protection Database in
2698             your cell, then recovering them possibly requires a large amount of detective work and interviewing of users, assuming
2699             that they can even remember what changes they made at what time.</para>
2700           </listitem>
2701
2702           <listitem>
2703             <para>Recovering lost changes to the VLDB is more straightforward, because you can use the <emphasis role="bold">vos
2704             syncserv</emphasis> and <emphasis role="bold">vos syncvldb</emphasis> commands to correct any discrepancies between the
2705             VLDB and the actual state of volumes on server machines. Running these commands can be time-consuming, however.</para>
2706           </listitem>
2707
2708           <listitem>
2709             <para>The configuration information in the Backup Database (Tape Coordinator port offsets, volume sets and entries, the
2710             dump hierarchy, and so on) probably does not change that often, in which case it is not that hard to recover a few
2711             recent changes. In contrast, there are likely to be a large number of new dump records resulting from dump operations.
2712             You can recover these records by using the <emphasis role="bold">-dbadd</emphasis> argument to the <emphasis
2713             role="bold">backup scantape</emphasis> command, reading in information from the backup tapes themselves. This can take a
2714             long time and require numerous tape changes, however, depending on how much data you back up in your cell and how you
2715             append dumps. Furthermore, the <emphasis role="bold">backup scantape</emphasis> command is subject to several
2716             restrictions. The most basic is that it halts if it finds that an existing dump record in the database has the same dump
2717             ID number as a dump on the tape it is scanning. If you want to continue with the scanning operation, you must locate and
2718             remove the existing record from the database. For further discussion, see the <emphasis role="bold">backup
2719             scantape</emphasis> command's reference page in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
2720           </listitem>
2721         </itemizedlist></para>
2722
2723       <para>These differences between the databases possibly suggest backing up the database at different frequencies, ranging from
2724       every few days or weekly for the Backup Database to every few weeks for the Authentication Database. On the other hand, it is
2725       probably simpler from a logistical standpoint to back them all up at the same time (and frequently), particularly if tape
2726       consumption is not a major concern. Also, it is not generally necessary to keep backup copies of the databases for a long
2727       time, so you can recycle the tapes fairly frequently.</para>
2728
2729       <indexterm>
2730         <primary>administrative database</primary>
2731
2732         <secondary>backing up</secondary>
2733       </indexterm>
2734
2735       <indexterm>
2736         <primary>backing up</primary>
2737
2738         <secondary>administrative databases</secondary>
2739       </indexterm>
2740     </sect2>
2741
2742     <sect2 id="HDRWQ108">
2743       <title>To back up the administrative databases</title>
2744
2745       <orderedlist>
2746         <listitem>
2747           <para>Log in as the local superuser <emphasis role="bold">root</emphasis> on a database server machine that is not the
2748           synchronization site. The machine with the highest IP address is normally the best choice, since it is least likely to
2749           become the synchronization site in an election.</para>
2750         </listitem>
2751
2752         <listitem id="LIDBBK_SHUTDOWN">
2753           <para>Issue the <emphasis role="bold">bos shutdown</emphasis> command to shut down the
2754           relevant server process on the local machine. For a complete description of the command, see <link linkend="HDRWQ168">To
2755           stop processes temporarily</link>.</para>
2756
2757           <para>For the <emphasis role="bold">-instance</emphasis> argument, specify one or more database server process names
2758           (<emphasis role="bold">buserver</emphasis> for the Backup Server, <emphasis role="bold">kaserver</emphasis> for the
2759           Authentication Server, <emphasis role="bold">ptserver</emphasis> for the Protection Server, or <emphasis
2760           role="bold">vlserver</emphasis> for the Volume Location Server. Include the <emphasis role="bold">-localauth</emphasis>
2761           flag because you are logged in as the local superuser <emphasis role="bold">root</emphasis> but do not necessarily have
2762           administrative tokens.</para>
2763
2764           <programlisting>
2765    # <emphasis role="bold">bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-instance</emphasis> &lt;<replaceable>instances</replaceable>&gt;+ <emphasis
2766               role="bold">-localauth</emphasis> [<emphasis role="bold">-wait</emphasis>]
2767 </programlisting>
2768         </listitem>
2769
2770         <listitem>
2771           <para>Use a local disk backup utility, such as the UNIX <emphasis role="bold">tar</emphasis> command, to transfer one or
2772           more database files to tape. If the local database server machine does not have a tape device attached, use a remote copy
2773           command to transfer the file to a machine with a tape device, then use the <emphasis role="bold">tar</emphasis> command
2774           there.</para>
2775
2776           <para>The following command sequence backs up the complete contents of the <emphasis role="bold">/usr/afs/db</emphasis>
2777           directory</para>
2778
2779           <programlisting>
2780    # <emphasis role="bold">cd /usr/afs/db</emphasis>
2781    # <emphasis role="bold">tar cvf</emphasis>  tape_device <emphasis role="bold">.</emphasis>
2782 </programlisting>
2783
2784           <para>To back up individual database files, substitute their names for the period in the preceding <emphasis
2785           role="bold">tar</emphasis> command: <itemizedlist>
2786               <listitem>
2787                 <para><emphasis role="bold">bdb.DB0</emphasis> for the Backup Database</para>
2788               </listitem>
2789
2790               <listitem>
2791                 <para><emphasis role="bold">kaserver.DB0</emphasis> for the Authentication Database</para>
2792               </listitem>
2793
2794               <listitem>
2795                 <para><emphasis role="bold">prdb.DB0</emphasis> for the Protection Database</para>
2796               </listitem>
2797
2798               <listitem>
2799                 <para><emphasis role="bold">vldb.DB0</emphasis> for the VLDB</para>
2800               </listitem>
2801             </itemizedlist></para>
2802         </listitem>
2803
2804         <listitem>
2805           <para>Issue the <emphasis role="bold">bos start</emphasis> command to restart the server processes on the local machine.
2806           For a complete description of the command, see <link linkend="HDRWQ166">To start processes by changing their status flags
2807           to Run</link>. Provide the same values for the <emphasis role="bold">-instance</emphasis> argument as in Step <link
2808           linkend="LIDBBK_SHUTDOWN">2</link>, and the <emphasis role="bold">-localauth</emphasis> flag for the same reason.
2809           <programlisting>
2810    # <emphasis role="bold">bos start</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-instance</emphasis> &lt;<replaceable>server process name</replaceable>&gt;+ <emphasis
2811                 role="bold">-localauth</emphasis>
2812 </programlisting></para>
2813         </listitem>
2814       </orderedlist>
2815
2816       <indexterm>
2817         <primary>administrative database</primary>
2818
2819         <secondary>restoring</secondary>
2820       </indexterm>
2821
2822       <indexterm>
2823         <primary>restoring</primary>
2824
2825         <secondary>administrative databases</secondary>
2826       </indexterm>
2827     </sect2>
2828
2829     <sect2 id="HDRWQ109">
2830       <title>To restore an administrative database</title>
2831
2832       <orderedlist>
2833         <listitem>
2834           <para>Log in as the local superuser <emphasis role="bold">root</emphasis> on each database server machine in the
2835           cell.</para>
2836         </listitem>
2837
2838         <listitem id="LIDBREST_SHUTDOWN">
2839           <para>Working on one of the machines, issue the <emphasis role="bold">bos
2840           shutdown</emphasis> command once for each database server machine, to shut down the relevant server process on all of
2841           them. For a complete description of the command, see <link linkend="HDRWQ168">To stop processes temporarily</link>.</para>
2842
2843           <para>For the <emphasis role="bold">-instance</emphasis> argument, specify one or more database server process names
2844           (<emphasis role="bold">buserver</emphasis> for the Backup Server, <emphasis role="bold">kaserver</emphasis> for the
2845           Authentication Server, <emphasis role="bold">ptserver</emphasis> for the Protection Server, or <emphasis
2846           role="bold">vlserver</emphasis> for the Volume Location Server. Include the <emphasis role="bold">-localauth</emphasis>
2847           flag because you are logged in as the local superuser <emphasis role="bold">root</emphasis> but do not necessarily have
2848           administrative tokens.</para>
2849
2850           <programlisting>
2851    # <emphasis role="bold">bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-instance</emphasis> &lt;<replaceable>instances</replaceable>&gt;+ <emphasis
2852               role="bold">-localauth</emphasis> [<emphasis role="bold">-wait</emphasis>]
2853 </programlisting>
2854         </listitem>
2855
2856         <listitem>
2857           <para>Remove the database from each database server machine, by issuing the following commands on each one.
2858           <programlisting>
2859    # <emphasis role="bold">cd /usr/afs/db</emphasis>
2860 </programlisting></para>
2861
2862           <para>For the Backup Database:</para>
2863
2864           <programlisting>
2865    # <emphasis role="bold">rm bdb.DB0</emphasis>
2866    # <emphasis role="bold">rm bdb.DBSYS1</emphasis>
2867 </programlisting>
2868
2869           <para>For the Authentication Database:</para>
2870
2871           <programlisting>
2872    # <emphasis role="bold">rm kaserver.DB0</emphasis>
2873    # <emphasis role="bold">rm kaserver.DBSYS1</emphasis>
2874 </programlisting>
2875
2876           <para>For the Protection Database:</para>
2877
2878           <programlisting>
2879    # <emphasis role="bold">rm prdb.DB0</emphasis>
2880    # <emphasis role="bold">rm prdb.DBSYS1</emphasis>
2881 </programlisting>
2882
2883           <para>For the VLDB:</para>
2884
2885           <programlisting>
2886    # <emphasis role="bold">rm vldb.DB0</emphasis>
2887    # <emphasis role="bold">rm vldb.DBSYS1</emphasis>
2888 </programlisting>
2889         </listitem>
2890
2891         <listitem>
2892           <para>Using the local disk backup utility that you used to back up the database, copy the most recently backed-up version
2893           of it to the appropriate file on the database server machine with the lowest IP address. The following is an appropriate
2894           <emphasis role="bold">tar</emphasis> command if the synchronization site has a tape device attached: <programlisting>
2895    # <emphasis role="bold">cd /usr/afs/db</emphasis>
2896    # <emphasis role="bold">tar xvf</emphasis> tape_device  database_file
2897 </programlisting></para>
2898
2899           <para>where <emphasis>database_file</emphasis> is one of the following: <itemizedlist>
2900               <listitem>
2901                 <para><emphasis role="bold">bdb.DB0</emphasis> for the Backup Database</para>
2902               </listitem>
2903
2904               <listitem>
2905                 <para><emphasis role="bold">kaserver.DB0</emphasis> for the Authentication Database</para>
2906               </listitem>
2907
2908               <listitem>
2909                 <para><emphasis role="bold">prdb.DB0</emphasis> for the Protection Database</para>
2910               </listitem>
2911
2912               <listitem>
2913                 <para><emphasis role="bold">vldb.DB0</emphasis> for the VLDB</para>
2914               </listitem>
2915             </itemizedlist></para>
2916         </listitem>
2917
2918         <listitem>
2919           <para>Working on one of the machines, issue the <emphasis role="bold">bos start</emphasis> command to restart the server
2920           process on each of the database server machines in turn. Start with the machine with the lowest IP address, which becomes
2921           the synchronization site for the Backup Database. Wait for it to establish itself as the synchronization site before
2922           repeating the command to restart the process on the other database server machines. For a complete description of the
2923           command, see <link linkend="HDRWQ166">To start processes by changing their status flags to Run</link>. Provide the same
2924           values for the <emphasis role="bold">-instance</emphasis> argument as in Step <link linkend="LIDBREST_SHUTDOWN">2</link>,
2925           and the <emphasis role="bold">-localauth</emphasis> flag for the same reason. <programlisting>
2926    # <emphasis role="bold">bos start</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-instance</emphasis>  &lt;<replaceable>server process name</replaceable>&gt;+  <emphasis
2927                 role="bold">-localauth</emphasis>
2928 </programlisting></para>
2929         </listitem>
2930
2931         <listitem>
2932           <para>If the database has changed since you last backed it up, issue the appropriate commands from the instructions in the
2933           indicated sections to recreate the information in the restored database. If issuing <emphasis role="bold">pts</emphasis>
2934           commands, you must first obtain administrative tokens. The <emphasis role="bold">backup</emphasis> and <emphasis
2935           role="bold">vos</emphasis> commands accept the <emphasis role="bold">-localauth</emphasis> flag if you are logged in as
2936           the local superuser <emphasis role="bold">root</emphasis>, so you do not need administrative tokens. The Authentication
2937           Server always performs a separate authentication anyway, so you only need to include the <emphasis
2938           role="bold">-admin</emphasis> argument if issuing <emphasis role="bold">kas</emphasis> commands. <itemizedlist>
2939               <listitem>
2940                 <para>To define or remove volume sets and volume entries in the Backup Database, see <link
2941                 linkend="HDRWQ265">Defining and Displaying Volume Sets and Volume Entries</link>.</para>
2942               </listitem>
2943
2944               <listitem>
2945                 <para>To edit the dump hierarchy in the Backup Database, see <link linkend="HDRWQ267">Defining and Displaying the
2946                 Dump Hierarchy</link>.</para>
2947               </listitem>
2948
2949               <listitem>
2950                 <para>To define or remove Tape Coordinator port offset entries in the Backup Database, see <link
2951                 linkend="HDRWQ261">Configuring Tape Coordinator Machines and Tape Devices</link>.</para>
2952               </listitem>
2953
2954               <listitem>
2955                 <para>To restore dump records in the Backup Database, see <link linkend="HDRWQ305">To scan the contents of a
2956                 tape</link>.</para>
2957               </listitem>
2958
2959               <listitem>
2960                 <para>To recreate Authentication Database entries or password changes for users, see the appropriate section of
2961                 <link linkend="HDRWQ491">Administering User Accounts</link>.</para>
2962               </listitem>
2963
2964               <listitem>
2965                 <para>To recreate Protection Database entries or group membership information, see the appropriate section of <link
2966                 linkend="HDRWQ531">Administering the Protection Database</link>.</para>
2967               </listitem>
2968
2969               <listitem>
2970                 <para>To synchronize the VLDB with volume headers, see <link linkend="HDRWQ227">Synchronizing the VLDB and Volume
2971                 Headers</link>.</para>
2972               </listitem>
2973             </itemizedlist></para>
2974         </listitem>
2975       </orderedlist>
2976
2977       <indexterm>
2978         <primary>installing</primary>
2979
2980         <secondary>server process binaries, about</secondary>
2981       </indexterm>
2982
2983       <indexterm>
2984         <primary>server process binaries</primary>
2985
2986         <secondary>installing</secondary>
2987       </indexterm>
2988
2989       <indexterm>
2990         <primary>BOS Server</primary>
2991
2992         <secondary>maintainer of server process binaries</secondary>
2993       </indexterm>
2994
2995       <indexterm>
2996         <primary>server process</primary>
2997
2998         <secondary>binaries</secondary>
2999
3000         <see>server process binaries</see>
3001       </indexterm>
3002
3003       <indexterm>
3004         <primary>directories (server)</primary>
3005
3006         <secondary>/usr/afs/bin</secondary>
3007       </indexterm>
3008
3009       <indexterm>
3010         <primary>server machine</primary>
3011
3012         <secondary>need for consistent version of software</secondary>
3013       </indexterm>
3014     </sect2>
3015   </sect1>
3016
3017   <sect1 id="HDRWQ110">
3018     <title>Installing Server Process Software</title>
3019
3020     <para>This section explains how to install new server process binaries on file server machines, how to revert to a previous
3021     version if the current version is not working properly, and how to install new disks to house AFS volumes on a file server
3022     machine.</para>
3023
3024     <para>The most frequent reason to replace a server process's binaries is to upgrade AFS to a new version. In general,
3025     installation instructions accompany the updated software, but this chapter provides an additional reference.</para>
3026
3027     <para>Each AFS server machine must store the server process binaries in a local disk directory, called <emphasis
3028     role="bold">/usr/afs/bin</emphasis> by convention. For predictable system performance, it is best that all server machines run
3029     the same build level, or at least the same version, of the server software. For instructions on checking AFS build level, see
3030     <link linkend="HDRWQ117">Displaying A Binary File's Build Level</link>.</para>
3031
3032     <para>The Update Server makes it easy to distribute a consistent version of software to all server machines. You designate one
3033     server machine of each system type as the <emphasis>binary distribution machine</emphasis> by running the server portion of the
3034     Update Server (<emphasis role="bold">upserver</emphasis> process) on it. All other server machines of that system type run the
3035     client portion of the Update Server (<emphasis role="bold">upclientbin</emphasis> process) to retrieve updated software from the
3036     binary distribution machine. The <emphasis>OpenAFS Quick Beginnings</emphasis> explains how to install the appropriate
3037     processes. For more on binary distribution machines, see <link linkend="HDRWQ93">Binary Distribution Machines</link>.</para>
3038
3039     <para>When you use the Update Server, you install new binaries on binary distribution machines only. If you install binaries
3040     directly on a machine that is running the <emphasis role="bold">upclientbin</emphasis> process, they are overwritten the next
3041     time the process compares the contents of the local <emphasis role="bold">/usr/afs/bin</emphasis> directory to the contents on
3042     the system control machine, by default within five minutes.</para>
3043
3044     <para>The following instructions explain how to use the appropriate commands from the <emphasis role="bold">bos</emphasis> suite
3045     to install and uninstall server binaries.</para>
3046
3047     <indexterm>
3048       <primary>installing</primary>
3049
3050       <secondary>server binaries</secondary>
3051     </indexterm>
3052
3053     <indexterm>
3054       <primary>server process binaries</primary>
3055
3056       <secondary>installing</secondary>
3057     </indexterm>
3058
3059     <indexterm>
3060       <primary>command suite</primary>
3061
3062       <secondary>binaries</secondary>
3063
3064       <tertiary>installing</tertiary>
3065     </indexterm>
3066
3067     <indexterm>
3068       <primary>file server machine</primary>
3069
3070       <secondary>installing command and process binaries</secondary>
3071     </indexterm>
3072
3073     <indexterm>
3074       <primary>server process</primary>
3075
3076       <secondary>restarting for changed binaries</secondary>
3077     </indexterm>
3078
3079     <sect2 id="HDRWQ111">
3080       <title>Installing New Binaries</title>
3081
3082       <para>An AFS server process does not automatically switch to a new process binary file as soon as it is installed in the
3083       <emphasis role="bold">/usr/afs/bin</emphasis> directory. The process continues to use the previous version of the binary file
3084       until it (the process) next restarts. By default, the BOS Server restarts processes for which there are new binary files every
3085       day at 5:00 a.m., as specified in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file. To display or change
3086       this <emphasis>binary restart time</emphasis>, use the <emphasis role="bold">bos getrestart</emphasis> and <emphasis
3087       role="bold">bos setrestart</emphasis> commands, as described in <link linkend="HDRWQ171">Setting the BOS Server's Restart
3088       Times</link>.</para>
3089
3090       <para>You can force the server machine to start using new server process binaries immediately by issuing the <emphasis
3091       role="bold">bos restart</emphasis> command as described in the following instructions.</para>
3092
3093       <para>You do not need to restart processes when you install new command suite binaries. The new binary is invoked
3094       automatically the next time a command from the suite is issued.</para>
3095
3096       <indexterm>
3097         <primary>file extension</primary>
3098
3099         <secondary>.BAK</secondary>
3100       </indexterm>
3101
3102       <indexterm>
3103         <primary>file extension</primary>
3104
3105         <secondary>.OLD</secondary>
3106       </indexterm>
3107
3108       <indexterm>
3109         <primary>BAK version of binary file</primary>
3110
3111         <secondary>created by bos install command</secondary>
3112       </indexterm>
3113
3114       <indexterm>
3115         <primary>OLD version of binary file</primary>
3116
3117         <secondary>created by bos install command</secondary>
3118       </indexterm>
3119
3120       <indexterm>
3121         <primary>saving</primary>
3122
3123         <secondary>previous version of server binaries</secondary>
3124       </indexterm>
3125
3126       <para>When you use the <emphasis role="bold">bos install</emphasis> command, the BOS Server automatically saves the current
3127       version of a binary file by adding a <emphasis role="bold">.BAK</emphasis> extension to its name. It renames the current
3128       <emphasis role="bold">.BAK</emphasis> version, if any, to the <emphasis role="bold">.OLD</emphasis> version, if there is no
3129       <emphasis role="bold">.OLD</emphasis> version already. If there is a current <emphasis role="bold">.OLD</emphasis> version,
3130       the current <emphasis role="bold">.BAK</emphasis> version must be at least seven days old to replace it.</para>
3131
3132       <para>It is best to store AFS binaries in the <emphasis role="bold">/usr/afs/bin</emphasis> directory, because that is the
3133       only directory the BOS Server automatically checks for new binaries. You can, however, use the <emphasis role="bold">bos
3134       install</emphasis> command's <emphasis role="bold">-dir</emphasis> argument to install non-AFS binaries into other directories
3135       on a server machine's local disk. See the command's reference page in the <emphasis>OpenAFS Administration
3136       Reference</emphasis> for further information.</para>
3137
3138       <indexterm>
3139         <primary>bos commands</primary>
3140
3141         <secondary>install</secondary>
3142       </indexterm>
3143
3144       <indexterm>
3145         <primary>commands</primary>
3146
3147         <secondary>bos install</secondary>
3148       </indexterm>
3149     </sect2>
3150
3151     <sect2 id="Header_130">
3152       <title>To install new server binaries</title>
3153
3154       <orderedlist>
3155         <listitem>
3156           <para>Verify that you are listed in the <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file. If necessary, issue
3157           the <emphasis role="bold">bos listusers</emphasis> command, which is fully described in <link linkend="HDRWQ593">To
3158           display the users in the UserList file</link>. <programlisting>
3159    % <emphasis role="bold">bos listusers</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
3160 </programlisting></para>
3161         </listitem>
3162
3163         <listitem>
3164           <para>Verify that the binaries are available in the source directory from which you are installing them. If the machine is
3165           also an AFS client, you can retrieve the binaries from a central directory in AFS. Otherwise, you can obtain them directly
3166           from the AFS distribution media, from a local disk directory where you previously installed them, or from a remote machine
3167           using a transfer utility such as the <emphasis role="bold">ftp</emphasis> command.</para>
3168         </listitem>
3169
3170         <listitem id="LIWQ112">
3171           <para>Issue the <emphasis role="bold">bos install</emphasis> command for the binary distribution
3172           machine. (If you have forgotten which machine is performing that role, see <link linkend="HDRWQ97">To locate the binary
3173           distribution machine for a system type</link>.) <programlisting>
3174    % <emphasis role="bold">bos install</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>files to install</replaceable>&gt;+
3175 </programlisting></para>
3176
3177           <para>where <variablelist>
3178               <varlistentry>
3179                 <term><emphasis role="bold">i</emphasis></term>
3180
3181                 <listitem>
3182                   <para>Is the shortest acceptable abbreviation of <emphasis role="bold">install</emphasis>.</para>
3183                 </listitem>
3184               </varlistentry>
3185
3186               <varlistentry>
3187                 <term><emphasis role="bold">machine name</emphasis></term>
3188
3189                 <listitem>
3190                   <para>Names the binary distribution machine.</para>
3191                 </listitem>
3192               </varlistentry>
3193
3194               <varlistentry>
3195                 <term><emphasis role="bold">files to install</emphasis></term>
3196
3197                 <listitem>
3198                   <para>Names each binary file to install into the local <emphasis role="bold">/usr/afs/bin</emphasis> directory.
3199                   Partial pathnames are interpreted relative to the current working directory. The last element in each pathname
3200                   (the filename itself) matches the name of the file it is replacing, such as <emphasis
3201                   role="bold">bosserver</emphasis> or <emphasis role="bold">volserver</emphasis> for server processes, <emphasis
3202                   role="bold">bos</emphasis> or <emphasis role="bold">vos</emphasis> for commands.</para>
3203
3204                   <para>Each AFS server process other than the <emphasis role="bold">fs</emphasis> process uses a single binary
3205                   file. The <emphasis role="bold">fs</emphasis> process uses three binary files: <emphasis
3206                   role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis>, and <emphasis
3207                   role="bold">salvager</emphasis>. Installing a new version of one component does not necessarily mean that you need
3208                   to replace all three.</para>
3209                 </listitem>
3210               </varlistentry>
3211             </variablelist></para>
3212         </listitem>
3213
3214         <listitem>
3215           <para>Repeat Step <link linkend="LIWQ112">3</link> for each binary distribution machine.</para>
3216         </listitem>
3217
3218         <listitem>
3219           <para><emphasis role="bold">(Optional)</emphasis> If you want to restart processes to use the new binaries immediately,
3220           wait until the <emphasis role="bold">upclientbin</emphasis> process retrieves them from the binary distribution machine.
3221           You can verify the timestamps on binary files by using the <emphasis role="bold">bos getdate</emphasis> command as
3222           described in <link linkend="HDRWQ115">Displaying Binary Version Dates</link>. When the binary files are available on each
3223           server machine, issue the <emphasis role="bold">bos restart</emphasis> command, for which complete instructions appear in
3224           <link linkend="HDRWQ170">Stopping and Immediately Restarting Processes</link>.</para>
3225
3226           <para>If you are working on an AFS client machine, it is a wise precaution to have a copy of the <emphasis
3227           role="bold">bos</emphasis> command suite binaries on the local disk before restarting server processes. In the
3228           conventional configuration, the <emphasis role="bold">/usr/afsws/bin</emphasis> directory that houses the <emphasis
3229           role="bold">bos</emphasis> command binary on client machines is a symbolic link into AFS, which conserves local disk
3230           space. However, restarting certain processes (particularly the database server processes) can make the AFS filespace
3231           inaccessible, particularly if a problem arises during the restart. Having a local copy of the <emphasis
3232           role="bold">bos</emphasis> binary enables you to uninstall or reinstall process binaries or restart processes even in this
3233           case. Use the <emphasis role="bold">cp</emphasis> command to copy the <emphasis role="bold">bos</emphasis> command binary
3234           from the <emphasis role="bold">/usr/afsws/bin</emphasis> directory to a local directory such as <emphasis
3235           role="bold">/tmp</emphasis>.</para>
3236
3237           <para>Restarting a process causes a service outage. It is best to perform the restart at times of low system usage if
3238           possible.</para>
3239
3240           <programlisting>
3241    % <emphasis role="bold">bos restart</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>instances</replaceable>&gt;+
3242 </programlisting>
3243         </listitem>
3244       </orderedlist>
3245
3246       <indexterm>
3247         <primary>uninstalling</primary>
3248
3249         <secondary>server process and command suite binaries</secondary>
3250       </indexterm>
3251
3252       <indexterm>
3253         <primary>reverting</primary>
3254