pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / bos_listhosts.pod
1 =head1 NAME
2
3 bos listhosts - Displays the contents of the B</usr/afs/etc/CellServDB> file
4
5 =head1 SYNOPSIS
6
7 bos listhosts B<-server> I<machine name>  [B<-cell> I<cell name>]
8 [B<-noauth>]  [B<-localauth>]  [B<-help>]
9
10 bos listh B<-s> I<machine name>  [B<-c> I<cell name>]  [B<-n>]  [B<-l>]  [B<-h>]
11
12 bos getcell B<-server> I<machine name>  [B<-cell> I<cell name>]
13 [B<-noauth>]  [B<-localauth>]  [B<-help>]
14
15 bos getc B<-s> I<machine name>  [B<-c> I<cell name>]  [B<-n>]  [B<-l>]  [B<-h>]
16
17 =head1 DESCRIPTION
18
19 The C<bos listhosts> command formats and displays the list of a cell's
20 database server machines from the B</usr/afs/etc/CellServDB> file on the
21 server machine named by the B<-server> argument.
22
23 To alter the list of machines, use the C<bos addhost> and C<bos removehost>
24 commands.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-server> I<machine name>
31
32 Indicates the server machine from which to display the
33 B</usr/afs/etc/CellServDB> file. Identify the machine by IP
34 address or its host name (either fully-qualified or abbreviated
35 unambiguously). For details, see the introductory reference
36 page for the C<bos> command suite.
37
38 For consistent performance in the cell, the output must be the
39 same on every server machine. The L<bos_addhost(1)> reference page
40 explains how to keep the machines synchronized.
41
42 =item B<-cell> I<cell name>
43
44 Names the cell in which to run the command. Do not combine this
45 argument with the B<-localauth> flag. For more details, see the
46 introductory L<bos(1)> reference page.
47
48 =item B<-noauth>
49
50 Assigns the unprivileged identity B<anonymous> to the issuer. Do
51 not combine this flag with the B<-localauth> flag. For more
52 details, see the introductory L<bos(1)> reference page.
53
54 =item B<-localauth>
55
56 Constructs a server ticket using a key from the local
57 B</usr/afs/etc/KeyFile> file. The C<bos> command interpreter presents
58 the ticket to the BOS Server during mutual authentication. Do
59 not combine this flag with the B<-cell> or B<-noauth> options. For
60 more details, see the introductory L<bos(1)> reference page.
61
62 =item B<-help>
63
64 Prints the online help for this command. All other valid
65 options are ignored.
66
67 =back
68
69 =head1 OUTPUT
70
71 The first line of the output names the cell to which the server
72 machine belongs. Each of the following lines names a database server
73 machine for that cell.
74
75 The Host number assigned to each database server machine is for
76 server-internal use only and is not the same as, nor necessarily
77 related to, the machine's IP address. The BOS Server assigned it as
78 part of performing the C<bos addhost> command.
79
80 =head1 EXAMPLES
81
82 The following command displays the database server machines listed in
83 the B</usr/afs/etc/CellServDB> file on the machine B<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 COPYRIGHT
96
97 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
98
99 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
100 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
101 Stanford Linear Accelerator Center, a department of Stanford University.
102
103 =head1 SEE ALSO
104
105 L<CellServDB_server_version(1)>,
106 L<KeyFile(1)>,
107 L<bos(1)>,
108 L<bos_addhost(1)>,
109 L<bos_removehost(1)>
110
111 =cut