doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_unlockvldb.pod.in
1 =head1 NAME
2
3 vos_unlockvldb - Unlocks several locked VLDB entries
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos unlockvldb> S<<< [B<-server> <I<machine name>>] >>>
11     S<<< [B<-partition> <I<partition name>>] >>>
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-noauth>] [B<-localauth>]
14     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15     S<<< [B<-config> <I<config directory>>] >>>
16     [B<-help>]
17
18 B<vos unlockv> S<<< [B<-s> <I<machine name>>] >>>
19     S<<< [B<-p> <I<partition name>>] >>>
20     S<<< [B<-c> <I<cell name>>] >>>
21     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
22     S<<< [B<-co> <I<config directory>>] >>>
23     [B<-h>]
24
25 =for html
26 </div>
27
28 =head1 DESCRIPTION
29
30 The B<vos unlockvldb> command releases the lock on the Volume Location
31 Database (VLDB) entries indicated by the combination of arguments
32 provided:
33
34 =over 4
35
36 =item *
37
38 To unlock all entries in the VLDB, provide no arguments.
39
40 =item *
41
42 To unlock all entries that mention a file server machine in a site
43 definition, provide its name with the B<-server> argument.
44
45 =item *
46
47 To unlock all entries that mention a partition on any file server machine
48 in a site definition, provide the partition name with the B<-partition>
49 argument.
50
51 =item *
52
53 To unlock all entries that mention a specific site, provide both the
54 B<-server> and B<-partition> arguments.
55
56 =back
57
58 To unlock a single volume, use the B<vos unlock> command instead.
59
60 =head1 CAUTIONS
61
62 Do not use this command under normal circumstances.
63
64 It is useful if VLDB entries for volumes at a certain site are locked but
65 there is no reason to suspect inconsistency within the volume or between
66 it and the VLDB. Note that it is possible to list information from locked
67 VLDB entries, even though they cannot be manipulated in other ways.
68
69 The B<vos lock> command locks a VLDB entry so that no one else can perform
70 an action that requires writing the VLDB.
71
72 =head1 OPTIONS
73
74 =over 4
75
76 =item B<-server> <I<server name>>
77
78 Identifies the file server machine for which to unlock VLDB
79 entries. Provide the machine's IP address or its host name (either fully
80 qualified or using an unambiguous abbreviation). For details, see
81 L<vos(1)>.
82
83 =item B<-partition> <I<partition name>>
84
85 Identifies the partition (on the file server machine specified by the
86 B<-server> argument) for which to unlock VLDB entries. Provide the
87 partition's complete name with preceding slash (for example, C</vicepa>)
88 or use one of the three acceptable abbreviated forms. For details, see
89 L<vos(1)>.
90
91 =include fragments/vos-common.pod
92
93 =back
94
95 =head1 EXAMPLES
96
97 The following command unlocks all locked entries in the VLDB.
98
99    % vos unlockvldb
100
101 The following command unlocks all locked VLDB entries that mention the
102 F</vicepa> partition in a site definition.
103
104    % vos unlockvldb -partition a
105
106 The following command unlocks all locked VLDB entries that refer to
107 volumes on the F</vicepc> partition of the file server machine
108 C<fs3.example.com>.
109
110    % vos unlockvldb -server fs3.example.com -partition c
111
112 =head1 PRIVILEGE REQUIRED
113
114 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
115 machine specified with the B<-server> argument and on each database server
116 machine. If the B<-localauth> flag is included, the issuer must instead be
117 logged on to a server machine as the local superuser C<root>.
118
119 =head1 SEE ALSO
120
121 L<vos(1)>,
122 L<vos_lock(1)>,
123 L<vos_unlock(1)>
124
125 =head1 COPYRIGHT
126
127 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
128
129 This documentation is covered by the IBM Public License Version 1.0.  It was
130 converted from HTML to POD by software written by Chas Williams and Russ
131 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.