Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / fssync-debug_vgcscan.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fssync-debug_vgcscan - Force a VG cache rescan (FSYNC_VG_SCAN opcode)
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fssync-debug vgcscan>
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 vgcscan>
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
27The B<fssync-debug vgcscan> command forces a rescan of the volume group
28cache (VGC) for a particular partition.
29
30=head1 OPTIONS
31
32=over 4
33
34=item B<-partition> <I<exact partition name>>
35
36Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
37are not permitted.
38
39=item B<-reason> <I<sync protocol reason code>>
40
41Specifies numeric sync protocol reason code.
42Available codes are listed in OpenAFS source file
43F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
44use B<-reason I<0>>.
45
46=item B<-programtype> <I<program type code>>
47
48Specifies program type code. Permitted values are
49I<fileServer>,
50I<volumeUtility>,
51I<salvager>,
52I<salvageServer>,
53I<volumeServer> and
54I<volumeSalvager>.
55
56=item B<-help>
57
58Prints the online help for this command. All other valid options are
59ignored.
60
61=back
62
63=head1 PRIVILEGE REQUIRED
64
65The issuer must have write access to the file server.
66Usually, this means that the issuer must be the
67local superuser C<root> on the file server machine.
68
69=head1 SEE ALSO
70
71L<fssync-debug_vgcadd(8)>,
72L<fssync-debug_vgcdel(8)>,
73L<fssync-debug_vgcquery(8)>,
74L<fssync-debug_vgcscanall(8)>,
75
76=head1 COPYRIGHT
77
78Copyright 2010 Sine Nomine Associates
79
80This documentation is covered by the IBM Public License Version 1.0. This
81man page was written by Andrew Deason and Davor Ocelic for OpenAFS.