man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / bos_addhost.pod
1 =head1 NAME
2
3 bos addhost - Adds a database server machine to the CellServDB file
4
5 =head1 SYNOPSIS
6
7 B<bos addhost> B<-server> <I<machine name>> B<-host> <I<host name>>+
8     [B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
9
10 B<bos addh> B<-s> <I<machine name>> B<-ho> <I<host name>>+
11     [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-he>]
12
13 =head1 DESCRIPTION
14
15 The B<bos addhost> command adds an entry for each database server machine
16 specified with the B<-host> argument to the F</usr/afs/etc/CellServDB>
17 file on the machine named by the B<-server> argument.
18
19 =head1 CAUTIONS
20
21 After executing this command (and waiting for the Update Server to
22 propagate the changes, if it is used), restart the database server
23 processes on all database server machines to force election of a quorum
24 that includes the new set of machines listed in the
25 F</usr/afs/etc/CellServDB> file. The I<IBM AFS Quick Beginnings> explains
26 in more detail how to add and remove database server machines.
27
28 It is best to maintain a one-to-one mapping between hostnames and IP
29 addresses on a multihomed database server machine (this is actually the
30 conventional configuration for any AFS machine). The BOS Server uses the
31 gethostbyname() routine to obtain the IP address associated with the
32 hostname specified by the B<-host> argument. If there is more than one
33 address, the BOS Server records in the F<CellServDB> entry the one that
34 appears first in the list of addresses returned by the routine. The
35 routine possibly returns addresses in a different order on different
36 machines, which can create inconsistency.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-server> <I<machine name>>
43
44 Identifies the server machine on which to change the
45 F</usr/afs/etc/CellServDB> file. Identify the machine by IP address or its
46 host name (either fully-qualified or abbreviated unambiguously). For
47 details, see L<bos(8)>.
48
49 In cells that use the Update Server to distribute the contents of the
50 F</usr/afs/etc> directory, it is conventional to specify only the system
51 control machine as a value for the B<-server> argument. Otherwise, repeat
52 the command for each file server machine. For further discussion, see
53 L<bos(8)>.
54
55 =item B<-host> <I<host name>>+
56
57 Specifies the fully-qualified host name (such as C<db1.abc.com>) of each
58 database server machine to register in the F<CellServDB> file.
59
60 =item B<-cell> <I<cell name>>
61
62 Names the cell in which to run the command. Do not combine this
63 argument with the B<-localauth> flag. For more details, see L<bos(8)>.
64
65 =item B<-noauth>
66
67 Assigns the unprivileged identity C<anonymous> to the issuer. Do not combine
68 this flag with the B<-localauth> flag. For more details, see L<bos(8)>.
69
70 =item B<-localauth>
71
72 Constructs a server ticket using a key from the local
73 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
74 ticket to the BOS Server during mutual authentication. Do not combine this
75 flag with the B<-cell> or B<-noauth> options. For more details, see
76 L<bos(8)>.
77
78 =item B<-help>
79
80 Prints the online help for this command. All other valid options are
81 ignored.
82
83 =back
84
85 =head1 EXAMPLES
86
87 The following command adds the database server machines C<db2.abc.com> and
88 C<db3.abc.com> to the F</usr/afs/etc/CellServDB> file on the machine
89 C<fs1.abc.com> (the system control machine).
90
91    % bos addhost -server fs1.abc.com -host db2.abc.com db3.abc.com
92
93 =head1 PRIVILEGE REQUIRED
94
95 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
96 machine named by the B<-server> argument, or must be logged onto a server
97 machine as the local superuser C<root> if the B<-localauth> flag is
98 included.
99
100 =head1 SEE ALSO
101
102 L<CellServDB(5)>,
103 L<KeyFile(5)>,
104 L<UserList(5)>,
105 L<bos(8)>,
106 L<bos_listhosts(8)>,
107 L<bos_removehost(8)>
108
109 I<IBM AFS Quick Beginnings>
110
111 =head1 COPYRIGHT
112
113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
114
115 This documentation is covered by the IBM Public License Version 1.0.  It was
116 converted from HTML to POD by software written by Chas Williams and Russ
117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.