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