man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / vos_listaddrs.pod
1 =head1 NAME
2
3 vos_listaddrs - Displays all VLDB server entries
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos listaddrs> S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>]
11     [B<-localauth>] [B<-verbose>] [B<-help>]
12
13 B<vos lista> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
14
15 =for html
16 </div>
17
18 =head1 DESCRIPTION
19
20 The B<vos listaddrs> command displays all of the server entries from the
21 Volume Location Database (VLDB). An entry is created as the File Server
22 initializes and registers the contents of its F</usr/afs/local/sysid> file
23 in the VLDB.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-cell> <I<cell name>>
30
31 Names the cell in which to run the command. Do not combine this argument
32 with the B<-localauth> flag. For more details, see L<vos(1)>.
33
34 =item B<-noauth>
35
36 Assigns the unprivileged identity anonymous to the issuer. Do not combine
37 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
38
39 =item B<-localauth>
40
41 Constructs a server ticket using a key from the local
42 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
43 to the Volume Server and Volume Location Server during mutual
44 authentication. Do not combine this flag with the B<-cell> argument or
45 B<-noauth> flag. For more details, see L<vos(1)>.
46
47 =item B<-verbose>
48
49 Produces on the standard output stream a detailed trace of the command's
50 execution. If this argument is omitted, only warnings and error messages
51 appear.
52
53 =item B<-help>
54
55 Prints the online help for this command. All other valid options are
56 ignored.
57
58 =back
59
60 =head1 OUTPUT
61
62 The output displays all server entries from the VLDB, each on its own
63 line. If a file server machine is multihomed, all of its registered
64 addresses appear on the line. The first one is the one reported as a
65 volume's site in the output from the B<vos examine> and B<vos listvldb>
66 commands.
67
68 The VLDB records IP addresses, and the command interpreter has the local
69 name service (either a process like the Domain Name Service or a local
70 host table) translate them to hostnames before displaying them. If an IP
71 address appears in the output, it is not possible to translate it.
72
73 The existence of an entry does not necessarily indicate that the machine
74 that is still an active file server machine. To remove obsolete server
75 entries, use the B<vos changeaddr> command with the B<-remove> argument.
76
77 =head1 EXAMPLES
78
79 The following command displays the VLDB server entries in the ABC
80 Corporation cell:
81
82    % vos listaddrs
83    sv5.abc.com
84    sv1.abc.com
85    sv2.abc.com  afs2.abc.com
86    sv6.abc.com
87
88 =head1 PRIVILEGE REQUIRED
89
90 None
91
92 =head1 SEE ALSO
93
94 L<sysid(5)>,
95 L<vos(1)>,
96 L<vos_changeaddr(1)>,
97 L<vos_examine(1)>,
98 L<vos_listvldb(1)>
99
100 =head1 COPYRIGHT
101
102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
103
104 This documentation is covered by the IBM Public License Version 1.0.  It was
105 converted from HTML to POD by software written by Chas Williams and Russ
106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.