Debian Codegraph @

upstream/debian-trixie/man5/nfs.conf.5

raw
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 host ,
166 .BR scope ,
167 .BR port ,
168 .BR grace-time ,
169 .BR lease-time ,
170 .BR udp ,
171 .BR tcp ,
172 .BR vers3 ,
173 .BR vers4 ,
174 .BR vers4.0 ,
175 .BR vers4.1 ,
176 .BR vers4.2 ,
177 .BR rdma ,
178
179 Version and protocol values are Boolean values as described above,
180 and are also used by
181 .BR rpc.mountd .
182 Threads and the two times are integers.
183 .B port
184 and
185 .B rdma
186 are service names or numbers. See
187 .BR rpc.nfsd (8)
188 for details.
189
190 .TP
191 .B mountd
192 Recognized values:
193 .BR manage-gids ,
194 .BR descriptors ,
195 .BR port ,
196 .BR threads ,
197 .BR reverse-lookup ,
198 .BR cache-use-ipaddr ,
199 .BR ttl ,
200 .BR state-directory-path ,
201 .BR ha-callout .
202
203 These, together with the protocol and version values in the
204 .B [nfsd]
205 section, are used to configure mountd. See
206 .BR rpc.mountd (8)
207 for details.
208
209 Note that setting
210 .B "\[dq]debug = auth\[dq]"
211 for
212 .B mountd
213 is equivalent to providing the
214 .B \-\-log\-auth
215 option.
216
217 The
218 .B state-directory-path
219 value in the
220 .B [mountd]
221 section is also used by
222 .BR exportfs (8).
223
224 .TP
225 .B statd
226 Recognized values:
227 .BR port ,
228 .BR outgoing-port ,
229 .BR name ,
230 .BR state-directory-path ,
231 .BR ha-callout .
232
233 See
234 .BR rpc.statd (8)
235 for details.
236
237 .TP
238 .B lockd
239 Recognized values:
240 .B port
241 and
242 .BR udp-port .
243
244 See
245 .BR rpc.statd (8)
246 for details.
247
248 .TP
249 .B sm-notify
250 Recognized values:
251 .BR retry-time ,
252 .BR outgoing-port ", and"
253 .BR outgoing-addr .
254
255 See
256 .BR sm-notify (8)
257 for details.
258
259 .TP
260 .B gssd
261 Recognized values:
262 .BR verbosity ,
263 .BR rpc-verbosity ,
264 .BR use-memcache ,
265 .BR use-machine-creds ,
266 .BR use-gss-proxy ,
267 .BR avoid-dns ,
268 .BR limit-to-legacy-enctypes ,
269 .BR context-timeout ,
270 .BR rpc-timeout ,
271 .BR keytab-file ,
272 .BR cred-cache-directory ,
273 .BR preferred-realm ,
274 .BR set-home .
275
276 See
277 .BR rpc.gssd (8)
278 for details.
279
280 .TP
281 .B svcgssd
282 Recognized values:
283 .BR principal .
284
285 See
286 .BR rpc.svcgssd (8)
287 for details.
288
289 .TP
290 .B exportfs
291 Only
292 .B debug=
293 is recognized.
294
295 .TP
296 .B nfsrahead
297 Recognized values:
298 .BR nfs ,
299 .BR nfsv4 ,
300 .BR default .
301
302 See
303 .BR nfsrahead (5)
304 for deatils.
305
306 .SH FILES
307 .I /usr/etc/nfs.conf
308 .br
309 .I /usr/etc/nfs.conf.d/*.conf
310 .br
311 .I /etc/nfs.conf
312 .br
313 .I /etc/nfs.conf.d/*.conf
314 .br
315 .IP
316 Various configuration files read in order. Later settings override
317 earlier settings.
318 .SH SEE ALSO
319 .BR rpc.nfsd (8),
320 .BR rpc.mountd (8),
321 .BR nfsmount.conf (5).