1GANESHA-CORE-CONFIG(8) NFS-Ganesha GANESHA-CORE-CONFIG(8)
2
6 ganesha-core-config - NFS Ganesha Core Configuration File
7
9 /etc/ganesha/ganesha.conf
10
13 NFS-Ganesha reads the configuration data from: | /etc/ganesha/gane‐
14 sha.conf
15 This file lists NFS related core config options.
17 NFS_CORE_PARAM {}
19 Core parameters:
20 NFS_Port (uint16, range 0 to UINT16_MAX, default 2049)
22 Port number used by NFS Protocol.
23 MNT_Port (uint16, range 0 to UINT16_MAX, default 0)
25 Port number used by MNT Protocol.
26 NLM_Port (uint16, range 0 to UINT16_MAX, default 0)
28 Port number used by NLM Protocol.
29 Rquota_Port (uint16, range 0 to UINT16_MAX, default 875)
31 Port number used by Rquota Protocol.
32 Bind_addr(IPv4 or IPv6 addr, default 0.0.0.0)
34 The address to which to bind for our listening port.
35 NFS_Program(uint32, range 1 to INT32_MAX, default 100003)
37 RPC program number for NFS.
38 MNT_Program(uint32, range 1 to INT32_MAX, default 100005)
40 RPC program number for MNT.
41 NLM_Program(uint32, range 1 to INT32_MAX, default 100021)
43 RPC program number for NLM.
44 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 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 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
57 Drop_Delay_Errors.
58 Plugins_Dir(path, default /usr/lib64/ganesha )
60 Path to the directory containing server specific modules
61 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 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 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 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 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 Short_File_Handle(bool, default false)
87 Whether to use short NFS file handle to accommodate VMware NFS
88 client. Enable this if you have a VMware NFSv3 client. VMware
89 NFSv3 client has a max limit of 56 byte file handles.
90 Manage_Gids_Expiration(int64, range 0 to 7*24*60*60, default 30*60)
92 How long the server will trust information it got by calling
93 getgroups() when "Manage_Gids = TRUE" is used in a export entry.
94 heartbeat_freq(uint32, range 0 to 5000 default 1000)
96 Frequency of dbus health heartbeat in ms.
97 Enable_NLM(bool, default true)
99 Whether to support the Network Lock Manager protocol.
100 Blocked_Lock_Poller_Interval(int64, range 0 to 180, default 10)
102 Polling interval for blocked lock polling thread
103 Protocols(enum list, default [3,4,9P])
105 Possible values:
107 3, 4, NFS3, NFS4, V3, V4, NFSv3, NFSv4, 9P
108 The protocols that Ganesha will listen for. This is a hard
110 limit, as this list determines which sockets are opened. This
111 list can be restricted per export, but cannot be expanded.
112 NSM_Use_Caller_Name(bool, default false)
114 Whether to use the supplied name rather than the IP address in
115 NSM operations.
116 Clustered(bool, default true)
118 Whether this Ganesha is part of a cluster of Ganeshas. Its ven‐
119 dor specific option.
120 fsid_device(bool, default false)
122 Whether to use device major/minor for fsid.
123 mount_path_pseudo(bool, default false)
125 Whether to use Pseudo (true) or Path (false) for NFS v3 and 9P
126 mounts.
127 This option defaults to false for backward compatibility, how‐
129 ever, for new setups, it's strongly recommended to be set true
130 since it then means the same server path for the mount is used
131 for both v3 and v4.x.
132 Dbus_Name_Prefix
134 DBus name prefix. Required if one wants to run multiple ganesha
135 instances on single host. The prefix should be different for
136 every ganesha instance. If this is set, the dbus name will be
137 <prefix>.org.ganesha.nfsd
138 Enable_UDP(bool, default true)
140 Whether to create UDP listeners for NFS, NLM, RQUOTA, and regis‐
141 ter them with portmapper. Set to false, e.g., to run as
142 non-root.
143 Parameters controlling TCP DRC behavior:
145 DRC_Disabled(bool, default false)
146 Whether to disable the DRC entirely.
147 TCP_Npart(uint32, range 1 to 20, default 1)
149 Number of partitions in the tree for the TCP DRC.
150 DRC_TCP_Size(uint32, range 1 to 32767, default 1024)
152 Maximum number of requests in a transport's DRC.
153 DRC_TCP_Cachesz(uint32, range 1 to 255, default 127)
155 Number of entries in the O(1) front-end cache to a TCP Duplicate
156 Request Cache.
157 DRC_TCP_Hiwat(uint32, range 1 to 256, default 64)
159 High water mark for a TCP connection's DRC at which to start
160 retiring entries if we can.
161 DRC_TCP_Recycle_Npart(uint32, range 1 to 20, default 7)
163 Number of partitions in the recycle tree that holds per-connec‐
164 tion DRCs so they can be used on reconnection (or recycled.)
165 DRC_TCP_Recycle_Expire_S(uint32, range 0 to 60*60, default 600)
167 How long to wait (in seconds) before freeing the DRC of a dis‐
168 connected client.
169 DRC_TCP_Checksum(bool, default true)
171 Whether to use a checksum to match requests as well as the XID
172 Parameters controlling UDP DRC behavior:
174 DRC_UDP_Npart(uint32, range 1 to 100, default 7)
175 Number of partitions in the tree for the UDP DRC.
176 DRC_UDP_Size(uint32, range 512, to 32768, default 32768)
178 Maximum number of requests in the UDP DRC.
179 DRC_UDP_Cachesz(uint32, range 1 to 2047, default 599)
181 Number of entries in the O(1) front-end cache to the UDP Dupli‐
182 cate Request Cache.
183 DRC_UDP_Hiwat(uint32, range 1 to 32768, default 16384)
185 High water mark for the UDP DRC at which to start retiring
186 entries if we can
187 DRC_UDP_Checksum(bool, default true)
189 Whether to use a checksum to match requests as well as the XID.
190 Parameters affecting the relation with TIRPC:
192 RPC_Max_Connections(uint32, range 1 to 10000, default 1024)
193 Maximum number of connections for TIRPC.
194 RPC_Idle_Timeout_S(uint32, range 0 to 60*60, default 300)
196 Idle timeout (seconds). Default to 300 seconds.
197 MaxRPCSendBufferSize(uint32, range 1 to 1048576*9, default 1048576)
199 Size of RPC send buffer.
200 MaxRPCRecvBufferSize(uint32, range 1 to 1048576*9, default 1048576)
202 Size of RPC receive buffer.
203 RPC_Ioq_ThrdMax(uint32, range 1 to 1024*128 default 200)
205 TIRPC ioq max simultaneous io threads
206 RPC_GSS_Npart(uint32, range 1 to 1021, default 13)
208 Partitions in GSS ctx cache table
209 RPC_GSS_Max_Ctx(uint32, range 1 to 1048576, default 16384)
211 Max GSS contexts in cache. Default 16k
212 RPC_GSS_Max_Gc(uint32, range 1 to 1048576, default 200)
214 Max entries to expire in one idle check
215 Parameters for TCP:
217 Enable_TCP_keepalive(bool, default true)
218 Whether tcp sockets should use SO_KEEPALIVE
219 TCP_KEEPCNT(UINT32, range 0 to 255, default 0 -> use system defaults)
221 Maximum number of TCP probes before dropping the connection
222 TCP_KEEPIDLE(UINT32, range 0 to 65535, default 0 -> use system
224 defautls)
225 Idle time before TCP starts to send keepalive probes
226 TCP_KEEPINTVL(INT32, range 0 to 65535, default 0 -> use system
228 defaults)
229 Time between each keepalive probe
230 NFS_IP_NAME {}
232 Index_Size(uint32, range 1 to 51, default 17)
233 Configuration for hash table for NFS Name/IP map.
234 Expiration_Time(uint32, range 1 to 60*60*24, default 3600)
236 Expiration time for ip-name mappings.
237 NFS_KRB5 {}
239 PrincipalName(string, default "nfs")
240 KeytabPath(path, default )
242 Kerberos keytab.
243 CCacheDir(path, default /var/run/ganesha )
245 The ganesha credential cache.
246 Active_krb5(bool, default false)
248 Whether to activate Kerberos 5. Defaults to true (if Kerberos
249 support is compiled in)
250 NFSv4 {}
252 Graceless(bool, default false)
253 Whether to disable the NFSv4 grace period.
254 Lease_Lifetime(uint32, range 0 to 120, default 60)
256 The NFSv4 lease lifetime.
257 Grace_Period(uint32, range 0 to 180, default 90)
259 The NFS grace period.
260 DomainName(string, default localdomain )
262 Domain to use if we aren't using the nfsidmap.
263 IdmapConf(path, default /etc/idmapd.conf )
265 Path to the idmap configuration file.
266 UseGetpwnam(bool, default false if using idmap, true otherwise)
268 Whether to use local password (PAM, on Linux) rather than
269 nfsidmap.
270 Allow_Numeric_Owners(bool, default true)
272 Whether to allow bare numeric IDs in NFSv4 owner and group iden‐
273 tifiers.
274 Only_Numeric_Owners(bool, default false)
276 Whether to ONLY use bare numeric IDs in NFSv4 owner and group
277 identifiers.
278 Delegations(bool, default false)
280 Whether to allow delegations.
281 Deleg_Recall_Retry_Delay(uint32_t, range 0 to 10, default 1)
283 Delay after which server will retry a recall in case of failures
284 pnfs_mds(bool, default false)
286 Whether this a pNFS MDS server. For FSAL Gluster, if this is
287 true, set pnfs_mds in gluster block as well.
288 pnfs_ds(bool, default false)
290 Whether this a pNFS DS server.
291 RecoveryBackend(path, default fs )
293 Use different backend for client info:
294 · fs : filesystem
296 · fs_ng: filesystem (better resiliency)
298 · rados_kv : rados key-value
300 · rados_ng : rados key-value (better resiliency)
302 · rados_cluster: clustered rados backend (active/active)
304 Minor_Versions(enum list, values [0, 1, 2], default [0, 1, 2])
306 List of supported NFSV4 minor version numbers.
307 Slot_Table_Size(uint32, range 1 to 1024, default 64)
309 Size of the NFSv4.1 slot table
310 RADOS_KV {}
312 ceph_conf(string, no default)
313 Connection to ceph cluster, should be file path for ceph config‐
314 uration.
315 userid(path, no default)
317 User ID to ceph cluster.
318 namespace(string, default NULL)
320 RADOS Namespace in which to store objects
321 pool(string, default nfs-ganesha )
323 Pool for client info.
324 grace_oid(string, default grace )
326 Name of the object containing the rados_cluster grace DB
327 nodeid(string, default result of gethostname())
329 Unique node identifier within rados_cluster
330 RADOS_URLS {}
332 ceph_conf(string, no default)
333 Connection to ceph cluster, should be file path for ceph config‐
334 uration.
335 userid(path, no default)
337 User ID to ceph cluster.
338 watch_url(url, no default)
340 rados:// URL to watch for notifications of config changes. When
341 a notification is received, the server will issue a SIGHUP to
342 itself.
343 Nov 26, 2019 GANESHA-CORE-CONFIG(8)