doc/man-pages/pod1/vos_lock.pod

   1 =head1 NAME
   2
   3 vos_lock - Locks a VLDB volume entry
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos lock> S<<< B<-id> <I<volume name or ID>> >>>
  11     S<<< [B<-cell> <I<cell name>>] >>>
  12     [B<-noauth>] [B<-localauth>]
  13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  14
  15 B<vos lo> S<<< B<-i> <I<volume name or ID>> >>>
  16     S<<< [B<-c> <I<cell name>>] >>>
  17     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos lock> command locks the Volume Location Database (VLDB) entry
  25 for the indicated volume, blocking any operation that requires a write to
  26 that entry. The lock applies to all of the volume versions associated with
  27 the entry, not just the one specified with the B<-id> argument.
  28
  29 To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
  30 several entries, or all locked entries in the VLDB, use the B<vos
  31 unlockvldb> command.
  32
  33 =head1 CAUTIONS
  34
  35 Do not use this command in normal circumstances. It is useful for
  36 guaranteeing that the volume stays unchanged when there is reason to
  37 believe that volume operations cannot properly lock VLDB volume entries as
  38 they normally do to synchronize with one another.
  39
  40 =head1 OPTIONS
  41
  42 =over 4
  43
  44 =item B<-id> <I<volume name or ID>>
  45
  46 Specifies either the complete name or volume ID number of a volume of the
  47 any of the three types.
  48
  49 =item B<-cell> <I<cell name>>
  50
  51 Names the cell in which to run the command. Do not combine this argument
  52 with the B<-localauth> flag. For more details, see L<vos(1)>.
  53
  54 =item B<-noauth>
  55
  56 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  57 combine this flag with the B<-localauth> flag. For more details, see
  58 L<vos(1)>.
  59
  60 =item B<-localauth>
  61
  62 Constructs a server ticket using a key from the local
  63 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  64 to the Volume Server and Volume Location Server during mutual
  65 authentication. Do not combine this flag with the B<-cell> argument or
  66 B<-noauth> flag. For more details, see L<vos(1)>.
  67
  68 =item B<-verbose>
  69
  70 Produces on the standard output stream a detailed trace of the command's
  71 execution. If this argument is omitted, only warnings and error messages
  72 appear.
  73
  74 =item B<-encrypt>
  75
  76 Encrypts the command so that the operation's results are not transmitted
  77 across the network in clear text. This option is available in OpenAFS
  78 versions 1.4.11 or later and 1.5.60 or later.
  79
  80 =item B<-noresolve>
  81
  82 Shows all servers as IP addresses instead of the DNS name. This is very
  83 useful when the server address is registered as 127.0.0.1 or when dealing
  84 with multi-homed servers. This option is available in OpenAFS
  85 versions 1.4.8 or later and 1.5.35 or later.
  86
  87 =item B<-help>
  88
  89 Prints the online help for this command. All other valid options are
  90 ignored.
  91
  92 =back
  93
  94 =head1 EXAMPLES
  95
  96 The following command locks the VLDB entry for C<user.terry>.
  97
  98    % vos lock user.terry
  99
 100 =head1 PRIVILEGE REQUIRED
 101
 102 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 103 machine specified with the B<-server> argument and on each database server
 104 machine. If the B<-localauth> flag is included, the issuer must instead be
 105 logged on to a server machine as the local superuser C<root>.
 106
 107 =head1 SEE ALSO
 108
 109 L<vos(1)>,
 110 L<vos_unlock(1)>,
 111 L<vos_unlockvldb(1)>
 112
 113 =head1 COPYRIGHT
 114
 115 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 116
 117 This documentation is covered by the IBM Public License Version 1.0.  It was
 118 converted from HTML to POD by software written by Chas Williams and Russ
 119 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.