source: networking/netprogs/nfs-utils.xml@ 71c31f5

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY nfs-utils-download-http "&sourceforge-repo;/nfs/nfs-utils-&nfs-utils-version;.tar.bz2">
  <!ENTITY nfs-utils-download-ftp  " ">
  <!ENTITY nfs-utils-md5sum        "9b87d890669eaaec8e97a2b0a35b2665">
  <!ENTITY nfs-utils-size          "776 KB">
  <!ENTITY nfs-utils-buildsize     "14 MB">
  <!ENTITY nfs-utils-time          "0.2 SBU">
]>

<sect1 id="nfs-utils" xreflabel="nfs-utils-&nfs-utils-version;">
  <?dbhtml filename="nfs-utils.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>NFS-Utils-&nfs-utils-version;</title>

  <indexterm zone="nfs-utils">
    <primary sortas="a-Nfs-utils">NFS Utilities</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to NFS Utilities</title>

    <para>The <application>NFS Utilities</application> package contains the
    userspace server and client tools necessary to use the kernel's NFS
    abilities. NFS is a protocol that allows sharing file systems over the
    network.</para>

    &lfs78_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &nfs-utils-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &nfs-utils-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &nfs-utils-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &nfs-utils-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libtirpc"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libevent"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="libnfsidmap"/> (for NFSv4 support),
      <xref linkend="mitkrb"/> or
      <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
      <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink> (for GSS and RPC security support) and
      <xref linkend="libcap-pam"/>
    </para>

    <bridgehead renderas="sect4">Required (runtime)</bridgehead>
    <para role="required">
      <xref linkend="rpcbind"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/nfs-utils"/></para>

  </sect2>

  <sect2 role="kernel" id='nfs-utils-kernel'>
    <title>Kernel Configuration</title>

    <para>Enable the following options in the kernel configuration
    and recompile the kernel if necessary:</para>

<screen><literal>File systems  ---&gt;
  [*] Network File Systems  ---&gt;         [CONFIG_NETWORK_FILESYSTEMS]
    &lt;*/M&gt; NFS client support             [CONFIG_NFS_FS]
    &lt;*/M&gt; NFS server support             [CONFIG_NFSD]</literal></screen>

    <para>Select the appropriate sub-options that appear when the above options
    are selected.</para>

    <indexterm zone="nfs-utils nfs-utils-kernel">
      <primary sortas="d-nfs-utils">NFS Utilities</primary>
    </indexterm>

  </sect2>

  <sect2 role="installation" id='nfs-utils-install'
         xreflabel='NFS Utilities Installation'>
    <title>Installation of NFS Utilities</title>

    <para>Install <application>NFS Utilities</application> by running
    the following commands:</para>

<screen><userinput>./configure --prefix=/usr          \
            --sysconfdir=/etc      \
            --without-tcp-wrappers \
            --disable-nfsv4        \
            --disable-gss &amp;&amp;
make</userinput></screen>

    <para>If your <filename class="directory">/usr</filename> directory
    is NFS mounted, you should install the executables in
    <filename class="directory">/sbin</filename> by passing
    an additional parameter <option>--sbindir=/sbin</option> to the
    above <command>./configure</command> command.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<!-- dev note: make statduser=$(whoami) DESTDIR=<DESTDIR> install -->

<screen role='root'><userinput>make install &amp;&amp;
chmod u+w,go+r /sbin/mount.nfs</userinput></screen>

    <para>The tests for this package require that the package be installed and
    configured as specified below.  In addition, the the daemon from <xref
    linkend="rpcbind"/> needs to be running and the tests need to be run as the
    <systemitem class="username">root</systemitem> user.</para>

    <para>To test the results, issue, as root: <command>make check</command>.</para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--without-tcp-wrappers</parameter>: This option is
    needed because TCP Wrappers is not in BLFS.</para>

    <para><parameter>--disable-nfsv4</parameter>: Disables support
    for NFS version 4.</para>

    <para><parameter>--disable-gss</parameter>: Disables support for
    RPCSEC GSS (RPC Security).</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring NFS Utilities</title>

    <sect3 id='nfs-utils-server-config'>
      <title>Server Configuration</title>

      <para><filename>/etc/exports</filename> contains the exported directories
      on NFS servers. Refer to the <filename>exports.5</filename> manual page
      for the syntax of this file. Also refer to the "NFS HowTo" available at
      <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
      how to configure the servers and clients in a secure manner. For example,
      for sharing the <filename class="directory">/home</filename> directory
      over the local network, the following line may be added:</para>

