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