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