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

NAME

6       ganesha-config - NFS Ganesha Configuration File
7

SYNOPSIS

9       /etc/ganesha/ganesha.conf
10
11

DESCRIPTION

13       NFS-Ganesha obtains configuration data from the configuration file:
14          /etc/ganesha/ganesha.conf
15
16       The configuration file consists of following parts:
17
18   Comments
19       Empty lines and lines starting with '#' are comments.:
20
21          # This whole line is a comment
22          Protocol = TCP; # The rest of this line is a comment
23
24   Blocks
25       Related  options are grouped together into "blocks".  A block is a name
26       followed by parameters enclosed between "{" and "}".  A block can  con‐
27       tain other sub blocks as well.:
28
29          EXPORT
30          {
31              Export_ID = 1;
32              FSAL {
33                  Name = VFS:
34              }
35          }
36
37       NOTE:  FSAL is a sub block.  Refer to BLOCKS section for list of blocks
38       and options.
39
40   Options
41       Configuration options can be of following types.
42
43       1. Numeric. Numeric options can be defined in octal, decimal, or  hexa‐
44       decimal.  The format follows ANSI C syntax.  eg.:
45
46          mode = 0755;  # This is octal 0755, 493 (decimal)
47
48       Numeric values can also be negated or logical NOT'd.  eg.:
49
50          anonymousuid = -2; # this is a negative
51          mask = ~0xff; # Equivalent to 0xffffff00 (for 32 bit integers)
52
53       2.  Boolean.  Possible values are true, false, yes and no.  1 and 0 are
54       not acceptable.
55
56       3. List. The option can contain a list of possible  applicable  values.
57       Protocols = 3, 4, 9p;
58
59   Including other config files
60       Additional  files can be referenced in a configuration using '%include'
61       and '%url' directives.:
62
63          %include <filename>
64          %url <url, e.g., rados://mypool/mynamespace/myobject>
65
66       The included file is inserted into the configuration text in  place  of
67       the  %include  or  %url line. Sub-inclusions may be to any depth. File‐
68       names and URLs may optionally use '"':
69
70          %include base.conf
71          %include "base.conf"
72          %url rados://mypool/mynamespace/myobject
73          %url "rados://mypool/mynamespace/myobject"
74          %url rados://mypool/myobject
75          %url "rados://mypool/myobject"
76
77       In the case of rados:// URLs, providing a two-component  URL  indicates
78       that the default namespace should be used.
79
80   Reloading Config
81       A  config reload can be triggered by sending the ganesha.nfsd process a
82       SIGHUP.  Not all config options may be changed with reload, those  that
83       can will be documented in the individual sections.
84
85       In  general,  currently  dynamic config is supported for EXPORT and LOG
86       options.
87

BLOCKS

89       NFS-Ganesha supports the following blocks:
90
91   EXPORT {}
92       Along with its configuration options, the EXPORT  block  supports  FSAL
93       and  CLIENT  sub-blocks. See ganesha-export-config(8) for usage of this
94       block and its sub-blocks.
95
96   EXPORT_DEFAULTS {}
97       Refer to ganesha-export-config(8) for usage
98
99   MDCACHE {}
100       Refer to ganesha-cache-config(8) for usage
101
102   NFS_CORE_PARAM {}
103       Refer to ganesha-core-config(8) for usage
104
105   NFS_IP_NAME {}
106       Refer to ganesha-core-config(8) for usage
107
108   NFS_KRB5 {}
109       Refer to ganesha-core-config(8) for usage
110
111   NFSv4 {}
112       Refer to ganesha-core-config(8) for usage
113
114   CEPH {}
115       Refer to ganesha-ceph-config(8) for usage
116
117   9P {}
118       Refer to ganesha-9p-config(8) for usage
119
120   GLUSTER {}
121       Refer to ganesha-gluster-config(8) for usage
122
123   GPFS {}
124       Refer to ganesha-gpfs-config(8) for usage
125
126   LOG {}
127       Refer to ganesha-log-config(8) for usage
128
129       1.**LOG { FACILITY {} }** 2.**LOG { FORMAT {} }**
130
131   PROXY_V4 {}
132       Refer to ganesha-proxy-config(8) for usage
133
134   PROXY_V3 {}
135       Refer to ganesha-proxy-v3-config(8) for usage
136
137   RGW {}
138       Refer to ganesha-rgw-config(8) for usage
139
140   VFS {}
141       Refer to ganesha-vfs-config(8) for usage
142
143   XFS {}
144       Refer to ganesha-xfs-config(8) for usage
145

EXAMPLE

147       Along with "ganesha.conf", for each installed  FSAL,  a  sample  config
148       file is added at:
149       /etc/ganesha
150
151

SEE ALSO

153       ganesha-log-config(8) ganesha-rgw-config(8) ganesha-vfs-config(8) gane‐
154       sha-lustre-config(8) ganesha-xfs-config(8) ganesha-gpfs-config(8) gane‐
155       sha-gluster-config(8)    ganesha-9p-config(8)   ganesha-proxy-config(8)
156       ganesha-proxy-v3-config(8)   ganesha-ceph-config(8)   ganesha-core-con‐
157       fig(8) ganesha-export-config(8)
158
159
160
161
162                                 Jan 28, 2023                GANESHA-CONFIG(8)
Impressum