usr/src/man/man1m/nfsd.1m

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH NFSD 1M "Jul 22, 2008"
   8 .SH NAME
   9 nfsd \- NFS daemon
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/nfs/nfsd\fR [\fB-a\fR] [\fB-c\fR \fI#_conn\fR] [\fB-l\fR \fIlisten_backlog\fR]
  14      [\fB-p\fR \fIprotocol\fR] [\fB-t\fR \fIdevice\fR] [\fInservers\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 \fBnfsd\fR is the daemon that handles client file system requests. Only users
  21 with \fB{PRIV_SYS_NFS}\fR and sufficient privileges to write to \fB/var/run\fR
  22 can run this daemon.
  23 .sp
  24 .LP
  25 The \fBnfsd\fR daemon is automatically invoked using \fBshare\fR(1M) with the
  26 \fB-a\fR option.
  27 .sp
  28 .LP
  29 By default, \fBnfsd\fR starts over the TCP and UDP transports for versions 2
  30 and 3. By default, it starts over the TCP for version 4. You can change this
  31 with the \fB-p\fR option.
  32 .sp
  33 .LP
  34 A previously invoked \fBnfsd\fR daemon started with or without options must be
  35 stopped before invoking another \fBnfsd\fR command.
  36 .sp
  37 .LP
  38 To change startup parameters for \fBnfsd\fR, use the \fBsharectl\fR(1M) and
  39 \fBsharemgr\fR(1M) commands.
  40 .SH OPTIONS
  41 .sp
  42 .LP
  43 The following options are supported:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-a\fR\fR
  48 .ad
  49 .RS 15n
  50 Start a \fBNFS\fR daemon over all available connectionless and
  51 connection-oriented transports, including UDP and TCP. Equivalent of setting
  52 the \fBNFSD_PROTOCOL\fR parameter to \fBALL\fR in the \fBnfs\fR file.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB-c\fR \fI#_conn\fR\fR
  59 .ad
  60 .RS 15n
  61 This sets the maximum number of connections allowed to the \fBNFS\fR server
  62 over connection-oriented transports. By default, the number of connections is
  63 unlimited. Equivalent of the \fBNFSD_MAX_CONNECTIONS\fR parameter in the
  64 \fBnfs\fR file.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB-l\fR\fR
  71 .ad
  72 .RS 15n
  73 Set connection queue length for the \fBNFS TCP\fR over a connection-oriented
  74 transport. The default value is 32 entries. Equivalent of the
  75 \fBNFSD_LISTEN_BACKLOG\fR parameter in the \fBnfs\fR file.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-p\fR \fIprotocol\fR\fR
  82 .ad
  83 .RS 15n
  84 Start a \fBNFS\fR daemon over the specified protocol. Equivalent of the
  85 \fBNFSD_PROTOCOL\fR parameter in the \fBnfs\fR file.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fB-t\fR \fIdevice\fR\fR
  92 .ad
  93 .RS 15n
  94 Start a \fBNFS\fR daemon for the transport specified by the given device.
  95 Equivalent of the \fBNFSD_DEVICE\fR parameter in the \fBnfs\fR file.
  96 .RE
  97
  98 .SH OPERANDS
  99 .sp
 100 .LP
 101 The following operands are supported:
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fInservers\fR\fR
 106 .ad
 107 .RS 12n
 108 This sets the maximum number of concurrent \fBNFS\fR requests that the server
 109 can handle. This concurrency is achieved by up to \fInservers\fR threads
 110 created as needed in the kernel. \fInservers\fR should be based on the load
 111 expected on this server. 16 is the usual number of \fInservers\fR. If
 112 \fInservers\fR is not specified, the maximum number of concurrent \fBNFS\fR
 113 requests will default to 1. Equivalent of the \fBNFSD_SERVERS\fR parameter in
 114 the \fBnfs\fR file.
 115 .RE
 116
 117 .SH USAGE
 118 .sp
 119 .LP
 120 If the \fBNFS_PORTMON\fR variable is set in \fB/etc/system\fR, then clients are
 121 required to use privileged ports (ports < \fBIPPORT_RESERVED\fR) to get
 122 \fBNFS\fR services. This variable is equal to zero by default. This variable
 123 has been moved from the "nfs" module to the "nfssrv" module. To set the
 124 variable, edit the \fB/etc/system\fR file and add this entry:
 125 .sp
 126 .LP
 127 \fBset\fR \fBnfssrv:nfs_portmon\fR \fB=\fR \fB1\fR
 128 .SH EXIT STATUS
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB0\fR\fR
 133 .ad
 134 .RS 5n
 135 Daemon started successfully.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB1\fR\fR
 142 .ad
 143 .RS 5n
 144 Daemon failed to start.
 145 .RE
 146
 147 .SH FILES
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB\&.nfs\fIXXX\fR\fR\fR
 152 .ad
 153 .RS 24n
 154 Client machine pointer to an open-but-unlinked file.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB/etc/default/nfs\fR\fR
 161 .ad
 162 .RS 24n
 163 Contains startup parameters for \fBnfsd\fR.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB/etc/system\fR\fR
 170 .ad
 171 .RS 24n
 172 System configuration information file.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fB/var/nfs/v4_state\fR\fR
 179 .ad
 180 .br
 181 .na
 182 \fB\fB/var/nfs/v4_oldstate\fR\fR
 183 .ad
 184 .RS 24n
 185 Directories used by the server to manage client state information. These
 186 directories should not be removed.
 187 .RE
 188
 189 .SH SEE ALSO
 190 .sp
 191 .LP
 192 \fBps\fR(1), \fBsvcs\fR(1), \fBmountd\fR(1M), \fBshare\fR(1M),
 193 \fBsharectl\fR(1M), \fBsharemgr\fR(1M), \fBsvcadm\fR(1M), \fBnfs\fR(4),
 194 \fBsharetab\fR(4), \fBsystem\fR(4), \fBattributes\fR(5), \fBsmf\fR(5)
 195 .sp
 196 .LP
 197 \fI\fR
 198 .SH NOTES
 199 .sp
 200 .LP
 201 Manually starting and restarting \fBnfsd\fR is not recommended. If it is
 202 necessary to do so, use \fBsvcadm\fR to enable or disable the \fBnfs\fR service
 203 (\fBsvc:/network/nfs/server\fR). If it is disabled, it will be enabled by
 204 \fBshare_nfs\fR(1M), unless its \fBapplication/auto_enable\fR property is set
 205 to \fBfalse\fR. See the \fI\fR, and \fBsvcadm\fR(1M) for more information.
 206 .sp
 207 .LP
 208 The \fBnfsd\fR service is managed by the service management facility,
 209 \fBsmf\fR(5), under the service identifier:
 210 .sp
 211 .in +2
 212 .nf
 213 svc:/network/nfs/server
 214 .fi
 215 .in -2
 216 .sp
 217
 218 .sp
 219 .LP
 220 Administrative actions on this service, such as enabling, disabling, or
 221 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 222 status can be queried using the \fBsvcs\fR(1) command.
 223 .sp
 224 .LP
 225 If \fBnfsd\fR is killed with \fBSIGTERM\fR, it will not be restarted by the
 226 service management facility. Instead, \fBnfsd\fR can be restarted by other
 227 signals, such as \fBSIGINT\fR.