DAFS: document the limits of -vhashsize
[openafs.git] / doc / man-pages / pod8 / dafileserver.pod.in
1 =head1 NAME
2
3 dafileserver - Initializes the File Server component of the dafs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 =include fragments/dafileserver-synopsis.pod
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<dafileserver> command initializes the File Server component of the
18 C<dafs> process. In the conventional configuration, its binary file is
19 located in the F</usr/afs/bin> directory on a file server machine.
20
21 The B<dafileserver> command is not normally issued at the command shell
22 prompt, but rather placed into a database server machine's
23 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
24 ever issued at the command shell prompt, the issuer must be logged onto a
25 file server machine as the local superuser C<root>.
26
27 =include fragments/fileserver-description.pod
28
29 =head1 CAUTIONS
30
31 =include fragments/fileserver-cautions.pod
32
33 =head1 OPTIONS
34
35 =include fragments/fileserver-options.pod
36
37 =item B<-fs-state-dont-save>
38
39 When present, fileserver state will not be saved during shutdown.  Default
40 is to save state.
41
42 =item B<-fs-state-dont-restore>
43
44 When present, fileserver state will not be restored during startup.
45 Default is to restore state on startup.
46
47 =item B<-fs-state-verify> (none | save | restore | both)
48
49 This argument controls the behavior of the state verification mechanism.
50 A value of C<none> turns off all verification.  A value of C<save> only
51 performs the verification steps prior to saving state to disk.  A value
52 of C<restore> only performs the verification steps after restoring state
53 from disk.  A value of C<both> performs all verifications steps both
54 prior to save and following a restore.
55
56 The default is C<both>.
57
58 =item B<-vhashsize <I<size>>
59
60 The log(2) number of of volume hash buckets.  Default is 8 (i.e., by
61 default, there are 2^8 = 256 volume hash buckets). The minimum that can
62 be specified is 6 (64 hash buckets). In OpenAFS 1.5.77 and earlier, the
63 maximum that can be specified is 14 (16384 buckets). After 1.5.77, the
64 maximum that can be specified is 28 (268435456 buckets).
65
66 =item B<-vlruthresh <I<minutes>>
67
68 The number of minutes of inactivity before a volume is eligible for soft
69 detachment.  Default is 120 minutes.
70
71 =item B<-vlruinterval <I<seconds>>
72
73 The number of seconds between VLRU candidate queue scan.  The default is
74 120 seconds.
75
76 =item B<-vlrumax <I<positive integer>>
77
78 The maximum number of volumes which can be soft detached in a single pass
79 of the scanner.  Default is 8 volumes.
80
81 =item B<-unsafe-nosalvage>
82
83 This option causes the fileserver to bypass the normal safety check when
84 attaching volumes that checks the inUse field in the volume header. With
85 this option, volumes that were in use at the time of an unclean shutdown
86 will not be salvaged immediately the next time they are accessed, and thus
87 risk (possibly silent and/or irrevocable) corruption. Volumes will still
88 be salvaged when an internal inconsistency is detected or other cases
89 where a salvage would normally occur.
90
91 Due to the increased risk of data corruption, the use of this flag is
92 strongly discouraged. Only use it if you really know what you are doing.
93
94 =back
95
96 =head1 EXAMPLES
97
98 The following B<bos create> command creates a dafs process on
99 the file server machine C<fs2.abc.com> that uses the large configuration
100 size, and allows volumes to exceed their quota by 10%. Type the command on
101 a single line:
102
103    % bos create -server fs2.abc.com -instance dafs -type dafs \
104                 -cmd "/usr/afs/bin/fileserver -pctspare 10 -L" \
105                 /usr/afs/bin/volserver \
106                 /usr/afs/bin/salvageserver \
107                 /usr/afs/bin/salvager
108
109 =head1 TROUBLESHOOTING
110
111 =include fragments/fileserver-troubleshooting.pod
112
113 =head1 PRIVILEGE REQUIRED
114
115 =include fragments/fileserver-privilege.pod
116
117 =head1 SEE ALSO
118
119 =include fragments/fileserver-also.pod
120 L<fileserver(8)>,
121
122 =head1 COPYRIGHT
123
124 =include fragments/fileserver-copyright.pod