1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY nfs-utils-download-http "http://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
|
---|
8 | <!ENTITY nfs-utils-download-ftp "ftp://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
|
---|
9 | <!ENTITY nfs-utils-md5sum "db97cc425e845e60f0dad855ba6a9830">
|
---|
10 | <!ENTITY nfs-utils-size "520 KB">
|
---|
11 | <!ENTITY nfs-utils-buildsize "8.2 MB">
|
---|
12 | <!ENTITY nfs-utils-time "0.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="nfs-utils" xreflabel="NFS Utilities-&nfs-utils-version;">
|
---|
16 | <?dbhtml filename="nfs-utils.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>NFS Utilities-&nfs-utils-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="nfs-utils">
|
---|
26 | <primary sortas="a-Nfs-utils">NFS Utilities</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to NFS Utilities</title>
|
---|
31 |
|
---|
32 | <para>The <application>NFS Utilities</application> package contains the
|
---|
33 | userspace server and client tools necessary to use the kernel's NFS
|
---|
34 | abilities. NFS is a protocol that allows sharing file systems over the
|
---|
35 | network.</para>
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package information</bridgehead>
|
---|
38 | <itemizedlist spacing='compact'>
|
---|
39 | <listitem>
|
---|
40 | <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download MD5 sum: &nfs-utils-md5sum;</para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download size: &nfs-utils-size;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Estimated disk space required: &nfs-utils-buildsize;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated build time: &nfs-utils-time;</para>
|
---|
56 | </listitem>
|
---|
57 | </itemizedlist>
|
---|
58 |
|
---|
59 | <!--
|
---|
60 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
61 | <itemizedlist spacing='compact'>
|
---|
62 | <listitem>
|
---|
63 | <para>Required patch: <ulink
|
---|
64 | url="&patch-root;/nfs-utils-&nfs-utils-version;-gcc4-1.patch"/></para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 | -->
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
72 | <para role="required"><xref linkend="portmap"/> (Runtime dependency)</para>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Optional for NFSv4 Support</bridgehead>
|
---|
75 | <para role="optional"><xref linkend="pkgconfig"/> and
|
---|
76 | <ulink url="http://www.monkey.org/~provos/libevent/">libevent</ulink> and
|
---|
77 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libnsfidmap</ulink>
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Optional for GSS (RPC Security) Support</bridgehead>
|
---|
81 | <para role="optional"><xref linkend="pkgconfig"/>, and
|
---|
82 | <xref linkend="mitkrb"/> or
|
---|
83 | <xref linkend="heimdal"/> or
|
---|
84 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
|
---|
85 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink>;
|
---|
86 | for additional SPKM-3 support, install
|
---|
87 | <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">SPKM-3</ulink></para>
|
---|
88 |
|
---|
89 | <para condition="html" role="usernotes">User Notes:
|
---|
90 | <ulink url="&blfs-wiki;/nfs-utils"/></para>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2 role="kernel" id='nfs-utils-kernel'>
|
---|
95 | <title>Kernel Configuration</title>
|
---|
96 |
|
---|
97 | <para>Enable the following options in the kernel configuration
|
---|
98 | and recompile the kernel if necessary:</para>
|
---|
99 |
|
---|
100 | <screen><literal>File systems:
|
---|
101 | Network File Systems:
|
---|
102 | NFS File System Support: M or Y
|
---|
103 | NFS Server Support: M or Y</literal></screen>
|
---|
104 |
|
---|
105 | <para>Select the appropriate sub-options that appear when the above options
|
---|
106 | are selected.</para>
|
---|
107 |
|
---|
108 | <indexterm zone="nfs-utils nfs-utils-kernel">
|
---|
109 | <primary sortas="d-nfs-utils">NFS Utilities</primary>
|
---|
110 | </indexterm>
|
---|
111 |
|
---|
112 | </sect2>
|
---|
113 |
|
---|
114 | <sect2 role="installation" id='nfs-utils-install'
|
---|
115 | xreflabel='NFS Utilities Installation'>
|
---|
116 | <title>Installation of NFS Utilities</title>
|
---|
117 |
|
---|
118 | <para>Before you compile the program, ensure that the
|
---|
119 | <systemitem class="username">nobody</systemitem> user and
|
---|
120 | <systemitem class="groupname">nogroup</systemitem> group have been
|
---|
121 | created. You can add them by running the following commands as the
|
---|
122 | <systemitem class="username">root</systemitem> user:</para>
|
---|
123 |
|
---|
124 | <screen role="root"><userinput>groupadd -g 99 nogroup &&
|
---|
125 | useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
|
---|
126 | -s /bin/false -u 99 nobody</userinput></screen>
|
---|
127 |
|
---|
128 | <note>
|
---|
129 | <para>The classic uid and gid values are 65534 which is also -2 when
|
---|
130 | interpreted as a signed 16-bit number. These values impact other files
|
---|
131 | on some filesystems that do not have support for sparse files. The
|
---|
132 | <systemitem class="username">nobody</systemitem> and <systemitem
|
---|
133 | class="groupname">nogroup</systemitem> values are relatively arbitrary.
|
---|
134 | The impact on a server is nil if the <filename>exports</filename> file
|
---|
135 | is configured correctly. If it is misconfigured, an
|
---|
136 | <command>ls -l</command> or <command>ps</command> listing will show a
|
---|
137 | uid or gid number of 65534 instead of a name. The client uses <systemitem
|
---|
138 | class="username">nobody</systemitem> only as the user running
|
---|
139 | <command>rpc.statd</command>.</para>
|
---|
140 | </note>
|
---|
141 |
|
---|
142 | <para>Install <application>NFS Utilities</application> by running
|
---|
143 | the following commands:</para>
|
---|
144 |
|
---|
145 | <screen><userinput>./configure --prefix=/usr \
|
---|
146 | --sysconfdir=/etc \
|
---|
147 | --disable-nfsv4 \
|
---|
148 | --disable-gss &&
|
---|
149 | make</userinput></screen>
|
---|
150 |
|
---|
151 | <para>This package does not come with a test suite.</para>
|
---|
152 |
|
---|
153 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
154 |
|
---|
155 | <note>
|
---|
156 | <para>If your <filename class="directory">/usr</filename> directory
|
---|
157 | is NFS mounted, you should install the executables in
|
---|
158 | <filename class="directory">/sbin</filename> by passing
|
---|
159 | an additional parameter <option>--sbindir=/sbin</option> to the
|
---|
160 | above <command>./configure</command> command.</para>
|
---|
161 | </note>
|
---|
162 |
|
---|
163 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
164 |
|
---|
165 | </sect2>
|
---|
166 |
|
---|
167 | <sect2 role="commands">
|
---|
168 | <title>Command Explanations</title>
|
---|
169 |
|
---|
170 | <para><parameter>--disable-nfsv4</parameter>: Disables support
|
---|
171 | for NFS version 4.</para>
|
---|
172 |
|
---|
173 | <para><parameter>--disable-gss</parameter>: Disables support for
|
---|
174 | RPCSEC GSS (RPC Security).</para>
|
---|
175 |
|
---|
176 | <para><option>--with-tcp-wrappers</option>: Use this option to enable
|
---|
177 | tcpwrappers support.</para>
|
---|
178 |
|
---|
179 | </sect2>
|
---|
180 |
|
---|
181 | <sect2 role="configuration">
|
---|
182 | <title>Configuring NFS Utilities</title>
|
---|
183 |
|
---|
184 | <sect3 id='nfs-utils-server-config'>
|
---|
185 | <title>Server Configuration</title>
|
---|
186 |
|
---|
187 | <para><filename>/etc/exports</filename> contains the exported directories
|
---|
188 | on NFS servers. Refer to the <filename>exports.5</filename> manual page
|
---|
189 | for the syntax of this file. Also refer to the "NFS HowTo" available at
|
---|
190 | <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
|
---|
191 | how to configure the servers and clients in a secure manner. For example,
|
---|
192 | for sharing the <filename class="directory">/home</filename> directory
|
---|
193 | over the local network, the following line may be added:</para>
|
---|
194 |
|
---|
195 | <screen role="root"><userinput>/home <replaceable><192.168.0.0/255.255.255.0></replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
|
---|
196 |
|
---|
197 | <indexterm zone="nfs-utils nfs-utils-server-config">
|
---|
198 | <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
|
---|
199 | </indexterm>
|
---|
200 |
|
---|
201 | <sect4 id="nfs-utils-server-init">
|
---|
202 | <title>Boot Script</title>
|
---|
203 |
|
---|
204 | <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
|
---|
205 | init script included in the <xref
|
---|
206 | linkend="bootscripts"/> package to start the server
|
---|
207 | at boot.</para>
|
---|
208 |
|
---|
209 | <screen role="root"><userinput>make install-nfs-server</userinput></screen>
|
---|
210 |
|
---|
211 | <indexterm zone="nfs-utils nfs-utils-server-init">
|
---|
212 | <primary sortas="f-nfs-server">nfs-server</primary>
|
---|
213 | </indexterm>
|
---|
214 |
|
---|
215 | <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
|
---|
216 | configuration file:</para>
|
---|
217 |
|
---|
218 | <screen role="root"><userinput>cat > /etc/sysconfig/nfs-server << "EOF"
|
---|
219 | <literal>PORT="2049"
|
---|
220 | PROCESSES="8"
|
---|
221 | QUOTAS="no"
|
---|
222 | KILLDELAY="10"</literal>
|
---|
223 | EOF</userinput></screen>
|
---|
224 |
|
---|
225 | <indexterm zone="nfs-utils nfs-utils-server-init">
|
---|
226 | <primary
|
---|
227 | sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
|
---|
228 | </indexterm>
|
---|
229 |
|
---|
230 | </sect4>
|
---|
231 |
|
---|
232 | <sect4 id="nfs-utils-server-wrappers-support">
|
---|
233 | <title>tcpwrappers Configuration</title>
|
---|
234 |
|
---|
235 | <para>If you enabled support for <application>tcpwrappers</application>,
|
---|
236 | ensure you have an entry in the <filename>/etc/hosts.allow</filename>
|
---|
237 | file for access from the <command>portmap</command> daemon if you have a
|
---|
238 | restrictive <filename>/etc/hosts.deny</filename> file.</para>
|
---|
239 |
|
---|
240 | </sect4>
|
---|
241 |
|
---|
242 | </sect3>
|
---|
243 |
|
---|
244 | <sect3 id='nfs-utils-client-config'>
|
---|
245 | <title>Client Configuration</title>
|
---|
246 |
|
---|
247 | <para><filename>/etc/fstab</filename> contains the directories that
|
---|
248 | are to be mounted on the client. Alternately the partitions can be
|
---|
249 | mounted by using the <command>mount</command> command with the proper
|
---|
250 | options. To mount the <filename class="directory">/home</filename>
|
---|
251 | and <filename class="directory">/usr</filename> partitions, add the
|
---|
252 | following to the <filename>/etc/fstab</filename>:</para>
|
---|
253 |
|
---|
254 | <screen role="root"><userinput><server-name>:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
|
---|
255 | <server-name>:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
|
---|
256 |
|
---|
257 | <indexterm zone="nfs-utils nfs-utils-client-config">
|
---|
258 | <primary sortas="e-etc-fstab">/etc/fstab</primary>
|
---|
259 | </indexterm>
|
---|
260 |
|
---|
261 | <sect4 id="nfs-utils-client-init">
|
---|
262 | <title>Boot Script</title>
|
---|
263 |
|
---|
264 | <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename>
|
---|
265 | init script included in the
|
---|
266 | <xref linkend="bootscripts"/> package to
|
---|
267 | start the client services at boot.</para>
|
---|
268 |
|
---|
269 | <screen role="root"><userinput>make install-nfs-client</userinput></screen>
|
---|
270 |
|
---|
271 | <indexterm zone="nfs-utils nfs-utils-client-config">
|
---|
272 | <primary sortas="f-nfs-client">nfs-client</primary>
|
---|
273 | </indexterm>
|
---|
274 |
|
---|
275 | <para>To automatically mount <systemitem
|
---|
276 | class="filesystem">nfs</systemitem> filesystems, clients will also
|
---|
277 | need to install the <filename>netfs</filename> bootscript as described
|
---|
278 | in <xref linkend='postlfs-config-netfs'/>.</para>
|
---|
279 |
|
---|
280 | <indexterm zone="nfs-utils nfs-utils-client-config">
|
---|
281 | <primary sortas="f-netfs">netfs</primary>
|
---|
282 | </indexterm>
|
---|
283 |
|
---|
284 | </sect4>
|
---|
285 |
|
---|
286 | </sect3>
|
---|
287 |
|
---|
288 | </sect2>
|
---|
289 |
|
---|
290 | <sect2 role="content">
|
---|
291 | <title>Contents</title>
|
---|
292 | <segmentedlist>
|
---|
293 | <segtitle>Installed Programs</segtitle>
|
---|
294 | <segtitle>Installed Libraries</segtitle>
|
---|
295 | <segtitle>Installed Directories</segtitle>
|
---|
296 |
|
---|
297 | <seglistitem>
|
---|
298 | <seg>exportfs, nfsstat, nhfsgraph, nhfsnums, nhfsrun, nhfsstone,
|
---|
299 | rpc.lockd, rpc.mountd, rpc.nfsd, rpc.rquotad, rpc.statd,
|
---|
300 | and showmount</seg>
|
---|
301 | <seg>None</seg>
|
---|
302 | <seg>/var/lib/nfs</seg>
|
---|
303 | </seglistitem>
|
---|
304 | </segmentedlist>
|
---|
305 |
|
---|
306 | <variablelist>
|
---|
307 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
308 | <?dbfo list-presentation="list"?>
|
---|
309 | <?dbhtml list-presentation="table"?>
|
---|
310 |
|
---|
311 | <varlistentry id="exportfs">
|
---|
312 | <term><command>exportfs</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>maintains a list of NFS exported file systems.</para>
|
---|
315 | <indexterm zone="nfs-utils exportfs">
|
---|
316 | <primary sortas="b-exportfs">exportfs</primary>
|
---|
317 | </indexterm>
|
---|
318 | </listitem>
|
---|
319 | </varlistentry>
|
---|
320 |
|
---|
321 | <varlistentry id="nfsstat">
|
---|
322 | <term><command>nfsstat</command></term>
|
---|
323 | <listitem>
|
---|
324 | <para>prints NFS statistics.</para>
|
---|
325 | <indexterm zone="nfs-utils nfsstat">
|
---|
326 | <primary sortas="b-nfsstat">nfsstat</primary>
|
---|
327 | </indexterm>
|
---|
328 | </listitem>
|
---|
329 | </varlistentry>
|
---|
330 |
|
---|
331 | <varlistentry id="nhfsgraph">
|
---|
332 | <term><command>nhfsgraph</command></term>
|
---|
333 | <listitem>
|
---|
334 | <para>runs <command>nhfsstone</command> over multiple loads.</para>
|
---|
335 | <indexterm zone="nfs-utils nhfsgraph">
|
---|
336 | <primary sortas="b-nhfsgraph">nhfsgraph</primary>
|
---|
337 | </indexterm>
|
---|
338 | </listitem>
|
---|
339 | </varlistentry>
|
---|
340 |
|
---|
341 | <varlistentry id="nhfsnums">
|
---|
342 | <term><command>nhfsnums</command></term>
|
---|
343 | <listitem>
|
---|
344 | <para>converts raw numbers from <command>nhfsstone</command>
|
---|
345 | output into plot format.</para>
|
---|
346 | <indexterm zone="nfs-utils nhfsnums">
|
---|
347 | <primary sortas="b-nhfsnums">nhfsnums</primary>
|
---|
348 | </indexterm>
|
---|
349 | </listitem>
|
---|
350 | </varlistentry>
|
---|
351 |
|
---|
352 | <varlistentry id="nhfsrun">
|
---|
353 | <term><command>nhfsrun</command></term>
|
---|
354 | <listitem>
|
---|
355 | <para>executes <command>nhfsstone</command> with a range of
|
---|
356 | different loads.</para>
|
---|
357 | <indexterm zone="nfs-utils nhfsrun">
|
---|
358 | <primary sortas="b-nhfsrun">nhfsrun</primary>
|
---|
359 | </indexterm>
|
---|
360 | </listitem>
|
---|
361 | </varlistentry>
|
---|
362 |
|
---|
363 | <varlistentry id="nhfsstone">
|
---|
364 | <term><command>nhfsstone</command></term>
|
---|
365 | <listitem>
|
---|
366 | <para>is used on a NFS client to generate an artificial load
|
---|
367 | with a particular mix of NFS operations.</para>
|
---|
368 | <indexterm zone="nfs-utils nhfsstone">
|
---|
369 | <primary sortas="b-nhfsstone">nhfsstone</primary>
|
---|
370 | </indexterm>
|
---|
371 | </listitem>
|
---|
372 | </varlistentry>
|
---|
373 |
|
---|
374 | <varlistentry id="rpclockd">
|
---|
375 | <term><command>rpc.lockd</command></term>
|
---|
376 | <listitem>
|
---|
377 | <para>starts the NFS lock manager (NLM) on kernels that don't
|
---|
378 | start it automatically. However, since most kernels do start it
|
---|
379 | automatically it is usually not required.</para>
|
---|
380 | <indexterm zone="nfs-utils rpclockd">
|
---|
381 | <primary sortas="b-rpclockd">rpc.lockd</primary>
|
---|
382 | </indexterm>
|
---|
383 | </listitem>
|
---|
384 | </varlistentry>
|
---|
385 |
|
---|
386 | <varlistentry id="rpcmountd">
|
---|
387 | <term><command>rpc.mountd</command></term>
|
---|
388 | <listitem>
|
---|
389 | <para>implements the NFS mount protocol on an NFS server.</para>
|
---|
390 | <indexterm zone="nfs-utils rpcmountd">
|
---|
391 | <primary sortas="b-rpcmountd">rpc.mountd</primary>
|
---|
392 | </indexterm>
|
---|
393 | </listitem>
|
---|
394 | </varlistentry>
|
---|
395 |
|
---|
396 | <varlistentry id="rpcnfsd">
|
---|
397 | <term><command>rpc.nfsd</command></term>
|
---|
398 | <listitem>
|
---|
399 | <para>implements the user level part of the NFS
|
---|
400 | service on the server.</para>
|
---|
401 | <indexterm zone="nfs-utils rpcnfsd">
|
---|
402 | <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
|
---|
403 | </indexterm>
|
---|
404 | </listitem>
|
---|
405 | </varlistentry>
|
---|
406 |
|
---|
407 | <varlistentry id="rpcrquotad">
|
---|
408 | <term><command>rpc.rquotad</command></term>
|
---|
409 | <listitem>
|
---|
410 | <para>is an rpc server which returns quotas for a user of a
|
---|
411 | local file system which is mounted by a remote machine over
|
---|
412 | the NFS.</para>
|
---|
413 | <indexterm zone="nfs-utils rpcrquotad">
|
---|
414 | <primary sortas="b-rpcrquotad">rpc.rquotad</primary>
|
---|
415 | </indexterm>
|
---|
416 | </listitem>
|
---|
417 | </varlistentry>
|
---|
418 |
|
---|
419 | <varlistentry id="rpcstatd">
|
---|
420 | <term><command>rpc.statd</command></term>
|
---|
421 | <listitem>
|
---|
422 | <para>is used by the NFS file locking service,
|
---|
423 | <command>rpc.lockd</command>, to implement lock recovery when
|
---|
424 | the NFS server machine crashes and reboots. Runs on the NFS
|
---|
425 | server only.</para>
|
---|
426 | <indexterm zone="nfs-utils rpcstatd">
|
---|
427 | <primary sortas="b-rpcstatd">rpc.statd</primary>
|
---|
428 | </indexterm>
|
---|
429 | </listitem>
|
---|
430 | </varlistentry>
|
---|
431 |
|
---|
432 | <varlistentry id="showmount">
|
---|
433 | <term><command>showmount</command></term>
|
---|
434 | <listitem>
|
---|
435 | <para>displays mount information for an NFS server.</para>
|
---|
436 | <indexterm zone="nfs-utils showmount">
|
---|
437 | <primary sortas="b-showmount">showmount</primary>
|
---|
438 | </indexterm>
|
---|
439 | </listitem>
|
---|
440 | </varlistentry>
|
---|
441 |
|
---|
442 | </variablelist>
|
---|
443 |
|
---|
444 | </sect2>
|
---|
445 |
|
---|
446 | </sect1>
|
---|