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