fa47331ebf147fd6787234a8363f38b022ceb37d
[openafs.git] / doc / man-pages / pod8 / fssync-debug_vgcdel.pod
1 =head1 NAME
2
3 fssync-debug_vgcdel - Delete an entry from the VG cache (FSYNC_VG_UPDATE opcode)
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fssync-debug vgcdel>
11     S<<< B<-partition> <I<exact partition name>> >>>
12     S<<< B<-parent> <I<volume ID>> >>>
13     S<<< B<-child> <I<volume ID>> >>>
14     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
15     S<<< [B<-programtype> <I<program type code>>] >>>
16     [B<-help>]
17
18 B<fssync-debug vgcd>
19     S<<< B<-part> <I<exact partition name>> >>>
20     S<<< B<-pare> <I<volume ID>> >>>
21     S<<< B<-c> <I<volume ID>> >>>
22     S<<< [B<-r> <I<sync protocol reason code>>] >>>
23     S<<< [B<-pr> <I<program type code>>] >>>
24     [B<-h>]
25
26 =for html
27 </div>
28
29 =head1 DESCRIPTION
30
31 The B<fssync-debug vgcdel> command deletes an entry from the volume
32 group cache (VGC).
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-partition> <I<exact partition name>>
39
40 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
41 are not permitted.
42
43 =item B<-parent> <I<volume ID>>
44
45 Specifies the numeric volume ID for the parent volume of the VGC entry.
46
47 =item B<-child> <I<volume ID>>
48
49 Specifies the numeric volume ID for the child volume in the VGC entry
50 to delete.
51
52 =item B<-reason> <I<sync protocol reason code>>
53
54 Specifies numeric sync protocol reason code.
55 Available codes are listed in OpenAFS source file
56 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
57 use B<-reason I<0>>.
58
59 =item B<-programtype> <I<program type code>>
60
61 Specifies program type code. Permitted values are
62 I<fileServer>,
63 I<volumeUtility>,
64 I<salvager>,
65 I<salvageServer>,
66 I<volumeServer> and
67 I<volumeSalvager>.
68
69 =back
70
71 =head1 PRIVILEGE REQUIRED
72
73 The issuer must have write access to the file server.
74 Usually, this means that the issuer must be the
75 local superuser C<root> on the file server machine.
76
77 =head1 SEE ALSO
78
79 L<fssync-debug_vgcadd(8)>,
80 L<fssync-debug_vgcquery(8)>,
81 L<fssync-debug_vgcscan(8)>,
82 L<fssync-debug_vgcscanall(8)>,
83
84 =head1 COPYRIGHT
85
86 Copyright 2010 Sine Nomine Associates
87
88 This documentation is covered by the IBM Public License Version 1.0. This
89 man page was written by Andrew Deason and Davor Ocelic for OpenAFS.