doc/man-pages/pod1/vos_endtrans.pod

   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>] [B<-help>]
  15
  16 B<vos st> S<<< B<-s> <I<machine name>> >>>
  17     S<<< B<-t> <I<transaction iD>> >>>
  18     S<<< [B<-c> <I<cell name>>] >>>
  19     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  20
  21 =for html
  22 </div>
  23
  24 =head1 DESCRIPTION
  25
  26 Ths B<vos endtrans> command ends a specific transaction on the Volume
  27 Server for a specific volume. Under normal operation this command should
  28 never need to be used, but it can be useful to reduce the amount of time
  29 a volume is offline after an accidental command, or a L<B<vos>|vos(1)>
  30 process crash.
  31
  32 Many L<B<vos>|vos(1)> commands, when they interact with a volume, create
  33 what is called a transaction in order to perform many different
  34 operations on a volume. If the L<B<vos>|vos(1)> process exits uncleanly,
  35 transactions may still stay open for the manipulated volumes, and the
  36 Volume Server may deny any further operations on those volumes while the
  37 transactions are still open. B<vos endtrans> allows you to end these
  38 transactions and make the volumes usable again without needing to
  39 restart the volserver.
  40
  41 To find out what transactions are running on a Volume Server and what
  42 their transaction IDs are, see the L<B<vos status>|vos_status(1)>
  43 command.
  44
  45 =head1 CAUTIONS
  46
  47 This command is not used during normal OpenAFS administration. If used
  48 improperly, this can negatively impact currently-running
  49 L<B<vos>|vos(1)> operations. Only run this on a transaction if you are
  50 certain that the program that created the transaction is no longer
  51 running.
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item B<-server> <I<server name>>
  58
  59 Identifies the file server machine running the Volume Server on which to
  60 end the transaction. Provide the machine's IP address or its host name
  61 (either fully qualified or using an unambiguous abbreviation). For
  62 details, see L<vos(1)>.
  63
  64 =item B<-transaction> <I<transaction ID>>
  65
  66 Identifies which transaction to end on the Volume Server. You can get a
  67 listing of active transactions and their IDs from the output of
  68 L<B<vos status>|vos_status(1)>.
  69
  70 =item B<-cell> <I<cell name>>
  71
  72 Names the cell in which to run the command. Do not combine this argument
  73 with the B<-localauth> flag. For more details, see L<vos(1)>.
  74
  75 =item B<-noauth>
  76
  77 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  78 combine this flag with the B<-localauth> flag. For more details, see
  79 L<vos(1)>.
  80
  81 =item B<-localauth>
  82
  83 Constructs a server ticket using a key from the local
  84 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  85 to the Volume Server and Volume Location Server during mutual
  86 authentication. Do not combine this flag with the B<-cell> argument or
  87 B<-noauth> flag. For more details, see L<vos(1)>.
  88
  89 =item B<-verbose>
  90
  91 Produces on the standard output stream a detailed trace of the command's
  92 execution. If this argument is omitted, only warnings and error messages
  93 appear.
  94
  95 =item B<-encrypt>
  96
  97 Encrypts the command so that the operation's results are not transmitted
  98 across the network in clear text.
  99
 100 =item B<-noresolve>
 101
 102 Shows all servers as IP addresses instead of the DNS name. This is very
 103 useful when the server address is registered as 127.0.0.1 or when dealing
 104 with multi-homed servers.
 105
 106 =item B<-help>
 107
 108 Prints the online help for this command. All other valid options are
 109 ignored.
 110
 111 =back
 112
 113 =head1 EXAMPLES
 114
 115 The following example illustrates the kind of output that can appear
 116 when a volume operation was about to be attempted on the Volume Server
 117 on C<fs1.abc.com>, but the process performing the operation never
 118 actually did anything with the volume:
 119
 120    % vos status fs1.abc.com
 121    --------------------------------------------
 122    transaction: 575  created: Fri Oct 16 16:55:54 2009
 123    attachFlags: offline
 124    volume: 536871080 partition: /vicepb procedure: TransCreate
 125    --------------------------------------------
 126    % vos endtrans fs1.abc.com 575
 127    % vos status fs1.abc.com
 128    No active transactions on fs1.abc.com
 129
 130 =head1 PRIVILEGE REQUIRED
 131
 132 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 133 machine specified with the B<-server> argument. If the B<-localauth>
 134 flag is included, the issuer must instead be logged on to a server
 135 machine as the local superuser C<root>.
 136
 137 =head1 SEE ALSO
 138
 139 L<vos(1)>,
 140 L<vos_status(1)>
 141
 142 =head1 COPYRIGHT
 143
 144 Copyright 2009 Andrew Deason <adeason@sinenomine.net>
 145
 146 This documentation is covered by the BSD License as written in the
 147 doc/LICENSE file. This man page was written by Andrew Deason for
 148 OpenAFS.