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