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