man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / vos_unlockvldb.pod
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>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
13
14 B<vos unlockv> S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-p> <I<partition name>>] >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<vos unlockvldb> command releases the lock on the Volume Location
23 Database (VLDB) entries indicated by the combination of arguments
24 provided:
25
26 =over 4
27
28 =item *
29
30 To unlock all entries in the VLDB, provide no arguments.
31
32 =item *
33
34 To unlock all entries that mention a file server machine in a site
35 definition, provide its name with the B<-server> argument.
36
37 =item *
38
39 To unlock all entries that mention a partition on any file server machine
40 in a site definition, provide the partition name with the B<-partition>
41 argument.
42
43 =item *
44
45 To unlock all entries that mention a specific site, provide both the
46 B<-server> and B<-partition> arguments.
47
48 =back
49
50 To unlock a single volume, use the B<vos unlock> command instead.
51
52 =head1 CAUTIONS
53
54 Do not use this command under normal circumstances.
55
56 It is useful if VLDB entries for volumes at a certain site are locked but
57 there is no reason to suspect inconsistency within the volume or between
58 it and the VLDB. Note that it is possible to list information from locked
59 VLDB entries, even though they cannot be manipulated in other ways.
60
61 The B<vos lock> command locks a VLDB entry so that no one else can perform
62 an action that requires writing the VLDB.
63
64 =head1 OPTIONS
65
66 =over 4
67
68 =item B<-server> <I<server name>>
69
70 Identifies the file server machine for which to unlock VLDB
71 entries. Provide the machine's IP address or its host name (either fully
72 qualified or using an unambiguous abbreviation). For details, see
73 L<vos(1)>.
74
75 =item B<-partition> <I<partition name>>
76
77 Identifies the partition (on the file server machine specified by the
78 B<-server> argument) for which to unlock VLDB entries. Provide the
79 partition's complete name with preceding slash (for example, C</vicepa>)
80 or use one of the three acceptable abbreviated forms. For details, see
81 L<vos(1)>.
82
83 =item B<-cell> <I<cell name>>
84
85 Names the cell in which to run the command. Do not combine this argument
86 with the B<-localauth> flag. For more details, see L<vos(1)>.
87
88 =item B<-noauth>
89
90 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
91 combine this flag with the B<-localauth> flag. For more details, see
92 L<vos(1)>.
93
94 =item B<-localauth>
95
96 Constructs a server ticket using a key from the local
97 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
98 to the Volume Server and Volume Location Server during mutual
99 authentication. Do not combine this flag with the B<-cell> argument or
100 B<-noauth> flag. For more details, see L<vos(1)>.
101
102 =item B<-verbose>
103
104 Produces on the standard output stream a detailed trace of the command's
105 execution. If this argument is omitted, only warnings and error messages
106 appear.
107
108 =item B<-help>
109
110 Prints the online help for this command. All other valid options are
111 ignored.
112
113 =back
114
115 =head1 EXAMPLES
116
117 The following command unlocks all locked entries in the VLDB.
118
119    % vos unlockvldb
120
121 The following command unlocks all locked VLDB entries that mention the
122 F</vicepa> partition in a site definition.
123
124    % vos unlockvldb -partition a
125
126 The following command unlocks all locked VLDB entries that refer to
127 volumes on the F</vicepc> partition of the file server machine
128 C<fs3.abc.com>.
129
130    % vos unlockvldb -server fs3.abc.com -partition c
131
132 =head1 PRIVILEGE REQUIRED
133
134 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
135 machine specified with the B<-server> argument and on each database server
136 machine. If the B<-localauth> flag is included, the issuer must instead be
137 logged on to a server machine as the local superuser C<root>.
138
139 =head1 SEE ALSO
140
141 L<vos(1)>,
142 L<vos_lock(1)>,
143 L<vos_unlock(1)>
144
145 =head1 COPYRIGHT
146
147 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
148
149 This documentation is covered by the IBM Public License Version 1.0.  It was
150 converted from HTML to POD by software written by Chas Williams and Russ
151 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.