Debian Codegraph @

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