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>]
  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 =item B<-cell> <I<cell name>>
  75
  76 Names the cell in which to run the command. Do not combine this argument
  77 with the B<-localauth> flag. For more details, see L<vos(1)>.
  78
  79 =item B<-noauth>
  80
  81 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  82 combine this flag with the B<-localauth> flag. For more details, see
  83 L<vos(1)>.
  84
  85 =item B<-localauth>
  86
  87 Constructs a server ticket using a key from the local
  88 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  89 to the Volume Server and Volume Location Server during mutual
  90 authentication. Do not combine this flag with the B<-cell> argument or
  91 B<-noauth> flag. For more details, see L<vos(1)>.
  92
  93 =item B<-verbose>
  94
  95 Produces on the standard output stream a detailed trace of the command's
  96 execution. If this argument is omitted, only warnings and error messages
  97 appear.
  98
  99 =item B<-encrypt>
 100
 101 Encrypts the command so that the operation's results are not transmitted
 102 across the network in clear text.
 103
 104 =item B<-noresolve>
 105
 106 Shows all servers as IP addresses instead of the DNS name. This is very
 107 useful when the server address is registered as 127.0.0.1 or when dealing
 108 with multi-homed servers.
 109
 110 =item B<-help>
 111
 112 Prints the online help for this command. All other valid options are
 113 ignored.
 114
 115 =back
 116
 117 =head1 EXAMPLES
 118
 119 The following example illustrates the kind of output that can appear
 120 when a volume operation was about to be attempted on the Volume Server
 121 on C<fs1.example.com>, but the process performing the operation never
 122 actually did anything with the volume:
 123
 124    % vos status fs1.example.com
 125    --------------------------------------------
 126    transaction: 575  created: Fri Oct 16 16:55:54 2009
 127    attachFlags: offline
 128    volume: 536871080 partition: /vicepb procedure: TransCreate
 129    --------------------------------------------
 130    % vos endtrans fs1.example.com 575
 131    % vos status fs1.example.com
 132    No active transactions on fs1.example.com
 133
 134 =head1 PRIVILEGE REQUIRED
 135
 136 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 137 machine specified with the B<-server> argument. If the B<-localauth>
 138 flag is included, the issuer must instead be logged on to a server
 139 machine as the local superuser C<root>.
 140
 141 =head1 SEE ALSO
 142
 143 L<vos(1)>,
 144 L<vos_status(1)>
 145
 146 =head1 COPYRIGHT
 147
 148 Copyright 2009 Sine Nomine Associates
 149
 150 This documentation is covered by the BSD License as written in the
 151 doc/LICENSE file. This man page was written by Andrew Deason for
 152 OpenAFS.