<screen role="root"><userinput>/home <replaceable>192.168.0.0/24</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>

      <note><para>Be sure to replace the directory, network address. and prefix above
      to match your network.  The only space in the line above should be between
      the directory and the network address.</para></note>

      <indexterm zone="nfs-utils nfs-utils-server-config">
        <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
      </indexterm>

      <sect4 id="nfs-utils-server-init">
        <title>Systemd Units</title>

        <para>
          To start the NFS server daemons at boot,
          install the systemd units from the <xref linkend="bootscripts"/>
          package by running the following command as the
          <systemitem class="username">root</systemitem> user:
        </para>

<screen role="root"><userinput>make install-nfsv4-server</userinput></screen>

        <para>
          If you have disabled NFSv4 support, run the following
          command as the <systemitem
          class="username">root</systemitem> user to omit the NFSv4
          specific systemd units:
        </para>

<screen role="root"><userinput>make install-nfs-server</userinput></screen>

        <indexterm zone="nfs-utils nfs-utils-server-init">
          <primary sortas="f-nfs-server">nfs-server</primary>
        </indexterm>

        <para>
          You can edit the <filename>/etc/default/nfs-utils</filename>
          file to change the startup options for NFS daemons. Defaults
          should be fine for most use cases.
        </para>

        <indexterm zone="nfs-utils nfs-utils-server-init">
          <primary sortas="e-etc-default-nfs-utils">/etc/default/nfs-utils</primary>
        </indexterm>

      </sect4>

    </sect3>

    <sect3 id='nfs-utils-client-config'>
      <title>Client Configuration</title>

      <para><filename>/etc/fstab</filename> contains the directories that
      are to be mounted on the client. Alternately the partitions can be
      mounted by using the <command>mount</command> command with the proper
      options. To mount the <filename class="directory">/home</filename>
      and <filename class="directory">/usr</filename> partitions, add the
      following to the <filename>/etc/fstab</filename>:</para>

<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home  /home nfs   rw,_netdev 0 0
<replaceable>&lt;server-name&gt;</replaceable>:/usr   /usr  nfs   ro,_netdev 0 0</userinput></screen>

      <para>The options which can be used are specified in <command>man 5 nfs</command>.
      If both the client and server are running recent versions of linux, most of the
      options will be negotiated. You can specify either <literal>rw</literal> or
      <literal>ro</literal>, <literal>_netdev</literal> if the filesystem is to be
      automatically mounted at boot, or <literal>noauto</literal> (and perhaps
      <literal>user</literal>) for other filesystems.</para>

      <para>If the fileserver is not running a recent version of linux, you may need to
      specifiy other options.</para>

      <para>If you are using systemd, you may need to enable autofs v4 in your kernel,
      and add the option <literal>comment=systemd.automount</literal>. Some machines
      need this, because systemd tries to mount the external fs&apos;s before the network
      is up, others do not need it. An alternative is for <systemitem
      class="username">root</systemitem> to run <command>mount -a</command>.</para>

      <indexterm zone="nfs-utils nfs-utils-client-config">
        <primary sortas="e-etc-fstab">/etc/fstab</primary>
      </indexterm>

      <sect4  id="nfs-utils-client-init">
        <title>Systemd Units</title>

        <note>
          <para>
            The following systemd unis are not required if the
            nfs-server units were previously installed.
          </para>
        </note>

        <para>
          To start the NFS client services at boot,
          install the systemd units from the <xref linkend="bootscripts"/>
          package by running the following command as the
          <systemitem class="username">root</systemitem> user:
        </para>

