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

   1 =head1 NAME
   2
   3 fssync-debug - Introduction to the fssync-debug command suite
   4
   5 =head1 DESCRIPTION
   6
   7 B<fssync-debug> command suite allows low-level inspection and
   8 control of the file server volume packages.
   9
  10 This command suite is only supported on the demand-attach file server.
  11 It operates at an extremely low-level and hence requires detailed
  12 knowledge of the OpenAFS architecture and code.
  13
  14 An understanding of the OpenAFS volume finite-state machine is
  15 required before the state of a volume should be manipulated.
  16 Indiscriminate use of B<fssync-debug> in control mode can lead to
  17 extremely bad things occurring. Use with care.
  18
  19 =head1 OPTIONS
  20
  21 The following arguments and flags are available on many commands in the
  22 B<fssync-debug> suite. The reference page for each command also lists them,
  23 but they may be described here in greater detail.
  24
  25 =over 4
  26
  27 =item B<-volumeid> <I<volume ID>>
  28
  29 Specifies the numeric volume ID. Volume names are not permitted.
  30
  31 =item B<-partition> <I<exact partition name>>
  32
  33 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
  34 are not permitted.
  35
  36 =item B<-reason> <I<sync protocol reason code>>
  37
  38 Specifies numeric sync protocol reason code.
  39 Available codes are listed in OpenAFS source file
  40 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
  41 use B<-reason I<0>>.
  42
  43 =item B<-programtype> <I<program type code>>
  44
  45 Specifies program type code. Permitted values are
  46 I<fileServer>,
  47 I<volumeUtility>,
  48 I<salvager>,
  49 I<salvageServer>,
  50 I<volumeServer> and
  51 I<volumeSalvager>.
  52
  53 =back
  54
  55 =head1 PRIVILEGE REQUIRED
  56
  57 The issuer must have write access to the file server.
  58 Usually, this means that the issuer must be the
  59 local superuser C<root> on the file server machine.
  60
  61 =head1 SEE ALSO
  62
  63 L<fssync-debug_apropos(8)>,
  64 L<fssync-debug_attach(8)>,
  65 L<fssync-debug_callback(8)>,
  66 L<fssync-debug_detach(8)>,
  67 L<fssync-debug_error(8)>,
  68 L<fssync-debug_header(8)>,
  69 L<fssync-debug_help(8)>,
  70 L<fssync-debug_leaveoff(8)>,
  71 L<fssync-debug_list(8)>,
  72 L<fssync-debug_mode(8)>,
  73 L<fssync-debug_move(8)>,
  74 L<fssync-debug_offline(8)>,
  75 L<fssync-debug_online(8)>,
  76 L<fssync-debug_query(8)>,
  77 L<fssync-debug_stats(8)>,
  78 L<fssync-debug_vgcadd(8)>,
  79 L<fssync-debug_vgcdel(8)>,
  80 L<fssync-debug_vgcquery(8)>,
  81 L<fssync-debug_vgcscan(8)>,
  82 L<fssync-debug_vgcscanall(8)>,
  83 L<fssync-debug_vnode(8)>,
  84 L<fssync-debug_volop(8)>
  85
  86 =head1 COPYRIGHT
  87
  88 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
  89
  90 This documentation is covered by the IBM Public License Version 1.0.  This
  91 man page was written by Davor Ocelic for OpenAFS, based on documentation
  92 from Steven Jenkins, Tom Keiser and Simon Wilkinson.