| 1 |
.TH NFS.CONF 5 |
| 2 |
.SH NAME |
| 3 |
nfs.conf \- general configuration for NFS daemons and tools |
| 4 |
.SH SYNOPSIS |
| 5 |
.I /usr/etc/nfs.conf |
| 6 |
.I /usr/etc/nfs.conf.d/ |
| 7 |
.I /etc/nfs.conf |
| 8 |
.I /etc/nfs.conf.d/ |
| 9 |
.SH DESCRIPTION |
| 10 |
.PP |
| 11 |
These files contain site-specific configuration for various NFS daemons |
| 12 |
and other processes. Most configuration can also be passed to |
| 13 |
processes via command line arguments, but it can be more convenient to |
| 14 |
have a central file. In particular, this encourages consistent |
| 15 |
configuration across different processes. |
| 16 |
.PP |
| 17 |
When command line options are provided, they override values set in |
| 18 |
this file. When this file does not specify a particular parameter, |
| 19 |
and no command line option is provided, each tool provides its own |
| 20 |
default values. |
| 21 |
.PP |
| 22 |
The file format supports multiple sections, each of which can contain |
| 23 |
multiple value assignments. A section is introduced by a line |
| 24 |
containing the section name enclosed in square brackets, so |
| 25 |
.RS |
| 26 |
.B [global] |
| 27 |
.RE |
| 28 |
would introduce a section called |
| 29 |
.BR global . |
| 30 |
A value assignment is a single line that has the name of the value, an |
| 31 |
equals sign, and a setting for the value, so |
| 32 |
.RS |
| 33 |
.B threads = 4 |
| 34 |
.RE |
| 35 |
would set the value named |
| 36 |
.B threads |
| 37 |
in the current section to |
| 38 |
.BR 4 . |
| 39 |
Leading and trailing spaces and tab |
| 40 |
are ignored, as are spaces and tabs surrounding the equals sign. |
| 41 |
Single and double quotes surrounding the assigned value are also |
| 42 |
removed. If the resulting string is empty, the whole assignment |
| 43 |
is ignored. |
| 44 |
.PP |
| 45 |
Any line starting with |
| 46 |
.RB \*(lq # \*(rq |
| 47 |
or |
| 48 |
.RB \*(lq ; \*(rq |
| 49 |
is ignored, as is any blank line. |
| 50 |
.PP |
| 51 |
If the assigned value started with a |
| 52 |
.RB \*(lq $ \*(rq |
| 53 |
then the remainder is treated as a name and looked for in the section |
| 54 |
.B [environment] |
| 55 |
or in the processes environment (see |
| 56 |
.BR environ (7)). |
| 57 |
The value found is used for this value. |
| 58 |
.PP |
| 59 |
The value name |
| 60 |
.B include |
| 61 |
is special. If a section contains |
| 62 |
.RS |
| 63 |
.B include = /some/file/name |
| 64 |
.RE |
| 65 |
then the named file will be read, and any value assignments found |
| 66 |
there-in will be added to the current section. If the file contains |
| 67 |
section headers, then new sections will be created just as if the |
| 68 |
included file appeared in place of the |
| 69 |
.B include |
| 70 |
line. |
| 71 |
If the file name starts with a hyphen then that is stripped off |
| 72 |
before the file is opened, and if file doesn't exist no warning is |
| 73 |
given. Normally a non-existent include file generates a warning. |
| 74 |
.PP |
| 75 |
Lookup of section and value names is case-insensitive. |
| 76 |
|
| 77 |
Where a Boolean value is expected, any of |
| 78 |
.BR true , |
| 79 |
.BR t , |
| 80 |
.BR yes , |
| 81 |
.BR y , |
| 82 |
.BR on ", or" |
| 83 |
.B 1 |
| 84 |
can be used for "true", while |
| 85 |
.BR false , |
| 86 |
.BR f , |
| 87 |
.BR no , |
| 88 |
.BR n , |
| 89 |
.BR off ", or" |
| 90 |
.B 0 |
| 91 |
can be used for "false". Comparisons are case-insensitive. |
| 92 |
|
| 93 |
.SH SECTIONS |
| 94 |
The following sections are known to various programs, and can contain |
| 95 |
the given named values. Most sections can also contain a |
| 96 |
.B debug |
| 97 |
value, which can be one or more from the list |
| 98 |
.BR general , |
| 99 |
.BR call , |
| 100 |
.BR auth , |
| 101 |
.BR parse , |
| 102 |
.BR all . |
| 103 |
When a list is given, the members should be comma-separated. |
| 104 |
The values |
| 105 |
.BR 0 |
| 106 |
and |
| 107 |
.BR 1 |
| 108 |
are also accepted, with '0' making no changes to the debug level, and '1' equivalent to specifying 'all'. |
| 109 |
|
| 110 |
.TP |
| 111 |
.B general |
| 112 |
Recognized values: |
| 113 |
.BR pipefs-directory . |
| 114 |
|
| 115 |
See |
| 116 |
.BR blkmapd (8), |
| 117 |
.BR rpc.idmapd (8), |
| 118 |
and |
| 119 |
.BR rpc.gssd (8) |
| 120 |
for details. |
| 121 |
|
| 122 |
.TP |
| 123 |
.B exports |
| 124 |
Recognized values: |
| 125 |
.BR rootdir . |
| 126 |
|
| 127 |
Setting |
| 128 |
.B rootdir |
| 129 |
to a valid path causes the nfs server to act as if the |
| 130 |
supplied path is being prefixed to all the exported entries. For |
| 131 |
instance, if |
| 132 |
.BR rootdir=/my/root , |
| 133 |
and there is an entry in /etc/exports for |
| 134 |
.BR /filesystem , |
| 135 |
then the client will be able to mount the path as |
| 136 |
.BR /filesystem , |
| 137 |
but on the server, this will resolve to the path |
| 138 |
.BR /my/root/filesystem . |
| 139 |
|
| 140 |
.TP |
| 141 |
.B exportd |
| 142 |
Recognized values: |
| 143 |
.BR manage-gids , |
| 144 |
.BR threads , |
| 145 |
.BR cache-use-ipaddr , |
| 146 |
.BR ttl , |
| 147 |
.BR state-directory-path |
| 148 |
|
| 149 |
See |
| 150 |
.BR exportd (8) |
| 151 |
for details. |
| 152 |
|
| 153 |
Note that setting |
| 154 |
.B "\[dq]debug = auth\[dq]" |
| 155 |
for |
| 156 |
.B exportd |
| 157 |
is equivalent to providing the |
| 158 |
.B \-\-log\-auth |
| 159 |
option. |
| 160 |
|
| 161 |
.TP |
| 162 |
.B nfsd |
| 163 |
Recognized values: |
| 164 |
.BR threads , |
| 165 |
.BR min-threads , |
| 166 |
.BR host , |
| 167 |
.BR scope , |
| 168 |
.BR port , |
| 169 |
.BR grace-time , |
| 170 |
.BR lease-time , |
| 171 |
.BR udp , |
| 172 |
.BR tcp , |
| 173 |
.BR vers3 , |
| 174 |
.BR vers4 , |
| 175 |
.BR vers4.0 , |
| 176 |
.BR vers4.1 , |
| 177 |
.BR vers4.2 , |
| 178 |
.BR rdma , |
| 179 |
.BR fh-key-file , |
| 180 |
|
| 181 |
Version and protocol values are Boolean values as described above, |
| 182 |
and are also used by |
| 183 |
.BR rpc.mountd . |
| 184 |
Threads, min-threads and the two times are integers. |
| 185 |
.B port |
| 186 |
and |
| 187 |
.B rdma |
| 188 |
are service names or numbers. See |
| 189 |
.BR rpc.nfsd (8) |
| 190 |
for details. |
| 191 |
|
| 192 |
.TP |
| 193 |
.B mountd |
| 194 |
Recognized values: |
| 195 |
.BR manage-gids , |
| 196 |
.BR descriptors , |
| 197 |
.BR port , |
| 198 |
.BR threads , |
| 199 |
.BR reverse-lookup , |
| 200 |
.BR cache-use-ipaddr , |
| 201 |
.BR ttl , |
| 202 |
.BR state-directory-path , |
| 203 |
.BR ha-callout . |
| 204 |
|
| 205 |
These, together with the protocol and version values in the |
| 206 |
.B [nfsd] |
| 207 |
section, are used to configure mountd. See |
| 208 |
.BR rpc.mountd (8) |
| 209 |
for details. |
| 210 |
|
| 211 |
Note that setting |
| 212 |
.B "\[dq]debug = auth\[dq]" |
| 213 |
for |
| 214 |
.B mountd |
| 215 |
is equivalent to providing the |
| 216 |
.B \-\-log\-auth |
| 217 |
option. |
| 218 |
|
| 219 |
The |
| 220 |
.B state-directory-path |
| 221 |
value in the |
| 222 |
.B [mountd] |
| 223 |
section is also used by |
| 224 |
.BR exportfs (8). |
| 225 |
|
| 226 |
.TP |
| 227 |
.B statd |
| 228 |
Recognized values: |
| 229 |
.BR port , |
| 230 |
.BR outgoing-port , |
| 231 |
.BR name , |
| 232 |
.BR state-directory-path , |
| 233 |
.BR ha-callout . |
| 234 |
|
| 235 |
See |
| 236 |
.BR rpc.statd (8) |
| 237 |
for details. |
| 238 |
|
| 239 |
.TP |
| 240 |
.B lockd |
| 241 |
Recognized values: |
| 242 |
.B port |
| 243 |
and |
| 244 |
.BR udp-port . |
| 245 |
|
| 246 |
See |
| 247 |
.BR rpc.statd (8) |
| 248 |
for details. |
| 249 |
|
| 250 |
.TP |
| 251 |
.B sm-notify |
| 252 |
Recognized values: |
| 253 |
.BR retry-time , |
| 254 |
.BR outgoing-port ", and" |
| 255 |
.BR outgoing-addr . |
| 256 |
|
| 257 |
See |
| 258 |
.BR sm-notify (8) |
| 259 |
for details. |
| 260 |
|
| 261 |
.TP |
| 262 |
.B gssd |
| 263 |
Recognized values: |
| 264 |
.BR verbosity , |
| 265 |
.BR rpc-verbosity , |
| 266 |
.BR use-memcache , |
| 267 |
.BR use-machine-creds , |
| 268 |
.BR use-gss-proxy , |
| 269 |
.BR avoid-dns , |
| 270 |
.BR allowed-enctypes , |
| 271 |
.BR context-timeout , |
| 272 |
.BR rpc-timeout , |
| 273 |
.BR keytab-file , |
| 274 |
.BR cred-cache-directory , |
| 275 |
.BR preferred-realm , |
| 276 |
.BR set-home . |
| 277 |
|
| 278 |
See |
| 279 |
.BR rpc.gssd (8) |
| 280 |
for details. |
| 281 |
|
| 282 |
.TP |
| 283 |
.B svcgssd |
| 284 |
Recognized values: |
| 285 |
.BR principal . |
| 286 |
|
| 287 |
See |
| 288 |
.BR rpc.svcgssd (8) |
| 289 |
for details. |
| 290 |
|
| 291 |
.TP |
| 292 |
.B exportfs |
| 293 |
Only |
| 294 |
.B debug= |
| 295 |
is recognized. |
| 296 |
|
| 297 |
.TP |
| 298 |
.B nfsrahead |
| 299 |
Recognized values: |
| 300 |
.BR nfs , |
| 301 |
.BR nfsv4 , |
| 302 |
.BR default . |
| 303 |
|
| 304 |
See |
| 305 |
.BR nfsrahead (5) |
| 306 |
for details. |
| 307 |
|
| 308 |
.SH FILES |
| 309 |
.I /usr/etc/nfs.conf |
| 310 |
.br |
| 311 |
.I /usr/etc/nfs.conf.d/*.conf |
| 312 |
.br |
| 313 |
.I /etc/nfs.conf |
| 314 |
.br |
| 315 |
.I /etc/nfs.conf.d/*.conf |
| 316 |
.br |
| 317 |
.IP |
| 318 |
Various configuration files read in order. Later settings override |
| 319 |
earlier settings. |
| 320 |
.SH SEE ALSO |
| 321 |
.BR rpc.nfsd (8), |
| 322 |
.BR rpc.mountd (8), |
| 323 |
.BR nfsmount.conf (5). |