openafs/doc/man-pages/pod8/bos_addhost.pod
Russ Allbery 5f70221b2c Remove references to IBM AFS
Change references to the documentation sets that we still ship to
reference the OpenAFS manuals instead of the IBM AFS manuals.  Remove
references to the IBM AFS/DFS Migration documentation, since that
doesn't appear to be available anywhere any more, replacing them where
relevant to more generic references to the DFS documentation.  Add
links to docs.openafs.org for mentions of the manuals in SEE ALSO, and
standardize on one link format.  Replace a few references to the IBM
AFS Release Notes with the actual information in those notes, or drop
the reference if it doesn't seem particularly useful.

Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7
Reviewed-on: http://gerrit.openafs.org/2031
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 12:05:45 -07:00

125 lines
4.1 KiB
Plaintext

=head1 NAME
bos_addhost - Adds a database server machine to the CellServDB file
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos addhost> S<<< B<-server> <I<machine name>> >>> S<<< B<-host> <I<host name>>+ >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos addh> S<<< B<-s> <I<machine name>> >>> S<<< B<-ho> <I<host name>>+ >>>
S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-he>]
=for html
</div>
=head1 DESCRIPTION
The B<bos addhost> command adds an entry for each database server machine
specified with the B<-host> argument to the F</usr/afs/etc/CellServDB>
file on the machine named by the B<-server> argument.
=head1 CAUTIONS
After executing this command (and waiting for the Update Server to
propagate the changes, if it is used), restart the database server
processes on all database server machines to force election of a quorum
that includes the new set of machines listed in the
F</usr/afs/etc/CellServDB> file. The I<OpenAFS Quick Start Guide> explains
in more detail how to add and remove database server machines.
It is best to maintain a one-to-one mapping between hostnames and IP
addresses on a multihomed database server machine (this is actually the
conventional configuration for any AFS machine). The BOS Server uses the
gethostbyname() routine to obtain the IP address associated with the
hostname specified by the B<-host> argument. If there is more than one
address, the BOS Server records in the F<CellServDB> entry the one that
appears first in the list of addresses returned by the routine. The
routine possibly returns addresses in a different order on different
machines, which can create inconsistency.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Identifies the server machine on which to change the
F</usr/afs/etc/CellServDB> file. Identify the machine by IP address or its
host name (either fully-qualified or abbreviated unambiguously). For
details, see L<bos(8)>.
In cells that use the Update Server to distribute the contents of the
F</usr/afs/etc> directory, it is conventional to specify only the system
control machine as a value for the B<-server> argument. Otherwise, repeat
the command for each file server machine. For further discussion, see
L<bos(8)>.
=item B<-host> <I<host name>>+
Specifies the fully-qualified host name (such as C<db1.abc.com>) of each
database server machine to register in the F<CellServDB> file.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this
argument with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not combine
this flag with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the B<-cell> or B<-noauth> options. For more details, see
L<bos(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command adds the database server machines C<db2.abc.com> and
C<db3.abc.com> to the F</usr/afs/etc/CellServDB> file on the machine
C<fs1.abc.com> (the system control machine).
% bos addhost -server fs1.abc.com -host db2.abc.com db3.abc.com
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine named by the B<-server> argument, or must be logged onto a server
machine as the local superuser C<root> if the B<-localauth> flag is
included.
=head1 SEE ALSO
L<CellServDB(5)>,
L<KeyFile(5)>,
L<UserList(5)>,
L<bos(8)>,
L<bos_listhosts(8)>,
L<bos_removehost(8)>
The I<OpenAFS Quick Start Guide> at
L<http://docs.openafs.org/QuickStartUnix/>.
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.