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