openafs/doc/man-pages/pod8/bos_listhosts.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

119 lines
3.2 KiB
Plaintext

=head1 NAME
bos listhosts - Displays the contents of the /usr/afs/etc/CellServDB file
=head1 SYNOPSIS
B<bos listhosts -server> <I<machine name>> [-cell <I<cell name>>]
[B<-noauth>] [B<-localauth>] [B<-help>]
B<bos listh -s> <I<machine name>> [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [-h]
B<bos getcell -server> <I<machine name>> [-cell <I<cell name>>]
[B<-noauth>] [B<-localauth>] [B<-help>]
B<bos getc -s> <I<machine name>> [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [-h]
=head1 DESCRIPTION
The bos listhosts command formats and displays the list of a
cell's database server machines from the
B</usr/afs/etc/CellServDB> file on the server machine named by the
B<-server> argument.
To alter the list of machines, use the B<bos addhost> and bos
removehost commands.
=head1 OPTIONS
=over 4
=item -server
>
Indicates the server machine from which to display the
B</usr/afs/etc/CellServDB> file. Identify the machine by IP
address or its host name (either fully-qualified or abbreviated
unambiguously). For details, see the introductory reference page for
the B<bos> command suite.
For consistent performance in the cell, the output must be the same on
every server machine. The B<bos addhost> reference page
explains how to keep the machines synchronized.
=item -cell
>
Names the cell in which to run the command. Do not combine this
argument with the B<-localauth> flag. For more details, see the
introductory B<bos> reference page.
=item -noauth
>
Assigns the unprivileged identity anonymous to the
issuer. Do not combine this flag with the B<-localauth>
flag. For more details, see the introductory B<bos> reference
page.
=item -localauth
>
Constructs a server ticket using a key from the local
B</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 the introductory
B<bos> reference page.
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 OUTPUT
The first line of the output names the cell to which the server machine
belongs. Each of the following lines names a database server machine
for that cell.
The C<Host> number assigned to each database server machine is for
server-internal use only and is not the same as, nor necessarily related to,
the machine's IP address. The BOS Server assigned it as part of
performing the B<bos addhost> command.
=head1 EXAMPLES
The following command displays the database server machines listed in the
B</usr/afs/etc/CellServDB> file on the machine
B<fs7.abc.com>.
% bos listhosts fs7.abc.com
Cell name is abc.com
Host 1 is db1.abc.com
Host 2 is db2.abc.com
Host 3 is db3.abc.com
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<CellServDB (server version)(1)>
L<KeyFile(1)>,
L<bos(1)>,
L<bos_addhost(1)>,
L<bos_removehost(1)>
=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.