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

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