02abdd0ec8ab5148d710a4c4f5bc7ab55e2f2a65
[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>>] >>>
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 =item B<-cell> <I<cell name>>
92
93 Names the cell in which to run the command. Do not combine this argument
94 with the B<-localauth> flag. For more details, see L<vos(1)>.
95
96 =item B<-noauth>
97
98 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
99 combine this flag with the B<-localauth> flag. For more details, see
100 L<vos(1)>.
101
102 =item B<-localauth>
103
104 Constructs a server ticket using a key from the local
105 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
106 to the Volume Server and Volume Location Server during mutual
107 authentication. Do not combine this flag with the B<-cell> argument or
108 B<-noauth> flag. For more details, see L<vos(1)>.
109
110 =item B<-verbose>
111
112 Produces on the standard output stream a detailed trace of the command's
113 execution. If this argument is omitted, only warnings and error messages
114 appear.
115
116 =item B<-encrypt>
117
118 Encrypts the command so that the operation's results are not transmitted
119 across the network in clear text. This option is available in OpenAFS
120 versions 1.4.11 or later and 1.5.60 or later.
121
122 =item B<-noresolve>
123
124 Shows all servers as IP addresses instead of the DNS name. This is very
125 useful when the server address is registered as 127.0.0.1 or when dealing
126 with multi-homed servers. This option is available in OpenAFS
127 versions 1.4.8 or later and 1.5.35 or later.
128
129 =item B<-help>
130
131 Prints the online help for this command. All other valid options are
132 ignored.
133
134 =back
135
136 =head1 EXAMPLES
137
138 The following command unlocks all locked entries in the VLDB.
139
140    % vos unlockvldb
141
142 The following command unlocks all locked VLDB entries that mention the
143 F</vicepa> partition in a site definition.
144
145    % vos unlockvldb -partition a
146
147 The following command unlocks all locked VLDB entries that refer to
148 volumes on the F</vicepc> partition of the file server machine
149 C<fs3.example.com>.
150
151    % vos unlockvldb -server fs3.example.com -partition c
152
153 =head1 PRIVILEGE REQUIRED
154
155 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
156 machine specified with the B<-server> argument and on each database server
157 machine. If the B<-localauth> flag is included, the issuer must instead be
158 logged on to a server machine as the local superuser C<root>.
159
160 =head1 SEE ALSO
161
162 L<vos(1)>,
163 L<vos_lock(1)>,
164 L<vos_unlock(1)>
165
166 =head1 COPYRIGHT
167
168 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
169
170 This documentation is covered by the IBM Public License Version 1.0.  It was
171 converted from HTML to POD by software written by Chas Williams and Russ
172 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.