openafs/doc/man-pages/pod1/vos_unlockvldb.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

169 lines
4.8 KiB
Plaintext

=head1 NAME
vos_unlockvldb - Unlocks several locked VLDB entries
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<vos unlockvldb> S<<< [B<-server> <I<machine name>>] >>>
S<<< [B<-partition> <I<partition name>>] >>>
S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>]
[B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
B<vos unlockv> S<<< [B<-s> <I<machine name>>] >>>
S<<< [B<-p> <I<partition name>>] >>>
S<<< [B<-c> <I<cell name>>] >>>
[B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<vos unlockvldb> command releases the lock on the Volume Location
Database (VLDB) entries indicated by the combination of arguments
provided:
=over 4
=item *
To unlock all entries in the VLDB, provide no arguments.
=item *
To unlock all entries that mention a file server machine in a site
definition, provide its name with the B<-server> argument.
=item *
To unlock all entries that mention a partition on any file server machine
in a site definition, provide the partition name with the B<-partition>
argument.
=item *
To unlock all entries that mention a specific site, provide both the
B<-server> and B<-partition> arguments.
=back
To unlock a single volume, use the B<vos unlock> command instead.
=head1 CAUTIONS
Do not use this command under normal circumstances.
It is useful if VLDB entries for volumes at a certain site are locked but
there is no reason to suspect inconsistency within the volume or between
it and the VLDB. Note that it is possible to list information from locked
VLDB entries, even though they cannot be manipulated in other ways.
The B<vos lock> command locks a VLDB entry so that no one else can perform
an action that requires writing the VLDB.
=head1 OPTIONS
=over 4
=item B<-server> <I<server name>>
Identifies the file server machine for which to unlock VLDB
entries. Provide the machine's IP address or its host name (either fully
qualified or using an unambiguous abbreviation). For details, see
L<vos(1)>.
=item B<-partition> <I<partition name>>
Identifies the partition (on the file server machine specified by the
B<-server> argument) for which to unlock VLDB entries. Provide the
partition's complete name with preceding slash (for example, C</vicepa>)
or use one of the three acceptable abbreviated forms. For details, see
L<vos(1)>.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<vos(1)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<vos(1)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the B<-cell> argument or
B<-noauth> flag. For more details, see L<vos(1)>.
=item B<-verbose>
Produces on the standard output stream a detailed trace of the command's
execution. If this argument is omitted, only warnings and error messages
appear.
=item B<-encrypt>
Encrypts the command so that the operation's results are not transmitted
across the network in clear text. This option is available in OpenAFS
versions 1.4.11 or later and 1.5.60 or later.
=item B<-noresolve>
Shows all servers as IP addresses instead of the DNS name. This is very
useful when the server address is registered as 127.0.0.1 or when dealing
with multi-homed servers. This option is available in OpenAFS
versions 1.4.8 or later and 1.5.35 or later.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command unlocks all locked entries in the VLDB.
% vos unlockvldb
The following command unlocks all locked VLDB entries that mention the
F</vicepa> partition in a site definition.
% vos unlockvldb -partition a
The following command unlocks all locked VLDB entries that refer to
volumes on the F</vicepc> partition of the file server machine
C<fs3.example.com>.
% vos unlockvldb -server fs3.example.com -partition c
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine specified with the B<-server> argument and on each database server
machine. If the B<-localauth> flag is included, the issuer must instead be
logged on to a server machine as the local superuser C<root>.
=head1 SEE ALSO
L<vos(1)>,
L<vos_lock(1)>,
L<vos_unlock(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.