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