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

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