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

   1 =head1 NAME
   2
   3 vos_endtrans - Ends a volserver transaction
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos endtrans> S<<< B<-server> <I<machine name>> >>>
  11     S<<< B<-transaction> <I<transaction iD>> >>>
  12     S<<< [B<-cell> <I<cell name>>] >>>
  13     [B<-noauth>] [B<-localauth>]
  14     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
  15     S<<< [B<-config> <I<config directory>>] >>>
  16     [B<-help>]
  17
  18 B<vos st> S<<< B<-s> <I<machine name>> >>>
  19     S<<< B<-t> <I<transaction iD>> >>>
  20     S<<< [B<-c> <I<cell name>>] >>>
  21     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
  22     S<<< [B<-co> <I<config directory>>] >>>
  23     [B<-h>]
  24
  25 =for html
  26 </div>
  27
  28 =head1 DESCRIPTION
  29
  30 The B<vos endtrans> command ends a specific transaction on the Volume
  31 Server for a specific volume. Under normal operation this command should
  32 never need to be used, but it can be useful to reduce the amount of time
  33 a volume is offline after an accidental command, or a L<B<vos>|vos(1)>
  34 process crash.
  35
  36 Many L<B<vos>|vos(1)> commands, when they interact with a volume, create
  37 what is called a transaction in order to perform many different
  38 operations on a volume. If the L<B<vos>|vos(1)> process exits uncleanly,
  39 transactions may still stay open for the manipulated volumes, and the
  40 Volume Server may deny any further operations on those volumes while the
  41 transactions are still open. B<vos endtrans> allows you to end these
  42 transactions and make the volumes usable again without needing to
  43 restart the volserver.
  44
  45 To find out what transactions are running on a Volume Server and what
  46 their transaction IDs are, see the L<B<vos status>|vos_status(1)>
  47 command.
  48
  49 =head1 CAUTIONS
  50
  51 This command is not used during normal OpenAFS administration. If used
  52 improperly, this can negatively impact currently-running
  53 L<B<vos>|vos(1)> operations. Only run this on a transaction if you are
  54 certain that the program that created the transaction is no longer
  55 running.
  56
  57 =head1 OPTIONS
  58
  59 =over 4
  60
  61 =item B<-server> <I<server name>>
  62
  63 Identifies the file server machine running the Volume Server on which to
  64 end the transaction. Provide the machine's IP address or its host name
  65 (either fully qualified or using an unambiguous abbreviation). For
  66 details, see L<vos(1)>.
  67
  68 =item B<-transaction> <I<transaction ID>>
  69
  70 Identifies which transaction to end on the Volume Server. You can get a
  71 listing of active transactions and their IDs from the output of
  72 L<B<vos status>|vos_status(1)>.
  73
  74 =include fragments/vos-common.pod
  75
  76 =back
  77
  78 =head1 EXAMPLES
  79
  80 The following example illustrates the kind of output that can appear
  81 when a volume operation was about to be attempted on the Volume Server
  82 on C<fs1.example.com>, but the process performing the operation never
  83 actually did anything with the volume:
  84
  85    % vos status fs1.example.com
  86    --------------------------------------------
  87    transaction: 575  created: Fri Oct 16 16:55:54 2009
  88    attachFlags: offline
  89    volume: 536871080 partition: /vicepb procedure: TransCreate
  90    --------------------------------------------
  91    % vos endtrans fs1.example.com 575
  92    % vos status fs1.example.com
  93    No active transactions on fs1.example.com
  94
  95 =head1 PRIVILEGE REQUIRED
  96
  97 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
  98 machine specified with the B<-server> argument. If the B<-localauth>
  99 flag is included, the issuer must instead be logged on to a server
 100 machine as the local superuser C<root>.
 101
 102 =head1 SEE ALSO
 103
 104 L<vos(1)>,
 105 L<vos_status(1)>
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2009 Sine Nomine Associates
 110
 111 This documentation is covered by the BSD License as written in the
 112 doc/LICENSE file. This man page was written by Andrew Deason for
 113 OpenAFS.