share/man/man1m/nfsd.1m

   1 .\"
   2 .\" The contents of this file are subject to the terms of the
   3 .\" Common Development and Distribution License (the "License").
   4 .\" You may not use this file except in compliance with the License.
   5 .\"
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   7 .\" or http://www.opensolaris.org/os/licensing.
   8 .\" See the License for the specific language governing permissions
   9 .\" and limitations under the License.
  10 .\"
  11 .\" When distributing Covered Code, include this CDDL HEADER in each
  12 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  13 .\" If applicable, add the following below this CDDL HEADER, with the
  14 .\" fields enclosed by brackets "[]" replaced with your own identifying
  15 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  16 .\"
  17 .\"
  18 .\" Copyright 1989 AT&T
  19 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
  20 .\" Copyright 2016 Nexenta Systems, Inc.
  21 .\"
  22 .Dd March 12, 2016
  23 .Dt NFSD 1M
  24 .Os
  25 .Sh NAME
  26 .Nm nfsd
  27 .Nd NFS daemon
  28 .Sh SYNOPSIS
  29 .Nm /usr/lib/nfs/nfsd
  30 .Op Fl a
  31 .Op Fl c Ar max_conn
  32 .Op Fl l Ar listen_backlog
  33 .Op Fl p Ar protocol
  34 .Op Fl t Ar device
  35 .Op Ar nservers
  36 .Sh DESCRIPTION
  37 .Nm
  38 is the daemon that handles client file system requests. Only users with
  39 .Brq Sy PRIV_SYS_NFS
  40 and sufficient privileges to write to
  41 .Pa /var/run
  42 can run this daemon.
  43 .Pp
  44 The
  45 .Nm
  46 daemon is automatically invoked using
  47 .Xr share 1M
  48 with the
  49 .Fl a
  50 option.
  51 .Pp
  52 By default,
  53 .Nm
  54 starts over the TCP and UDP transports for versions 2 and 3. By default, it
  55 starts over the TCP for version 4. You can change this
  56 with the
  57 .Fl p
  58 option.
  59 .Pp
  60 A previously invoked
  61 .Nm
  62 daemon started with or without options must be stopped before invoking another
  63 .Nm
  64 command.
  65 .Pp
  66 See
  67 .Xr nfs 4
  68 for available configuration properties for
  69 .Nm .
  70 .Ss Options
  71 The following options are supported:
  72 .Bl -tag -width Ds
  73 .It Fl a
  74 Start a NFS daemon over all available connectionless and connection-oriented
  75 transports, including UDP and TCP. Equivalent of setting the
  76 .Sy protocol
  77 property to
  78 .Sy all .
  79 .It Fl c Ar max_conn
  80 Set the maximum number of connections allowed to the NFS server over
  81 connection-oriented transports. By default, the number of connections is
  82 unlimited. Equivalent of the
  83 .Sy max_connections
  84 property.
  85 .It Fl l
  86 Set connection queue length for the NFS server over a connection-oriented
  87 transport. The default value is 32 entries. Equivalent of the
  88 .Sy listen_backlog
  89 property.
  90 .It Fl p Ar protocol
  91 Start a NFS daemon over the specified protocol. Equivalent of the
  92 .Sy protocol
  93 property.
  94 .It Fl t Ar device
  95 Start a NFS daemon for the transport specified by the given device. Equivalent
  96 of the
  97 .Sy device
  98 property.
  99 .El
 100 .Ss Operands
 101 The following operands are supported:
 102 .Bl -tag -width Ds
 103 .It Ar nservers
 104 This sets the maximum number of concurrent NFS requests that the server can
 105 handle. This concurrency is achieved by up to
 106 .Ar nservers
 107 threads created as needed in the kernel.
 108 .Ar nservers
 109 should be based on the load expected on this server. 16 is the usual number of
 110 .Ar nservers .
 111 If
 112 .Ar nservers
 113 is not specified, the maximum number of concurrent NFS requests will default to
 114 1. Equivalent of the
 115 .Sy servers
 116 property.
 117 .El
 118 .Ss Usage
 119 If the
 120 .Sy nfs_portmon
 121 variable is set to non-zero value in
 122 .Pa /etc/system ,
 123 then clients are required to use privileged ports
 124 .Po ports <
 125 .Dv IPPORT_RESERVED
 126 .Pc
 127 to get NFS services. This variable is equal to zero by default. This variable
 128 has been moved from the
 129 .Qq nfs
 130 module to the
 131 .Qq nfssrv
 132 module. To set the variable, edit the
 133 .Pa /etc/system
 134 file and add this entry:
 135 .Bd -literal -offset indent
 136 set nfssrv:nfs_portmon = 1
 137 .Ed
 138 .Sh FILES
 139 .Bl -tag -width Ds
 140 .It Pa \&.nfsXXX
 141 Client machine pointer to an open-but-unlinked file.
 142 .It Pa /etc/system
 143 System configuration information file.
 144 .It Xo
 145 .Pa /var/nfs/v4_state
 146 .br
 147 .Pa /var/nfs/v4_oldstate
 148 .Xc
 149 Directories used by the server to manage client state information. These
 150 directories should not be removed.
 151 .El
 152 .Sh EXIT STATUS
 153 .Bl -tag -width Ds
 154 .It Sy 0
 155 Daemon started successfully.
 156 .It Sy 1
 157 Daemon failed to start.
 158 .El
 159 .Sh SEE ALSO
 160 .Xr svcs 1 ,
 161 .Xr mountd 1M ,
 162 .Xr share 1M ,
 163 .Xr sharectl 1M ,
 164 .Xr sharemgr 1M ,
 165 .Xr svcadm 1M ,
 166 .Xr nfs 4 ,
 167 .Xr sharetab 4 ,
 168 .Xr system 4 ,
 169 .Xr attributes 5 ,
 170 .Xr smf 5
 171 .Sh NOTES
 172 Manually starting and restarting
 173 .Nm
 174 is not recommended. If it is necessary to do so, use
 175 .Nm svcadm
 176 to enable or disable the nfs service
 177 .Pq svc:/network/nfs/server .
 178 If it is disabled, it will be enabled by
 179 .Xr share_nfs 1M ,
 180 unless its
 181 .Sy application Ns / Ns Sy auto_enable
 182 property is set to
 183 .Sy false .
 184 See the , and
 185 .Xr svcadm 1M
 186 for more information.
 187 .Pp
 188 The
 189 .Nm
 190 service is managed by the service management facility,
 191 .Xr smf 5 ,
 192 under the service identifier:
 193 .Bd -literal -offset indent
 194 svc:/network/nfs/server
 195 .Ed
 196 .Pp
 197 Administrative actions on this service, such as enabling, disabling, or
 198 requesting restart, can be performed using
 199 .Xr svcadm 1M .
 200 The service's status can be queried using the
 201 .Xr svcs 1
 202 command.
 203 .Pp
 204 If
 205 .Nm
 206 is killed with
 207 .Sy SIGTERM ,
 208 it will not be restarted by the service management facility. Instead,
 209 .Nm
 210 can be restarted by other signals, such as
 211 .Sy SIGINT .