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