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>> >>> S<<< [B<-cell> <I<cell name>>] >>>
  11     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
  12
  13 B<vos lo> 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 lock> command locks the Volume Location Database (VLDB) entry
  22 for the indicated volume, blocking any operation that requires a write to
  23 that entry. The lock applies to all of the volume versions associated with
  24 the entry, not just the one specified with the B<-id> argument.
  25
  26 To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
  27 several entries, or all locked entries in the VLDB, use the B<vos
  28 unlockvldb> command.
  29
  30 =head1 CAUTIONS
  31
  32 Do not use this command in normal circumstances. It is useful for
  33 guaranteeing that the volume stays unchanged when there is reason to
  34 believe that volume operations cannot properly lock VLDB volume entries as
  35 they normally do to synchronize with one another.
  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 the
  44 any 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 command locks the VLDB entry for C<user.terry>.
  81
  82    % vos lock 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_unlock(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.