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