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