doc/man-pages/pod1/vos_lock.pod.in

   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>]
  14     S<<< [B<-config> <I<config directory>>] >>>
  15     [B<-help>]
  16
  17 B<vos lo> S<<< B<-i> <I<volume name or ID>> >>>
  18     S<<< [B<-c> <I<cell name>>] >>>
  19     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
  20     S<<< [B<-co> <I<config directory>>] >>>
  21     [B<-h>]
  22
  23 =for html
  24 </div>
  25
  26 =head1 DESCRIPTION
  27
  28 The B<vos lock> command locks the Volume Location Database (VLDB) entry
  29 for the indicated volume, blocking any operation that requires a write to
  30 that entry. The lock applies to all of the volume versions associated with
  31 the entry, not just the one specified with the B<-id> argument.
  32
  33 To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
  34 several entries, or all locked entries in the VLDB, use the B<vos
  35 unlockvldb> command.
  36
  37 =head1 CAUTIONS
  38
  39 Do not use this command in normal circumstances. It is useful for
  40 guaranteeing that the volume stays unchanged when there is reason to
  41 believe that volume operations cannot properly lock VLDB volume entries as
  42 they normally do to synchronize with one another.
  43
  44 =head1 OPTIONS
  45
  46 =over 4
  47
  48 =item B<-id> <I<volume name or ID>>
  49
  50 Specifies either the complete name or volume ID number of a volume of the
  51 any of the three types.
  52
  53 =include fragments/vos-common.pod
  54
  55 =back
  56
  57 =head1 EXAMPLES
  58
  59 The following command locks the VLDB entry for C<user.terry>.
  60
  61    % vos lock user.terry
  62
  63 =head1 PRIVILEGE REQUIRED
  64
  65 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
  66 machine specified with the B<-server> argument and on each database server
  67 machine. If the B<-localauth> flag is included, the issuer must instead be
  68 logged on to a server machine as the local superuser C<root>.
  69
  70 =head1 SEE ALSO
  71
  72 L<vos(1)>,
  73 L<vos_unlock(1)>,
  74 L<vos_unlockvldb(1)>
  75
  76 =head1 COPYRIGHT
  77
  78 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  79
  80 This documentation is covered by the IBM Public License Version 1.0.  It was
  81 converted from HTML to POD by software written by Chas Williams and Russ
  82 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.