libafs: allow bkg daemon requests without creds
[openafs.git] / doc / man-pages / pod1 / vos_listaddrs.pod.in
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 =include fragments/vos-common.pod
58
59 =back
60
61 =head1 OUTPUT
62
63 The output displays all server entries from the VLDB, each on its own
64 line. If a file server machine is multihomed, all of its registered
65 addresses appear on the line. The first one is the one reported as a
66 volume's site in the output from the B<vos examine> and B<vos listvldb>
67 commands.
68
69 The VLDB records IP addresses, and the command interpreter has the local
70 name service (either a process like the Domain Name Service or a local
71 host table) translate them to hostnames before displaying them. If an IP
72 address appears in the output, it is not possible to translate it.
73
74 The existence of an entry does not necessarily indicate that the machine
75 that is still an active file server machine. To remove obsolete server
76 entries, use the B<vos changeaddr> command with the B<-remove> argument.
77
78 =head1 EXAMPLES
79
80 The following command displays the VLDB server entries in the Example
81 Corporation cell:
82
83    % vos listaddrs
84    sv5.example.com
85    sv1.example.com
86    sv2.example.com  afs2.example.com
87    sv6.example.com
88
89 The following command displays the VLDB server entry and UUID for
90 host sv5.example.com in the Example Corporation cell:
91
92    % vos listaddrs -p -ho sv5.example.com
93    UUID: 000c5aff-8246-1699-96-c4-437b5a45aa77
94    sv5.example.com
95
96 =head1 PRIVILEGE REQUIRED
97
98 None
99
100 =head1 SEE ALSO
101
102 L<fs_uuid(1)>,
103 L<sysid(5)>,
104 L<vos(1)>,
105 L<vos_changeaddr(1)>,
106 L<vos_examine(1)>,
107 L<vos_listvldb(1)>
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.