730c663affd2802ff690627b0e81887ebf593e0a
[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<-uuid> <I<uuid of server>>] >>>
11     S<<< [B<-host> <I<address of host>>] >>> [B<-printuuid>]
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
14
15 B<vos lista> [B<-u> <I<uuid of server>>] >>>
16     S<<< [B<-h> <I<address of host>>] >>> [B<-p>]
17     S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
18     [B<-v>] [B<-e>] [B<-nor>] [B<-he>]
19
20 =for html
21 </div>
22
23 =head1 DESCRIPTION
24
25 The B<vos listaddrs> command displays all of the server entries from the
26 Volume Location Database (VLDB). An entry is created as the File Server
27 initializes and registers the contents of its F</usr/afs/local/sysid> file
28 in the VLDB.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-printuuid>
35
36 Prints UUID of hosts. The B<-printuuid> option is available in OpenAFS
37 versions 1.4.5 or later and 1.5.8 or later.
38
39 =item B<-cell> <I<cell name>>
40
41 Names the cell in which to run the command. Do not combine this argument
42 with the B<-localauth> flag. For more details, see L<vos(1)>.
43
44 =item B<-noauth>
45
46 Assigns the unprivileged identity anonymous to the issuer. Do not combine
47 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
48
49 =item B<-localauth>
50
51 Constructs a server ticket using a key from the local
52 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
53 to the Volume Server and Volume Location Server during mutual
54 authentication. Do not combine this flag with the B<-cell> argument or
55 B<-noauth> flag. For more details, see L<vos(1)>.
56
57 =item B<-verbose>
58
59 Produces on the standard output stream a detailed trace of the command's
60 execution. If this argument is omitted, only warnings and error messages
61 appear.
62
63 =item B<-encrypt>
64
65 Encrypts the command so that the operation's results are not transmitted
66 across the network in clear text. This option is available in OpenAFS
67 versions 1.4.11 or later and 1.5.60 or later.
68
69 =item B<-noresolve>
70
71 Shows all servers as IP addresses instead of the DNS name. This is very
72 useful when the server address is registered as 127.0.0.1 or when dealing
73 with multi-homed servers. This option is available in OpenAFS
74 versions 1.4.8 or later and 1.5.35 or later.
75
76 =item B<-help>
77
78 Prints the online help for this command. All other valid options are
79 ignored.
80
81 =back
82
83 =head1 OUTPUT
84
85 The output displays all server entries from the VLDB, each on its own
86 line. If a file server machine is multihomed, all of its registered
87 addresses appear on the line. The first one is the one reported as a
88 volume's site in the output from the B<vos examine> and B<vos listvldb>
89 commands.
90
91 The VLDB records IP addresses, and the command interpreter has the local
92 name service (either a process like the Domain Name Service or a local
93 host table) translate them to hostnames before displaying them. If an IP
94 address appears in the output, it is not possible to translate it.
95
96 The existence of an entry does not necessarily indicate that the machine
97 that is still an active file server machine. To remove obsolete server
98 entries, use the B<vos changeaddr> command with the B<-remove> argument.
99
100 =head1 EXAMPLES
101
102 The following command displays the VLDB server entries in the ABC
103 Corporation cell:
104
105    % vos listaddrs
106    sv5.abc.com
107    sv1.abc.com
108    sv2.abc.com  afs2.abc.com
109    sv6.abc.com
110
111 The following command displays the VLDB server entry and UUID for
112 host sv5.abc.com in the ABC Corporation cell:
113
114    % vos listaddrs -p -ho sv5.abc.com
115    UUID: 000c5aff-8246-1699-96-c4-437b5a45aa77
116    sv5.abc.com
117
118 =head1 PRIVILEGE REQUIRED
119
120 None
121
122 =head1 SEE ALSO
123
124 L<fs_uuid(1)>,
125 L<sysid(5)>,
126 L<vos(1)>,
127 L<vos_changeaddr(1)>,
128 L<vos_examine(1)>,
129 L<vos_listvldb(1)>
130
131 =head1 COPYRIGHT
132
133 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
134
135 This documentation is covered by the IBM Public License Version 1.0.  It was
136 converted from HTML to POD by software written by Chas Williams and Russ
137 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.