<screen role="root"><userinput>make install-nfs-client</userinput></screen>

        <indexterm zone="nfs-utils nfs-utils-client-config">
          <primary sortas="f-nfs-client">nfs-client</primary>
        </indexterm>

      </sect4>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>
    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
        nfsiostat, nfsstat, osd_login, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
        showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
        and umount.nfs4  (link to mount.nfs)</seg>
        <seg>None</seg>
        <seg>/var/lib/nfs</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="exportfs">
        <term><command>exportfs</command></term>
        <listitem>
          <para>maintains a list of NFS exported file systems.</para>
          <indexterm zone="nfs-utils exportfs">
            <primary sortas="b-exportfs">exportfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mountstats">
        <term><command>mountstats</command></term>
        <listitem>
          <para>displays NFS client per-mount statistics.</para>
          <indexterm zone="nfs-utils mountstats">
            <primary sortas="b-mountstats">mountstats</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mount.nfs">
        <term><command>mount.nfs</command></term>
        <listitem>
          <para>Used to mount a network share using NFS</para>
          <indexterm zone="nfs-utils mount.nfs">
            <primary sortas="b-mount.nfs">mount.nfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mount.nfs4">
        <term><command>mount.nfs4</command></term>
        <listitem>
          <para>Used to mount a network share using NFSv4</para>
          <indexterm zone="nfs-utils mount.nfs4">
            <primary sortas="b-mount.nfs4">mount.nfs4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nfsiostat-nfs-utils">
        <term><command>nfsiostat</command></term>
        <listitem>
          <para>Report input/output statistics for network filesystems.</para>
          <indexterm zone="nfs-utils nfsiostat-nfs-utils">
            <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nfsstat">
        <term><command>nfsstat</command></term>
        <listitem>
          <para>displays statistics kept about NFS client and server activity.</para>
          <indexterm zone="nfs-utils nfsstat">
            <primary sortas="b-nfsstat">nfsstat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="osd_login">
        <term><command>osd_login</command></term>
        <listitem>
          <para>is a script that is a part of the autologin feature
           mandated by the pnfs-objects standard.</para>
          <indexterm zone="nfs-utils osd_login">
            <primary sortas="b-osd_login">osd_login</primary>
          </indexterm>
        </listitem>
      </varlistentry>


      <varlistentry id="rpc.mountd">
        <term><command>rpc.mountd</command></term>
        <listitem>
          <para>implements the NFS mount protocol on an NFS server.</para>
          <indexterm zone="nfs-utils rpc.mountd">
            <primary sortas="b-rpc.mountd">rpc.mountd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpc.nfsd">
        <term><command>rpc.nfsd</command></term>
        <listitem>
          <para>implements the user level part of the NFS
          service on the server.</para>
          <indexterm zone="nfs-utils rpc.nfsd">
            <primary sortas="b-rpc.nfsd">rpc.nfsd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpc.statd">
        <term><command>rpc.statd</command></term>
        <listitem>
          <para>is used by the NFS file locking service. Run on both sides,
          client as well as server, when you want file locking enabled.</para>
          <indexterm zone="nfs-utils rpc.statd">
            <primary sortas="b-rpc.statd">rpc.statd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpcdebug">
        <term><command>rpcdebug</command></term>
        <listitem>
          <para>sets or clears the kernel's NFS client and server debug
          flags.</para>
          <indexterm zone="nfs-utils rpcdebug">
            <primary sortas="b-rpcdebug">rpcdebug</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="showmount">
        <term><command>showmount</command></term>
        <listitem>
          <para>displays mount information for an NFS server.</para>
          <indexterm zone="nfs-utils showmount">
            <primary sortas="b-showmount">showmount</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sm-notify">
        <term><command>sm-notify</command></term>
        <listitem>
          <para>is used to send Network Status Monitor reboot messages.</para>
          <indexterm zone="nfs-utils sm-notify">
            <primary sortas="b-sm-notify">sm-notify</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="start-statd">
        <term><command>start-statd</command></term>
        <listitem>
          <para>is a script called by nfsmount when mounting a filesystem with
          locking enabled, if statd does not appear to be running. It can be
          customised with whatever flags are appropriate for the site.</para>
          <indexterm zone="nfs-utils start-statd">
            <primary sortas="b-start-statd">start-statd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="umount.nfs">
        <term><command>umount.nfs</command></term>
        <listitem>
          <para>Used to unmount a network share using NFS</para>
          <indexterm zone="nfs-utils umount.nfs">
            <primary sortas="b-umount.nfs">umount.nfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="umount.nfs4">
        <term><command>umount.nfs4</command></term>
        <listitem>
          <para>Used to unmount a network share using NFSv4</para>
          <indexterm zone="nfs-utils umount.nfs4">
            <primary sortas="b-umount.nfs4">umount.nfs4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>