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