man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / bos_listhosts.pod
1 =head1 NAME
2
3 bos listhosts - Displays the contents of the CellServDB file
4
5 =head1 SYNOPSIS
6
7 B<bos listhosts> B<-server> <I<machine name>> [B<-cell> <I<cell name>>]  
8     [B<-noauth>] [B<-localauth>] [B<-help>]
9
10 B<bos listh> B<-s> <I<machine name>> [B<-c> <I<cell name>>] [B<-n>]
11     [B<-l>]  [-h]
12
13 B<bos getcell> B<-server> <I<machine name>> [B<-cell> <I<cell name>>]  
14     [B<-noauth>] [B<-localauth>] [B<-help>]
15     
16 B<bos getc> B<-s> <I<machine name>> [B<-c> <I<cell name>>] [B<-n>]
17     [B<-l>] [-h]
18
19 =head1 DESCRIPTION
20
21 The B<bos listhosts> command formats and displays the list of a cell's
22 database server machines from the F</usr/afs/etc/CellServDB> file on the
23 server machine named by the B<-server> argument.
24
25 To alter the list of machines, use the B<bos addhost> and B<bos
26 removehost> commands.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-server> <I<machine name>>
33
34 Indicates the server machine from which to display the
35 F</usr/afs/etc/CellServDB> file. Identify the machine by IP address or its
36 host name (either fully-qualified or abbreviated unambiguously). For
37 details, see L<bos(8)>.
38
39 For consistent performance in the cell, the output must be the same on
40 every server machine. The B<bos addhost> reference page explains how to
41 keep the machines synchronized.
42
43 =item B<-cell> <I<cell name>>
44
45 Names the cell in which to run the command. Do not combine this argument
46 with the B<-localauth> flag. For more details, see L<bos(8)>.
47
48 =item B<-noauth>
49
50 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
51 combine this flag with the B<-localauth> flag. For more details, see
52 L<bos(8)>.
53
54 =item B<-localauth>
55
56 Constructs a server ticket using a key from the local
57 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
58 ticket to the BOS Server during mutual authentication. Do not combine this
59 flag with the B<-cell> or B<-noauth> options. For more details, see
60 L<bos(8)>.
61
62 =item B<-help>
63
64 Prints the online help for this command. All other valid options are
65 ignored.
66
67 =back
68
69 =head1 OUTPUT
70
71 The first line of the output names the cell to which the server machine
72 belongs. Each of the following lines names a database server machine for
73 that cell.
74
75 The C<Host> number assigned to each database server machine is for
76 server-internal use only and is not the same as, nor necessarily related
77 to, the machine's IP address. The BOS Server assigned it as part of
78 performing the B<bos addhost> command.
79
80 =head1 EXAMPLES
81
82 The following command displays the database server machines listed in the
83 F</usr/afs/etc/CellServDB> file on the machine C<fs7.abc.com>.
84
85    % bos listhosts fs7.abc.com
86    Cell name is abc.com
87        Host 1 is db1.abc.com
88        Host 2 is db2.abc.com
89        Host 3 is db3.abc.com
90
91 =head1 PRIVILEGE REQUIRED
92
93 None
94
95 =head1 SEE ALSO
96
97 L<CellServDB(5)>,
98 L<KeyFile(5)>,
99 L<bos(8)>,
100 L<bos_addhost(8)>,
101 L<bos_removehost(8)>
102
103 =head1 COPYRIGHT
104
105 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
106
107 This documentation is covered by the IBM Public License Version 1.0.  It was
108 converted from HTML to POD by software written by Chas Williams and Russ
109 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.