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

   1 =head1 NAME
   2
   3 fssync-debug_vgcquery - Displays VG cache contents (FSYNC_VG_QUERY opcode)
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fssync-debug vgcquery>
  11     S<<< B<-partition> <I<exact partition name>> >>>
  12     S<<< B<-volumeid> <I<volume ID>> >>>
  13     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
  14     S<<< [B<-programtype> <I<program type code>>] >>>
  15     [B<-help>]
  16
  17 B<fssync-debug vgcq>
  18     S<<< B<-pa> <I<exact partition name>> >>>
  19     S<<< B<-v> <I<volume ID>> >>>
  20     S<<< [B<-r> <I<sync protocol reason code>>] >>>
  21     S<<< [B<-pr> <I<program type code>>] >>>
  22     [B<-h>]
  23
  24 B<fssync-debug vgcqry>
  25     S<<< B<-pa> <I<exact partition name>> >>>
  26     S<<< B<-v> <I<volume ID>> >>>
  27     S<<< [B<-r> <I<sync protocol reason code>>] >>>
  28     S<<< [B<-pr> <I<program type code>>] >>>
  29     [B<-h>]
  30
  31 =for html
  32 </div>
  33
  34 =head1 DESCRIPTION
  35
  36 The B<fssync-debug vgcquery> command displays an entry from the volume
  37 group cache (VGC), and possibly starts a VGC scan if appropriate.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  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<-volumeid> <I<volume ID>>
  49
  50 Specifies the numeric volume ID. Volume names are not permitted.
  51
  52 =item B<-reason> <I<sync protocol reason code>>
  53
  54 Specifies numeric sync protocol reason code.
  55 Available codes are listed in OpenAFS source file
  56 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
  57 use B<-reason I<0>>.
  58
  59 =item B<-programtype> <I<program type code>>
  60
  61 Specifies program type code. Permitted values are
  62 I<fileServer>,
  63 I<volumeUtility>,
  64 I<salvager>,
  65 I<salvageServer>,
  66 I<volumeServer> and
  67 I<volumeSalvager>.
  68
  69 =item B<-help>
  70
  71 Prints the online help for this command. All other valid options are
  72 ignored.
  73
  74 =back
  75
  76 =head1 PRIVILEGE REQUIRED
  77
  78 The issuer must have write access to the file server.
  79 Usually, this means that the issuer must be the
  80 local superuser C<root> on the file server machine.
  81
  82 =head1 SEE ALSO
  83
  84 L<fssync-debug_vgcadd(8)>,
  85 L<fssync-debug_vgcdel(8)>,
  86 L<fssync-debug_vgcscan(8)>,
  87 L<fssync-debug_vgcscanall(8)>,
  88
  89 =head1 COPYRIGHT
  90
  91 Copyright 2010 Sine Nomine Associates
  92
  93 This documentation is covered by the IBM Public License Version 1.0. This
  94 man page was written by Andrew Deason and Davor Ocelic for OpenAFS.