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