Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / fssync-debug_volop.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fssync-debug_volop - Display pending volume operation info (FSYNC_VOL_QUERY_VOP opcode)
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fssync-debug volop> 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
16B<fssync-debug vo> 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
21B<fssync-debug vop> S<<< B<-v> <I<volume ID>> >>>
22 S<<< [B<-pa> <I<exact partition name>>] >>>
23 S<<< [B<-r> <I<sync protocol reason code>>] >>>
24 S<<< [B<-pr> <I<program type code>>] >>>
25 [B<-h>]
26 [B<-h>]
27
28=for html
29</div>
30
31=head1 DESCRIPTION
32
33The B<fssync-debug volop> command displays information about the
34pending volume operation for a given volume, if any.
35
36=head1 OPTIONS
37
38=over 4
39
40=item B<-volumeid> <I<volume ID>>
41
42Specifies the numeric volume ID. Volume names are not permitted.
43
44=item B<-partition> <I<exact partition name>>
45
46Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
47are not permitted.
48
49=item B<-reason> <I<sync protocol reason code>>
50
51Specifies numeric sync protocol reason code.
52Available codes are listed in OpenAFS source file
53F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
54use B<-reason I<0>>.
55
56=item B<-programtype> <I<program type code>>
57
58Specifies program type code. Permitted values are
59I<fileServer>,
60I<volumeUtility>,
61I<salvager>,
62I<salvageServer>,
63I<volumeServer> and
64I<volumeSalvager>.
65
66=item B<-help>
67
68Prints the online help for this command. All other valid options are
69ignored.
70
71=back
72
73=head1 PRIVILEGE REQUIRED
74
75The issuer must have write access to the file server.
76Usually, this means that the issuer must be the
77local superuser C<root> on the file server machine.
78
79=head1 SEE ALSO
80
81L<fssync-debug_attach(8)>,
82L<fssync-debug_detach(8)>,
83L<fssync-debug_mode(8)>,
84L<fssync-debug_online(8)>,
85L<fssync-debug_offline(8)>,
86L<fssync-debug_error(8)>
87
88=head1 COPYRIGHT
89
90Copyright 2010 Sine Nomine Associates
91
92This documentation is covered by the IBM Public License Version 1.0. This
93man page was written by Andrew Deason and Davor Ocelic for OpenAFS.