doc/man-pages/pod8/fssync-debug_error.pod

   1 =head1 NAME
   2
   3 fssync-debug_error - Forces volume into hard error state (FSYNC_VOL_FORCE_ERROR opcode)
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fssync-debug error> S<<< B<-volumeid> <I<volume ID>> >>>
  11     S<<< [B<-partition> <I<exact partition name>>] >>>
  12     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
  13     S<<< [B<-programtype> <I<program type code>>] >>>
  14     [B<-help>]
  15
  16 B<fssync-debug e> S<<< B<-v> <I<volume ID>> >>>
  17     S<<< [B<-pa> <I<exact partition name>>] >>>
  18     S<<< [B<-r> <I<sync protocol reason code>>] >>>
  19     S<<< [B<-pr> <I<program type code>>] >>>
  20     [B<-h>]
  21
  22 =for html
  23 </div>
  24
  25 =head1 DESCRIPTION
  26
  27 The B<fssync-debug error> command forces a volume into
  28 hard error state.
  29
  30 =head1 OPTIONS
  31
  32 =over 4
  33
  34 =item B<-volumeid> <I<volume ID>>
  35
  36 Specifies the numeric volume ID. Volume names are not permitted.
  37
  38 =item B<-partition> <I<exact partition name>>
  39
  40 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
  41 are not permitted.
  42
  43 =item B<-reason> <I<sync protocol reason code>>
  44
  45 Specifies numeric sync protocol reason code.
  46 Available codes are listed in OpenAFS source file
  47 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
  48 use B<-reason I<0>>.
  49
  50 =item B<-programtype> <I<program type code>>
  51
  52 Specifies program type code. Permitted values are
  53 I<fileServer>,
  54 I<volumeUtility>,
  55 I<salvager>,
  56 I<salvageServer>,
  57 I<volumeServer> and
  58 I<volumeSalvager>.
  59
  60 =item B<-help>
  61
  62 Prints the online help for this command. All other valid options are
  63 ignored.
  64
  65 =back
  66
  67 =head1 PRIVILEGE REQUIRED
  68
  69 The issuer must have write access to the file server.
  70 Usually, this means that the issuer must be the
  71 local superuser C<root> on the file server machine.
  72
  73 =head1 SEE ALSO
  74
  75 L<fssync-debug_attach(8)>,
  76 L<fssync-debug_detach(8)>,
  77 L<fssync-debug_online(8)>,
  78 L<fssync-debug_offline(8)>,
  79 L<fssync-debug_leaveoff(8)>,
  80 L<fssync-debug_callback(8)>
  81
  82 =head1 COPYRIGHT
  83
  84 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
  85
  86 This documentation is covered by the IBM Public License Version 1.0.  This
  87 man page was written by Davor Ocelic for OpenAFS, based on documentation
  88 from Steven Jenkins, Tom Keiser and Simon Wilkinson.