vos: remaddrs sub-command
[openafs.git] / doc / man-pages / pod1 / vos_remaddrs.pod.in
1 =head1 NAME
2
3 vos_remaddrs - removes a file server machine's entry from the VLDB
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos remaddrs> S<<< B<-uuid> <I<UUID of server>> >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
12     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
13     S<<< [B<-config> <I<config directory>>] >>>
14     [B<-help>]
15
16 B<vos rema> S<<< B<-u> <I<UUID of server>> >>>
17     S<<< [B<-c> <I<cell name>>] >>>
18     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
19     S<<< [B<-co> <I<config directory>>] >>>
20     [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<vos remaddrs> command removes a server entry from the Volume Location
28 Database (VLDB). There must be no VLDB entries that list the machine as a site
29 for any version of a volume. If necessary, use the B<vos move> or B<vos remove>
30 command to move or remove volumes. It is appropriate to remove a VLDB server
31 entry when removing the corresponding file server machine from service.
32
33 To display all VLDB server entries, use the B<vos listaddrs> command.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-uuid> <I<UUID of server>>
40
41 The unique ID as provided by the C<vos listaddrs -printuuid> command.
42
43 =back
44
45 =head1 EXAMPLES
46
47 The following command removes the VLDB server entry for the file server
48 with the addresses C<192.12.107.214> and C<10.47.11.17>.
49
50    $ vos remaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 -verbose
51    vos: Removing UUID with addresses:
52    UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
53    192.12.107.214
54    10.47.11.17
55
56 =head1 PRIVILEGE REQUIRED
57
58 Issuer must be listed in the F</usr/afs/etc/UserList> file on each database
59 server machine.
60
61 =head1 SEE ALSO
62
63 L<CellServDB(5)>,
64 L<UserList(5)>,
65 L<fileserver(8)>,
66 L<vos(1)>,
67 L<vos_listaddrs(1)>,
68 L<vos_setaddrs(1)>
69
70 =head1 COPYRIGHT
71
72 Copyright 2014 Sine Nomine Associates.  All Rights Reserved.
73
74 This documentation is covered by the BSD License as written in the
75 doc/LICENSE file. This man page was written by Michael Meffie for
76 OpenAFS.