doc/man-pages/pod1/vos_unlock.pod

   1 =head1 NAME
   2
   3 vos_unlock - Unlocks a single VLDB entry
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos unlock> S<<< B<-id> <I<volume name or ID>> >>> S<<< [B<-cell> <I<cell name>>] >>>
  11     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
  12
  13 B<vos unlock> S<<< B<-i> <I<volume name or ID>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
  14     [B<-l>] [B<-v>] [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<vos unlock> command releases the lock on the Volume Location
  22 Database (VLDB) entry for the indicated volume.
  23
  24 =head1 CAUTIONS
  25
  26 Do not user this command under normal circumstances.
  27
  28 It is useful if the VLDB entry is locked but there is no reason to suspect
  29 inconsistency within the volume or between it and the VLDB. Note that it
  30 is possible to list information from locked VLDB entries, even though they
  31 cannot be manipulated in other ways.
  32
  33 The B<vos unlockvldb> command unlocks several VLDB entries at once, or
  34 even the entire VLDB. The B<vos lock> command locks a VLDB entry so that
  35 no one else can perform an action that requires writing the VLDB.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-id> <I<volume name or ID>>
  42
  43 Specifies either the complete name or volume ID number of a volume of any
  44 of the three types.
  45
  46 =item B<-cell> <I<cell name>>
  47
  48 Names the cell in which to run the command. Do not combine this argument
  49 with the B<-localauth> flag. For more details, see L<vos(1)>.
  50
  51 =item B<-noauth>
  52
  53 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  54 combine this flag with the B<-localauth> flag. For more details, see
  55 L<vos(1)>.
  56
  57 =item B<-localauth>
  58
  59 Constructs a server ticket using a key from the local
  60 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  61 to the Volume Server and Volume Location Server during mutual
  62 authentication. Do not combine this flag with the B<-cell> argument or
  63 B<-noauth> flag. For more details, see L<vos(1)>.
  64
  65 =item B<-verbose>
  66
  67 Produces on the standard output stream a detailed trace of the command's
  68 execution. If this argument is omitted, only warnings and error messages
  69 appear.
  70
  71 =item B<-help>
  72
  73 Prints the online help for this command. All other valid options are
  74 ignored.
  75
  76 =back
  77
  78 =head1 EXAMPLES
  79
  80 The following example unlocks the VLDB entry for the volume C<user.terry>.
  81
  82    % vos unlock user.terry
  83
  84 =head1 PRIVILEGE REQUIRED
  85
  86 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
  87 machine specified with the B<-server> argument and on each database server
  88 machine. If the B<-localauth> flag is included, the issuer must instead be
  89 logged on to a server machine as the local superuser C<root>.
  90
  91 =head1 SEE ALSO
  92
  93 L<vos(1)>,
  94 L<vos_lock(1)>,
  95 L<vos_unlockvldb(1)>
  96
  97 =head1 COPYRIGHT
  98
  99 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 100
 101 This documentation is covered by the IBM Public License Version 1.0.  It was
 102 converted from HTML to POD by software written by Chas Williams and Russ
 103 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.