Update NEWS for 1.8.0pre3
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / fssync-debug_error.pod
blob8f20f76c9f3a817c74ebb41f1b6fd267dcc706fc
1 =head1 NAME
3 fssync-debug_error - Forces volume into hard error state (FSYNC_VOL_FORCE_ERROR opcode)
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<fssync-debug error> 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>]
16 B<fssync-debug e> 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>]
22 =for html
23 </div>
25 =head1 DESCRIPTION
27 The B<fssync-debug error> command forces a volume into
28 hard error state.
30 =head1 OPTIONS
32 =over 4
34 =item B<-volumeid> <I<volume ID>>
36 Specifies the numeric volume ID. Volume names are not permitted.
38 =item B<-partition> <I<exact partition name>>
40 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
41 are not permitted.
43 =item B<-reason> <I<sync protocol reason code>>
45 Specifies numeric sync protocol reason code.
46 Available codes are listed in OpenAFS source file
47 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
48 use B<-reason I<0>>.
50 =item B<-programtype> <I<program type code>>
52 Specifies program type code. Permitted values are
53 I<fileServer>,
54 I<volumeUtility>,
55 I<salvager>,
56 I<salvageServer>,
57 I<volumeServer> and
58 I<volumeSalvager>.
60 =item B<-help>
62 Prints the online help for this command. All other valid options are
63 ignored.
65 =back
67 =head1 PRIVILEGE REQUIRED
69 The issuer must have write access to the file server.
70 Usually, this means that the issuer must be the
71 local superuser C<root> on the file server machine.
73 =head1 SEE ALSO
75 L<fssync-debug_attach(8)>,
76 L<fssync-debug_detach(8)>,
77 L<fssync-debug_online(8)>,
78 L<fssync-debug_offline(8)>,
79 L<fssync-debug_leaveoff(8)>,
80 L<fssync-debug_callback(8)>
82 =head1 COPYRIGHT
84 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
86 This documentation is covered by the IBM Public License Version 1.0.  This
87 man page was written by Davor Ocelic for OpenAFS, based on documentation
88 from Steven Jenkins, Tom Keiser and Simon Wilkinson.