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

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