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

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