1GANESHA-CORE-CONFIG(8)            NFS-Ganesha           GANESHA-CORE-CONFIG(8)
2
3
4

NAME

6       ganesha-core-config - NFS Ganesha Core Configuration File
7

SYNOPSIS

9       /etc/ganesha/ganesha.conf
10
11

DESCRIPTION

13       NFS-Ganesha  reads  the  configuration  data from: | /etc/ganesha/gane‐
14       sha.conf
15
16       This file lists NFS related core config options.
17
18   NFS_CORE_PARAM {}
19       Core parameters:
20
21       NFS_Port (uint16, range 0 to UINT16_MAX, default 2049)
22              Port number used by NFS Protocol.
23
24       MNT_Port (uint16, range 0 to UINT16_MAX, default 0)
25              Port number used by MNT Protocol.
26
27       NLM_Port (uint16, range 0 to UINT16_MAX, default 0)
28              Port number used by NLM Protocol.
29
30       Rquota_Port (uint16, range 0 to UINT16_MAX, default 875)
31              Port number used by Rquota Protocol.
32
33       Bind_addr(IPv4 or IPv6 addr, default 0.0.0.0)
34              The address to which to bind for our listening port.
35
36       NFS_Program(uint32, range 1 to INT32_MAX, default 100003)
37              RPC program number for NFS.
38
39       MNT_Program(uint32, range 1 to INT32_MAX, default 100005)
40              RPC program number for MNT.
41
42       NLM_Program(uint32, range 1 to INT32_MAX, default 100021)
43              RPC program number for NLM.
44
45       Drop_IO_Errors(bool, default false)
46              For NFSv3, whether to drop rather than reply to requests  yield‐
47              ing I/O errors. It results in client retry.
48
49       Drop_Inval_Errors(bool, default false)
50              For  NFSv3, whether to drop rather than reply to requests yield‐
51              ing invalid argument errors.  False by default and settable with
52              Drop_Inval_Errors.
53
54       Drop_Delay_Errors(bool, default false)
55              For  NFSv3, whether to drop rather than reply to requests yield‐
56              ing delay errors.  False by default and settable  with  Drop_De‐
57              lay_Errors.
58
59       Plugins_Dir(path, default /usr/lib64/ganesha )
60              Path to the directory containing server specific modules
61
62       Enable_NFS_Stats(bool, default true)
63              Whether  to collect perfomance statistics. By default the perfo‐
64              mance counting is enabled. Enable_NFS_Stats can  be  enabled  or
65              disabled dynamically via ganesha_stats.
66
67       Enable_Fast_Stats(bool, default false)
68              Whether  to use fast stats. If enabled this will skip statistics
69              counters collection for per client and per export.
70
71       Enable_FSAL_Stats(bool, default false)
72              Whether to count and collect FSAL specific  performance  statis‐
73              tics.   Enable_FSAL_Stats can be enabled or disabled dynamically
74              via ganesha_stats
75
76       Enable_FULLV3_Stats(bool, default false)
77              Whether to count and collect "detailed  statistics"  for  NFSv3.
78              Enable_FULLV3_Stats  can  be enabled or disabled dynamically via
79              ganesha_stats.
80
81       Enable_FULLV4_Stats(bool, default false)
82              Whether to count and collect "detailed  statistics"  for  NFSv4.
83              Enable_FULLV4_Stats  can  be enabled or disabled dynamically via
84              ganesha_stats.
85
86       Enable_CLNT_AllOps_Stats(bool, default false)
87              Whether to count and collect statistics for all  NFS  operations
88              requested  by  NFS  clients. Enable_CLNT_AllOps_Stats can be en‐
89              abled or disabled dynamically via ganesha_stats.
90
91       Short_File_Handle(bool, default false)
92              Whether to use short NFS file handle to accommodate  VMware  NFS
93              client.   Enable  this if you have a VMware NFSv3 client. VMware
94              NFSv3 client has a max limit of 56 byte file handles.
95
96       Manage_Gids_Expiration(int64, range 0 to 7*24*60*60, default 30*60)
97              How long the server will trust information  it  got  by  calling
98              getgroups() when "Manage_Gids = TRUE" is used in a export entry.
99
100       heartbeat_freq(uint32, range 0 to 5000 default 1000)
101              Frequency of dbus health heartbeat in ms.
102
103       Enable_NLM(bool, default true)
104              Whether to support the Network Lock Manager protocol.
105
106       Blocked_Lock_Poller_Interval(int64, range 0 to 180, default 10)
107              Polling interval for blocked lock polling thread
108
109       Protocols(enum list, default [3,4,9P])
110
111              Possible values:
112                     3, 4, NFS3, NFS4, V3, V4, NFSv3, NFSv4, 9P
113
114              The  protocols  that  Ganesha  will  listen for.  This is a hard
115              limit, as this list determines which sockets are  opened.   This
116              list can be restricted per export, but cannot be expanded.
117
118       NSM_Use_Caller_Name(bool, default false)
119              Whether  to  use the supplied name rather than the IP address in
120              NSM operations.
121
122       Clustered(bool, default true)
123              Whether this Ganesha is part of a cluster of Ganeshas. Its  ven‐
124              dor specific option.
125
126       fsid_device(bool, default false)
127              Whether to use device major/minor for fsid.
128
129       mount_path_pseudo(bool, default false)
130              Whether  to  use Pseudo (true) or Path (false) for NFS v3 and 9P
131              mounts.
132
133              This option defaults to false for backward  compatibility,  how‐
134              ever,  for  new setups, it's strongly recommended to be set true
135              since it then means the same server path for the mount  is  used
136              for both v3 and v4.x.
137
138       Dbus_Name_Prefix
139              DBus  name prefix. Required if one wants to run multiple ganesha
140              instances on single host. The prefix should be different for ev‐
141              ery  ganesha  instance.  If  this  is set, the dbus name will be
142              <prefix>.org.ganesha.nfsd
143
144       Enable_UDP(bool, default true)
145              Whether to create UDP listeners for NFS, NLM, RQUOTA, and regis‐
146              ter  them  with  portmapper.  Set  to  false,  e.g.,  to  run as
147              non-root.
148
149       Max_Uid_To_Group_Reqs(uint32, range 0 to INT32_MAX, default 0)
150              Maximum number of concurrent uid2grp requests that can  be  made
151              by  ganesha.   In  environments  with  a  slow Directory Service
152              Provider, where users are part of large number  of  groups,  and
153              Manage_Gids  is set to True, uid2grp queries made by ganesha can
154              fail if a large number of them are made in parallel. This option
155              throttles  the number of concurrent uid2grp queries that ganesha
156              makes.
157
158   Parameters controlling TCP DRC behavior:
159       DRC_Disabled(bool, default false)
160              Whether to disable the DRC entirely.
161
162       TCP_Npart(uint32, range 1 to 20, default 1)
163              Number of partitions in the tree for the TCP DRC.
164
165       DRC_TCP_Size(uint32, range 1 to 32767, default 1024)
166              Maximum number of requests in a transport's DRC.
167
168       DRC_TCP_Cachesz(uint32, range 1 to 255, default 127)
169              Number of entries in the O(1) front-end cache to a TCP Duplicate
170              Request Cache.
171
172       DRC_TCP_Hiwat(uint32, range 1 to 256, default 64)
173              High water mark for a TCP connection's DRC at which to start re‐
174              tiring entries if we can.
175
176       DRC_TCP_Recycle_Npart(uint32, range 1 to 20, default 7)
177              Number of partitions in the recycle tree that holds  per-connec‐
178              tion DRCs so they can be used on reconnection (or recycled.)
179
180       DRC_TCP_Recycle_Expire_S(uint32, range 0 to 60*60, default 600)
181              How  long  to wait (in seconds) before freeing the DRC of a dis‐
182              connected client.
183
184       DRC_TCP_Checksum(bool, default true)
185              Whether to use a checksum to match requests as well as the XID
186
187   Parameters controlling UDP DRC behavior:
188       DRC_UDP_Npart(uint32, range 1 to 100, default 7)
189              Number of partitions in the tree for the UDP DRC.
190
191       DRC_UDP_Size(uint32, range 512, to 32768, default 32768)
192              Maximum number of requests in the UDP DRC.
193
194       DRC_UDP_Cachesz(uint32, range 1 to 2047, default 599)
195              Number of entries in the O(1) front-end cache to the UDP  Dupli‐
196              cate Request Cache.
197
198       DRC_UDP_Hiwat(uint32, range 1 to 32768, default 16384)
199              High  water  mark for the UDP DRC at which to start retiring en‐
200              tries if we can
201
202       DRC_UDP_Checksum(bool, default true)
203              Whether to use a checksum to match requests as well as the XID.
204
205   Parameters affecting the relation with TIRPC:
206       RPC_Max_Connections(uint32, range 1 to 10000, default 1024)
207              Maximum number of connections for TIRPC.
208
209       RPC_Idle_Timeout_S(uint32, range 0 to 60*60, default 300)
210              Idle timeout (seconds). Default to 300 seconds.
211
212       MaxRPCSendBufferSize(uint32, range 1 to 1048576*9, default 1048576)
213              Size of RPC send buffer.
214
215       MaxRPCRecvBufferSize(uint32, range 1 to 1048576*9, default 1048576)
216              Size of RPC receive buffer.
217
218       RPC_Ioq_ThrdMax(uint32, range 1 to 1024*128 default 200)
219              TIRPC ioq max simultaneous io threads
220
221       RPC_GSS_Npart(uint32, range 1 to 1021, default 13)
222              Partitions in GSS ctx cache table
223
224       RPC_GSS_Max_Ctx(uint32, range 1 to 1048576, default 16384)
225              Max GSS contexts in cache. Default 16k
226
227       RPC_GSS_Max_Gc(uint32, range 1 to 1048576, default 200)
228              Max entries to expire in one idle check
229
230   Parameters for TCP:
231       Enable_TCP_keepalive(bool, default true)
232              Whether tcp sockets should use SO_KEEPALIVE
233
234       TCP_KEEPCNT(UINT32, range 0 to 255, default 0 -> use system defaults)
235              Maximum number of TCP probes before dropping the connection
236
237       TCP_KEEPIDLE(UINT32, range 0 to 65535, default  0  ->  use  system  de‐
238       fautls)
239              Idle time before TCP starts to send keepalive probes
240
241       TCP_KEEPINTVL(INT32,  range  0  to  65535,  default 0 -> use system de‐
242       faults)
243              Time between each keepalive probe
244
245   NFS_IP_NAME {}
246       Index_Size(uint32, range 1 to 51, default 17)
247              Configuration for hash table for NFS Name/IP map.
248
249       Expiration_Time(uint32, range 1 to 60*60*24, default 3600)
250              Expiration time for ip-name mappings.
251
252   NFS_KRB5 {}
253       PrincipalName(string, default "nfs")
254
255       KeytabPath(path, default  )
256              Kerberos keytab.
257
258       CCacheDir(path, default /var/run/ganesha )
259              The ganesha credential cache.
260
261       Active_krb5(bool, default false)
262              Whether to activate Kerberos 5. Defaults to  true  (if  Kerberos
263              support is compiled in)
264
265   NFSv4 {}
266       Graceless(bool, default false)
267              Whether to disable the NFSv4 grace period.
268
269       Lease_Lifetime(uint32, range 0 to 120, default 60)
270              The NFSv4 lease lifetime.
271
272       Grace_Period(uint32, range 0 to 180, default 90)
273              The NFS grace period.
274
275       DomainName(string, default localdomain )
276              Domain to use if we aren't using the nfsidmap.
277
278       IdmapConf(path, default /etc/idmapd.conf )
279              Path to the idmap configuration file.
280
281       UseGetpwnam(bool, default false if using idmap, true otherwise)
282              Whether  to  use  local password (PAM, on Linux) rather than nf‐
283              sidmap.
284
285       Allow_Numeric_Owners(bool, default true)
286              Whether to allow bare numeric IDs in NFSv4 owner and group iden‐
287              tifiers.
288
289       Only_Numeric_Owners(bool, default false)
290              Whether  to  ONLY  use bare numeric IDs in NFSv4 owner and group
291              identifiers.
292
293       Delegations(bool, default false)
294              Whether to allow delegations.
295
296       Deleg_Recall_Retry_Delay(uint32_t, range 0 to 10, default 1)
297              Delay after which server will retry a recall in case of failures
298
299       pnfs_mds(bool, default false)
300              Whether this a pNFS MDS server.  For FSAL Gluster,  if  this  is
301              true, set pnfs_mds in gluster block as well.
302
303       pnfs_ds(bool, default false)
304              Whether this a pNFS DS server.
305
306       RecoveryBackend(path, default fs )
307              Use different backend for client info:
308
309              • fs : filesystem
310
311              • fs_ng: filesystem (better resiliency)
312
313              • rados_kv : rados key-value
314
315              • rados_ng : rados key-value (better resiliency)
316
317              • rados_cluster: clustered rados backend (active/active)
318
319       Minor_Versions(enum list, values [0, 1, 2], default [0, 1, 2])
320              List of supported NFSV4 minor version numbers.
321
322       Slot_Table_Size(uint32, range 1 to 1024, default 64)
323              Size of the NFSv4.1 slot table
324
325       Enforce_UTF8_Validation(bool, default false)
326              Set true to enforce valid UTF-8 for path components and compound
327              tags
328
329   RADOS_KV {}
330       ceph_conf(string, no default)
331              Connection to ceph cluster, should be file path for ceph config‐
332              uration.
333
334       userid(path, no default)
335              User ID to ceph cluster.
336
337       namespace(string, default NULL)
338              RADOS Namespace in which to store objects
339
340       pool(string, default nfs-ganesha )
341              Pool for client info.
342
343       grace_oid(string, default grace )
344              Name of the object containing the rados_cluster grace DB
345
346       nodeid(string, default result of gethostname())
347              Unique node identifier within rados_cluster
348
349   RADOS_URLS {}
350       ceph_conf(string, no default)
351              Connection to ceph cluster, should be file path for ceph config‐
352              uration.
353
354       userid(path, no default)
355              User ID to ceph cluster.
356
357       watch_url(url, no default)
358              rados:// URL to watch for notifications of config changes.  When
359              a  notification  is  received, the server will issue a SIGHUP to
360              itself.
361
362
363
364
365                                 Jul 22, 2021           GANESHA-CORE-CONFIG(8)
Impressum