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/man4/nfs.4.man.txt
+++ new/usr/src/man/man4/nfs.4.man.txt
1 1 NFS(4) File Formats and Configurations NFS(4)
2 2
3 3 NAME
4 4 nfs - NFS configuration properties
5 5
6 6 DESCRIPTION
7 7 The behavior of the nfsd(1M), nfsmapid(1M), lockd(1M), and mountd(1M)
8 8 daemons and mount_nfs(1M) command is controlled by property values that
9 9 are stored in the Service Management Facility, smf(5). The sharectl(1M)
10 10 command should be used to query or change values for these properties.
11 11
12 12 Changes made to nfs property values on the nfsd, lockd, mountd, or
13 13 mount_nfs command line override the values set using sharectl(1M).
14 14
15 15 The following list describes the properties:
16 16
17 17 client_versmin=num
18 18 client_versmax=num
19 19 The NFS client only uses NFS versions in the range specified by
20 20 these properties. Valid values of versions are: 2, 3, and 4.
21 21 Default minimum version is 2, while default maximum is 4.
22 22
23 23 You can override this range on a per-mount basis by using the -o
24 24 vers= option to mount_nfs(1M).
25 25
26 26 server_versmin=num
27 27 server_versmax=num
28 28 The NFS server only uses NFS versions in the range specified by
29 29 these properties. Valid values of versions are: 2, 3, and 4.
30 30 Default minimum version is 2, while the default maximum version
31 31 is 4.
32 32
33 33 server_delegation=on|off
34 34 By default the NFS server provides delegations to clients. The
35 35 user can turn off delegations for all exported filesystems by
36 36 setting this variable to off. This variable only applies to NFS
37 37 Version 4.
38 38
39 39 nfsmapid_domain=[string]
40 40 By default, the nfsmapid uses the DNS domain of the system. This
41 41 setting overrides the default. This domain is used for
42 42 identifying user and group attribute strings in the NFS Version 4
43 43 protocol. Clients and servers must match with this domain for
44 44 operation to proceed normally. This variable only applies to NFS
45 45 Version 4. See Setting nfsmapid_domain below for further
46 46 details.
47 47
48 48 max_connections=num
49 49 Sets the maximum number of concurrent, connection-oriented
50 50 connections. The default is -1 (unlimited). Equivalent to the
51 51 -c option in nfsd.
52 52
53 53 listen_backlog=num
54 54 Set connection queue length for the NFS over a connection-
55 55 oriented transport. The default value is 32, meaning 32 entries
56 56 in the queue. Equivalent to the -l option in nfsd.
57 57
58 58 protocol=[all|protocol]
59 59 Start nfsd over the specified protocol only. Equivalent to the
60 60 -p option in nfsd. all is equivalent to -a on the nfsd command
61 61 line. Mutually exlusive of device. For the UDP protocol, only
62 62 version 2 and version 3 service is established. NFS Version 4 is
63 63 not supported for the UDP protocol.
64 64
65 65 device=[devname]
66 66 Start NFS daemon for the transport specified by the given device
67 67 only. Equivalent to the -t option in nfsd. Mutually exclusive
68 68 of protocol.
69 69
70 70 servers=num
71 71 Maximum number of concurrent NFS requests. Equivalent to last
72 72 numeric argument on the nfsd command line. The default is 1024.
73 73
74 74 lockd_listen_backlog=num
75 75 Set connection queue length for lockd over a connection-oriented
76 76 transport. The default and minimum value is 32.
77 77
78 78 lockd_servers=num
79 79 Maximum number of concurrent lockd requests. The default is 256.
80 80
81 81 lockd_retransmit_timeout=num
82 82 Retransmit timeout, in seconds, before lockd retries. The
83 83 default is 5.
84 84
85 85 grace_period=num
86 86 Grace period, in seconds, that all clients (both NLM and NFSv4)
87 87 have to reclaim locks after a server reboot. This parameter also
88 88 controls the NFSv4 lease interval. The default is 90.
89 89
90 90 mountd_listen_backlog=num
91 91 Set the connection queue length for mountd over a connection-
92 92 oriented transport. The default value is 64.
93 93
94 94 mountd_max_threads=num
95 95 Maximum number of threads for mountd. The default value is 16.
96 96
97 97 mountd_port=num
98 98 The IP port number on which mountd should listen. The default
99 99 value is 0, which means it should use a default binding.
100 100
101 101 statd_port=num
102 102 The IP port number on which statd should listen. The default
103 103 value is 0, which means it should use a default binding.
104 104
105 105 Setting nfsmapid_domain
106 106 As described above, the setting for nfsmapid_domain overrides the domain
107 107 used by nfsmapid(1M) for building and comparing outbound and inbound
108 108 attribute strings, respectively. This setting overrides any other
109 109 mechanism for setting the NFSv4 domain. In the absence of a
110 110 nfsmapid_domain setting, the nfsmapid(1M) daemon determines the NFSv4
111 111 domain as follows:
112 112
113 113 o If a properly configured /etc/resolv.conf (see resolv.conf(4))
114 114 exists, nfsmapid queries specified nameserver(s) for the domain.
115 115
116 116 o If a properly configured /etc/resolv.conf (see resolv.conf(4))
117 117 exists, but the queried nameserver does not have a proper record of
118 118 the domain name, nfsmapid attempts to obtain the domain name through
119 119 the BIND interface (see resolver(3RESOLV)).
120 120
121 121 o If no /etc/resolv.conf exists, nfsmapid falls back on using the
122 122 configured domain name (see domainname(1M)), which is returned with
123 123 the leading domain suffix removed. For example, for
124 124 widgets.sales.acme.com, sales.acme.com is returned.
125 125
126 126 o If /etc/resolv.conf does not exist, no domain name has been
127 127 configured (or no /etc/defaultdomain exists), nfsmapid falls back on
128 128 obtaining the domain name from the host name, if the host name
129 129 contains a fully qualified domain name (FQDN).
130 130
131 131 If a domainname is still not obtained following all of the preceding
132 132 steps, nfsmapid will have no domain configured. This results in the
133 133 following behavior:
134 134
135 135 o Outbound "owner" and "owner_group" attribute strings are encoded as
136 136 literal id's. For example, the UID 12345 is encoded as 12345.
137 137
138 138 o nfsmapid ignores the "domain" portion of the inbound attribute string
139 139 and performs name service lookups only for the user or group. If the
140 140 user/group exists in the local system name service databases, then
141 141 the proper uid/gid will be mapped even when no domain has been
|
↓ open down ↓ |
141 lines elided |
↑ open up ↑ |
142 142 configured.
143 143
144 144 This behavior implies that the same administrative user/group domain
145 145 exists between NFSv4 client and server (that is, the same uid/gid's
146 146 for users/groups on both client and server). In the case of
147 147 overlapping id spaces, the inbound attribute string could potentially
148 148 be mapped to the wrong id. However, this is not functionally
149 149 different from mapping the inbound string to nobody, yet provides
150 150 greater flexibility.
151 151
152 +ZONES
153 + NFS can be served out of a non-global zone. All of the above
154 + documentation applies to an in-zone NFS server. File sharing in zones is
155 + restricted to filesystems a zone completely controls. Some zone brands
156 + (see brands(5)) do not give the zone's root its own filesystem, for
157 + example. Delegated ZFS datasets to a zone are shareable, as well as
158 + lofs-remounted directories. The zone must have sys_nfs privileges; most
159 + brands grant this already.
160 +
152 161 SEE ALSO
153 162 lockd(1M), mount_nfs(1M), mountd(1M), nfsd(1M), nfsmapid(1M),
154 - sharectl(1M), smf(5)
163 + sharectl(1M), brands(5), smf(5), zones(5)
155 164
156 -illumos December 18, 2016 illumos
165 +illumos February 4, 2020 illumos
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX